Create change request categories

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

Leave Feedback

URL

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

Sample URLs

To create partner-level categories:

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

To create client-level categories:

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

Creating categories and sub-categories helps organize identical change requests. This provides clarity and access to granularity of data. For example, a network category could help track how many network-related change requests 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 change request entity type. (A child category is always specific to a parent category.)

Status code

200 OK

Create a parent category

Sample request

{
	"names": ["Internal Support", "Hardware"]
}

Sample response

[{
		"uniqueId": "SCAT-7c602980-b15d-4b50-8088-23d49307fb02",
		"name": "Internal Support",
		"createdBy": {
			"id": "USR0001202764",
			"loginName": "James_Blake",
			"lastName": "Blake",
			"firstName": "James",
			"email": "james.blake@myorganization.com"
		},
		"updatedBy": {
			"id": "USR0001202764",
			"loginName": "James_Blake",
			"lastName": "Blake",
			"firstName": "James",
			"email": "james.blake@myorganization.com"
		},
		"createdDate": "2018-02-09T09:40:05+0000",
		"updatedDate": "2018-02-09T09:40:05+0000"
	},
	{
		"uniqueId": "SCAT-6f6646af-2470-46b7-a166-07f5b47717a8",
		"name": "Hardware",
		"createdBy": {
			"id": "USR0001202764",
			"loginName": "James_Blake",
			"lastName": "Blake",
			"firstName": "James",
			"email": "james.blake@myorganization.com"
		},
		"updatedBy": {
			"id": "USR0001202764",
			"loginName": "James_Blake",
			"lastName": "Blake",
			"firstName": "James",
			"email": "james.blake@myorganization.com"
		},
		"createdDate": "2018-02-09T09:40:06+0000",
		"updatedDate": "2018-02-09T09:40:06+0000"
	}
]

Create child categories

Sample request

{
	"names": ["Antivirus", "Windows Device Policy"],
	"parentCategory": {
		"uniqueId": "SCAT-7c602980-b15d-4b50-8088-23d49307fb02",
		"name": "Internal Support"
	}
}

Sample response

[{
		"uniqueId": "SCAT-1373d851-27d9-4f68-bf9f-0d79177a7eb4",
		"name": "Antivirus",
		"parentCategory": {
			"uniqueId": "SCAT-7c602980-b15d-4b50-8088-23d49307fb02",
			"name": "Internal Support"
		},
		"createdBy": {
			"id": "USR0001202764",
			"loginName": "James_Blake",
			"lastName": "Blake",
			"firstName": "James",
			"email": "james.blake@myorganization.com"
		},
		"updatedBy": {
			"id": "USR0001202764",
			"loginName": "James_Blake",
			"lastName": "Blake",
			"firstName": "James",
			"email": "james.blake@myorganization.com"
		},
		"createdDate": "2018-02-09T09:47:11+0000",
		"updatedDate": "2018-02-09T09:47:11+0000"
	},
	{
		"uniqueId": "SCAT-726d5a73-c00b-41c5-be10-98181aaf1f1a",
		"name": "Windows Device Policy",
		"parentCategory": {
			"uniqueId": "SCAT-7c602980-b15d-4b50-8088-23d49307fb02",
			"name": "Internal Support"
		},
		"createdBy": {
			"id": "USR0001202764",
			"loginName": "James_Blake",
			"lastName": "Blake",
			"firstName": "James",
			"email": "james.blake@myorganization.com"
		},
		"updatedBy": {
			"id": "USR0001202764",
			"loginName": "James_Blake",
			"lastName": "Blake",
			"firstName": "James",
			"email": "james.blake@myorganization.com"
		},
		"createdDate": "2018-02-09T09:47:11+0000",
		"updatedDate": "2018-02-09T09:47:11+0000"
	}
]