Api Home > ArticleCategory > Get

GET api/V3/ArticleCategory/Get?flatList={flatList} Gets all Knowledge Article Categories.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
flatList

boolean

Default value is False

Body Parameters

None.

Response Information

CategoryTreeObject, which contains a single property: an array of CategoryNodeObject.

Resource Description

CategoryTreeObject
NameDescriptionTypeAdditional information
Categories

Collection of CategoryNodeObject

None.

Response Formats

application/json, text/json

Sample:
{
  "Categories": [
    {
      "label": "sample string 1",
      "nodeId": "fc37d0da-3a31-4d24-adb0-a4333401311e",
      "children": []
    },
    {
      "label": "sample string 1",
      "nodeId": "fc37d0da-3a31-4d24-adb0-a4333401311e",
      "children": []
    }
  ]
}

application/xml, text/xml

Sample:
<CategoryTreeObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.WebConsole.ViewModels">
  <Categories>
    <CategoryNodeObject>
      <children />
      <label>sample string 1</label>
      <nodeId>fc37d0da-3a31-4d24-adb0-a4333401311e</nodeId>
    </CategoryNodeObject>
    <CategoryNodeObject>
      <children />
      <label>sample string 1</label>
      <nodeId>fc37d0da-3a31-4d24-adb0-a4333401311e</nodeId>
    </CategoryNodeObject>
  </Categories>
</CategoryTreeObject>