Api Home > Article > GetArticlesRelatedToWorkItem

POST api/V3/Article/GetArticlesRelatedToWorkItem?workItemId={workItemId} Gets a list of knowledge articles related to the specified work item

Request Information

URI Parameters

NameDescriptionTypeAdditional information
workItemId

The work item id

globally unique identifier

Required

Body Parameters

None.

Response Information

Returns a list of html KnowledgeArticle objects

Resource Description

Collection of RelatedWIKA
NameDescriptionTypeAdditional information
ArticleID

integer

None.

Title

string

None.

CategoryName

string

None.

TypeName

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ArticleID": 1,
    "Title": "sample string 2",
    "CategoryName": "sample string 3",
    "TypeName": "sample string 4"
  },
  {
    "ArticleID": 1,
    "Title": "sample string 2",
    "CategoryName": "sample string 3",
    "TypeName": "sample string 4"
  }
]

application/xml, text/xml

Sample:
<ArrayOfRelatedWIKA xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.WebConsole.ViewModels">
  <RelatedWIKA>
    <ArticleID>1</ArticleID>
    <CategoryName>sample string 3</CategoryName>
    <Title>sample string 2</Title>
    <TypeName>sample string 4</TypeName>
  </RelatedWIKA>
  <RelatedWIKA>
    <ArticleID>1</ArticleID>
    <CategoryName>sample string 3</CategoryName>
    <Title>sample string 2</Title>
    <TypeName>sample string 4</TypeName>
  </RelatedWIKA>
</ArrayOfRelatedWIKA>