Service Catalog

Create category

POST https://{tenant}.atomicwork.com/api/v1/workspaces/{workspaceId}/catalogue/categories

Authorization

X-Api-Keyheaderstringrequired

API key authentication.

Headers

X-Workspace-Idheaderstring

Path Parameters

workspaceIdpathintegerrequired

The workspace ID

Query Parameters

category_typequeryenum (string)

The category type

Allowed valuesSERVICE_REQUESTINCIDENTACCESS_MANAGEMENTUNKNOWN

Body

namebodystringrequired

descriptionbodystring

iconbodyobject

properties

orderbodyint

user_segmentsbodyarray of integerrequired

archivedbodyboolean

category_typebodyenum (string)

Allowed valuesSERVICE_REQUESTINCIDENTACCESS_MANAGEMENTUNKNOWN

Response

200

Successful response

cURL

curl -X POST 'https://{tenant}.atomicwork.com/api/v1/workspaces/{workspaceId}/catalogue/categories' \
  -H 'X-Api-Key: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"name": "string", "description": "string", "icon": {"name": "string", "type": "string"}, "order": {}, "user_segments": [0], "archived": true, "category_type": "SERVICE_REQUEST"}'