Documentation is now available for the Fall 2020 Update release!

Update incident category

This endpoint is used to update a category of entity type Incident.

Leave Feedback

URL

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

Sample URLs

To update a category for partners:

https://{api-url}/api/v2/tenants/msp_3/incidents/categories/SCAT-26ee9fcc-2d41-4e2b-a29e-8f758e09e51d

To update a category for clients:

https://{api-url}/api/v2/tenants/client_4/incidents/categories/SCAT-54bc7gfc-3e54-5f6c-e57f-7g877h98f63eg

In this API, the following actions can be performed on a category:

  • Rename a category
  • Assign child categories to a parent category
  • Change the status of a parent category to a child category

A child category cannot be changed to a parent category using this API.

Do the following to change the status:

  1. Log into OpsRamp.
  2. On the left-hand side panel. Select Service Desk and then Categories.
  3. Select entity select Change from the drop-down.
  4. Click on the category name to view the category page.
  5. Click Edit, select category type Parent, and then click Update.
  6. The category is now updated as a parent category.

Parameters

FieldData TypeDescription
nameString(Optional) Category name.
parentCategoryStringParent category details. This field is required while assigning a child category to a parent category.

Status code

200 OK

Sample request

{
	"name": "Version Updates",
	"parentCategory": {
		"uniqueId": "SCAT-8e8ee079-2b38-43c2-b59c-1a0c19e0fdb6",
		"name": "Software"
	}
}

Sample response

{
	"uniqueId": "SCAT-26ee9fcc-2d41-4e2b-a29e-8f758e09e51d",
	"name": "Version Updates",
	"parentCategory": {
		"uniqueId": "SCAT-8e8ee079-2b38-43c2-b59c-1a0c19e0fdb6",
		"name": "Software"
	},
	"createdBy": {
		"id": "USR0000000047",
		"loginName": "John_Smith",
		"lastName": "Smith",
		"firstName": "John",
		"email": "john.smith@myorganization.com",
		"phoneNumber": ""
	},
	"updatedBy": {
		"id": "USR0000000047",
		"loginName": "John_Smith",
		"lastName": "Smith",
		"firstName": "John",
		"email": "john.smith@myorganization.com"
	},
	"createdDate": "2017-12-06T13:25:22+0000",
	"updatedDate": "2017-12-06T13:26:04+0000"
}