GET api/Categories/GetCategory?categoryId={categoryId}

Gets category and its category items

Request Information

URI Parameters

Name	Description	Type	Additional information
categoryId		integer	Required

Body Parameters

None.

Response Information

Resource Description

GetCategoryResult

Name	Description	Type	Additional information
Id	Category id	integer	None.
Name	The name	string	None.
Disabled	If true, the category is disabled	boolean	None.
SelectionRequired	If true, you must select at least one category item	boolean	None.
Multiselect	If true, the category allows to choose more category items	boolean	None.
CategoryItems	Structured (as a tree) category items	Collection of CategoryItem	None.
DisableForNewEntity	The category is not available when creating a new entity, f.e. for a new Ticket	boolean	None.
ShowForEndUserAndSmartUser	The category is shown for user	boolean	None.
EndUserAndSmartUserCanEdit	The category can be edited by EU or SU	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Name": "Category",
  "Disabled": false,
  "SelectionRequired": false,
  "Multiselect": false,
  "CategoryItems": [
    {
      "Id": 1,
      "Name": "Category item",
      "Color": "#FF9900",
      "IsFolder": false,
      "Children": null
    }
  ],
  "DisableForNewEntity": false,
  "ShowForEndUserAndSmartUser": false,
  "EndUserAndSmartUserCanEdit": false
}

application/xml, text/xml

Sample:

<GetCategoryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <CategoryItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures">
    <d2p1:CategoryItem>
      <d2p1:Children i:nil="true" />
      <d2p1:Color>#FF9900</d2p1:Color>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsFolder>false</d2p1:IsFolder>
      <d2p1:Name>Category item</d2p1:Name>
    </d2p1:CategoryItem>
  </CategoryItems>
  <DisableForNewEntity>false</DisableForNewEntity>
  <Disabled>false</Disabled>
  <EndUserAndSmartUserCanEdit>false</EndUserAndSmartUserCanEdit>
  <Id>1</Id>
  <Multiselect>false</Multiselect>
  <Name>Category</Name>
  <SelectionRequired>false</SelectionRequired>
  <ShowForEndUserAndSmartUser>false</ShowForEndUserAndSmartUser>
</GetCategoryResult>