URL
POST https://{api-url}/api/v2/tenants/{tenantId}/problems/categories
Sample URLs
To create partner-level categories:
https://{api-url}/api/v2/tenants/msp_3/problems/categories
To create client-level categories:
https://{api-url}/api/v2/tenants/client_4/problems/categories
Creating categories and sub-categories helps organize identical problems. This provides clarity and access to granularity of data. For example, a network category could help track how many network-related problems are triggered in a week.
Parameters
Field | Data Type | Description |
---|---|---|
names | String | Unique name for category. A category would be identified with this name. |
parentCategory | String | (Optional) Create a child category under a parent category. This field is mandatory while creating a subcategory. Use the get categories API to retrieve parent categories of the Problem entity type. (A child category is always specific to a parent category.) |
Status code
200 OK
Create a parent category
Sample request
{
"names": ["Network", "Database"]
}
Sample response
[{
"uniqueId": "SCAT-8d55d25d-b6e1-4609-a001-17c441c02a0a",
"name": "Network",
"createdBy": {
"id": "USR0001202764",
"loginName": "John_Smith",
"lastName": "Smith",
"firstName": "John",
"email": "john.smith@myorganization.com"
},
"updatedBy": {
"id": "USR0001202764",
"loginName": "John_Smith",
"lastName": "Smith",
"firstName": "John",
"email": "john.smith@myorganization.com"
},
"createdDate": "2018-02-09T09:07:53+0000",
"updatedDate": "2018-02-09T09:07:53+0000"
},
{
"uniqueId": "SCAT-c67672dd-3d5a-4fe3-8f76-3d63747263ee",
"name": "Database",
"createdBy": {
"id": "USR0001202764",
"loginName": "John_Smith",
"lastName": "Smith",
"firstName": "John",
"email": "john.smith@myorganization.com"
},
"updatedBy": {
"id": "USR0001202764",
"loginName": "John_Smith",
"lastName": "Smith",
"firstName": "John",
"email": "john.smith@myorganization.com"
},
"createdDate": "2018-02-09T09:07:54+0000",
"updatedDate": "2018-02-09T09:07:54+0000"
}
]
Create child categories
Sample request
{
"names": ["VPN", "Wireless"],
"parentCategory": {
"uniqueId": "SCAT-8d55d25d-b6e1-4609-a001-17c441c02a0a",
"name": "Network"
}
}
Sample response
[{
"uniqueId": "SCAT-3c979305-d092-47b1-bbd8-7a8570d0c3d2",
"name": "VPN",
"parentCategory": {
"uniqueId": "SCAT-8d55d25d-b6e1-4609-a001-17c441c02a0a",
"name": "Network"
},
"createdBy": {
"id": "USR0001202764",
"loginName": "John_Smith",
"lastName": "Smith",
"firstName": "John",
"email": "john.smith@myorganization.com"
},
"updatedBy": {
"id": "USR0001202764",
"loginName": "John_Smith",
"lastName": "Smith",
"firstName": "John",
"email": "john.smith@myorganization.com"
},
"createdDate": "2018-02-09T09:14:13+0000",
"updatedDate": "2018-02-09T09:14:13+0000"
},
{
"uniqueId": "SCAT-1242b7a8-eb31-40d7-b271-1186559384b0",
"name": "Wireless",
"parentCategory": {
"uniqueId": "SCAT-8d55d25d-b6e1-4609-a001-17c441c02a0a",
"name": "Network"
},
"createdBy": {
"id": "USR0001202764",
"loginName": "John_Smith",
"lastName": "Smith",
"firstName": "John",
"email": "john.smith@myorganization.com"
},
"updatedBy": {
"id": "USR0001202764",
"loginName": "John_Smith",
"lastName": "Smith",
"firstName": "John",
"email": "john.smith@myorganization.com"
},
"createdDate": "2018-02-09T09:14:15+0000",
"updatedDate": "2018-02-09T09:14:15+0000"
}
]