Documentation is now available for the Fall 2020 Update release!

Create incident categories

This endpoint is used to create categories for the incident entity type.

Leave Feedback

URL

POST https://{api-url}/api/v2/tenants/{tenantId}/incidents/categories

Sample URLs

To create partner-level categories:

https://{api-url}/api/v2/tenants/msp_3/incidents/categories

To create client-level categories:

https://{api-url}/api/v2/tenants/client_4/incidents/categories

Creating categories and sub-categories helps organize identical incidents.This provides clarity and access to granularity of data. For example, a network category could help track how many network-related incidents are triggered in a week.

Parameters

FieldData TypeDescription
namesStringUnique name for category. A category would be identified with this name.
parentCategoryString(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": ["Hardware"]
}

Sample response

[
    {
        "uniqueId": "SCAT-b610567d-2966-496f-8ff2-2e67fef5378b",
        "name": "Hardware",
        "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-08T10:19:46+0000",
        "updatedDate": "2018-02-08T10:19:46+0000"
    }
]

Create a child category

Sample request

{
	"names": ["CPU", "Monitors"],
	"parentCategory": {
		"uniqueId": "SCAT-b610567d-2966-496f-8ff2-2e67fef5378b",
		"name": "Hardware"
	}
}

Sample response

[{
		"uniqueId": "SCAT-b089ae21-e86d-43d4-98d3-b204d03d20e5",
		"name": "CPU",
		"parentCategory": {
			"uniqueId": "SCAT-b610567d-2966-496f-8ff2-2e67fef5378b",
			"name": "Hardware"
		},
		"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-08T10:27:40+0000",
		"updatedDate": "2018-02-08T10:27:40+0000"
	},
	{
		"uniqueId": "SCAT-f5e48aa0-e9a4-4990-9a6e-1c37d4cdb6ac",
		"name": "Monitors",
		"parentCategory": {
			"uniqueId": "SCAT-b610567d-2966-496f-8ff2-2e67fef5378b",
			"name": "Hardware"
		},
		"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-08T10:27:41+0000",
		"updatedDate": "2018-02-08T10:27:41+0000"
	}
]