PUT Urgency

The PUT Urgency Incident Master API updates an existing Urgency master record in the Incident Management (IM) module. Authorized administrators, integrations, and automation tools can change Urgency records without using the application UI.

Use Case scenarios	Solution
Rename an Incident Urgency	Update the `Text` field for the specified Urgency record.
Activate or deactivate an Urgency	Set `Active` to `true` or `false`.
Change the display order	Update `Sort_Order` to control the position of the Urgency value.
Support configuration automation	Allow authorized integrations to update Urgency master data programmatically.

Endpoint

PUT /API/v1/Master/IM/Urgency/{recordId}

The endpoint identifies the Urgency record by its unique record ID.

Path Parameters

Parameter	Data Type	Required	Description	Example
`recordId`	Integer or string	Yes	Unique identifier of the Urgency record to update.	`1001`

Note
Before updating a Urgency record, system retrieves its update metadata to review required fields, supported fields, payload structure, validation constraints, and applicable endpoint. GET /API/v1/Master/IM/Urgency/metadata?sections=update.

curl --location 'https://<host>/API/v1/Master/IM/Urgency/metadata?sections=update' \
  --request GET \
  --header 'Accept: application/json' \
  --header 'X-Api-Key: <API_KEY>'

Request Headers

Header	Value	Required	Description
`Accept`	`application/json`	Yes	Specifies the expected response format.
`Content-Type`	`application/json`	Yes	Specifies that the request body is in JSON format.
`X-Api-Key`	`<API_KEY>`	Yes	API key used to authenticate the request.

Request Body Fields

Field	Data Type	Required	Description
`Active`	Boolean	Yes	Indicates whether the Urgency record is active.
`Text`	String	Yes	Display name or text value of the Urgency record.
`Sort_Order`	Integer	Yes	Defines the display or processing order of the Urgency record.

Sample Payload

{
  "Active": true,
  "Text": "Sample Urgency Name",
  "Sort_Order": 0
}

Sample Payload Field Details

Field Name	Sample Value	Data Type	Description
Active	`true`	Boolean	Indicates whether the Urgency record is active and available for use.
Text	`"Sample Urgency Name"`	String	Specifies the display name of the Urgency record.
Sort_Order	`0`	Integer	Specifies the display or processing order of the Urgency record.

Sample Payload Explanation

Attribute	Value	Explanation
Active Status	`true`	Keeps the Urgency record active and available for use.
Urgency Name	`"Sample Urgency Name"`	Sets the display name of the Urgency record.
Sort Order	`0`	Sets the display or processing order of the Urgency record to `0`.

Sample Request

curl --location 'https://<host>/API/v1/Master/IM/Urgency/1001' \
  --request PUT \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <API_KEY>' \
  --data-raw '{
    "Active": true,
    "Text": "Sample Urgency Name",
    "Sort_Order": 0
  }'

Sample Request Details

Component	Value	Description
HTTP Method	`PUT`	Updates an existing Urgency master record.
Endpoint URL	`https://<host>/API/v1/Master/IM/Urgency/1001`	API endpoint used to update the Urgency record with record ID `1001`.
Host	`<host>`	Base URL of the target environment, such as Development, Test, or Production.
API Version	`v1`	Identifies Version 1 of the API.
Resource Group	`Master`	Identifies the Master Data API resource group.
Module	`IM`	Identifies the Incident Management module.
Master Name	`Urgency`	Identifies the Urgency master entity.
Record ID	`1001`	Unique identifier of the Urgency record to update.
Accept Header	`application/json`	Indicates that the client expects the response in JSON format.
Content-Type Header	`application/json`	Indicates that the request body contains JSON data.
X-Api-Key Header	`<API_KEY>`	API key used to authenticate and authorize the request.
Request Body	JSON payload	Contains the updated values for the specified Urgency record.

Request Body Details

Field Name	Sample Value	Data Type	Required	Description
Active	`true`	Boolean	Yes	Keeps the Urgency record active and available for use.
Text	`"Sample Urgency Name"`	String	Yes	Updates the display name of the Urgency record.
Sort_Order	`0`	Integer	Yes	Updates the display or processing order of the Urgency record.

Sample Request Explanation

Attribute	Updated Value	Result
Urgency Record ID	`1001`	Identifies the existing Urgency record to update.
Active Status	`true`	Keeps the Urgency record active.
Urgency Name	`"Sample Urgency Name"`	Updates the display name of the Urgency record.
Sort Order	`0`	Sets the display or processing order of the Urgency record to `0`.

The request updates the Urgency record with ID 1001, changes its display name to Sample Urgency Name, keeps the record active, and sets its sort order to 0.

Sample Success Response

HTTP 200 OK

{
  "message": "Master record updated successfully.",
  "data": {
    "success": true,
    "recordId": 1001,
    "displayName": "Urgency",
    "moduleCode": "IM",
    "operation": "UPDATE",
    "rowsAffected": 1
  },
  "executionTime": 0.0117173
}

Sample Success Response Field Details

Field Name	Sample Value	Data Type	Description
message	`"Master record updated successfully."`	String	Provides a message confirming that the system successfully updated the Urgency record.
data	Response object	Object	Contains details about the completed update operation.
data.success	`true`	Boolean	Indicates whether the Urgency update operation succeeded.
data.recordId	`1001`	Integer	Identifies the Urgency record updated by the request.
data.displayName	`"Urgency"`	String	Identifies the master entity updated.
data.moduleCode	`"IM"`	String	Identifies the Incident Management module associated with the updated record.
data.operation	`"UPDATE"`	String	Identifies the operation performed on the Urgency record.
data.rowsAffected	`1`	Integer	Indicates the number of Urgency records updated by the request.
executionTime	`0.0117173`	Number	Indicates the time taken to process the request, in seconds.

Sample Success Response Explanation

Response Attribute	Returned Value	Meaning
HTTP Status	`200 OK`	Indicates that the API successfully processed the request.
Response Message	`"Master record updated successfully."`	Confirms that the master record update completed successfully.
Operation Status	`true`	Confirms that the Urgency update operation succeeded.
Updated Record ID	`1001`	Identifies the Urgency record affected by the request.
Master Entity	`"Urgency"`	Confirms that the updated record belongs to the Urgency master.
Module	`"IM"`	Confirms that the record belongs to the Incident Management module.
Operation	`"UPDATE"`	Confirms that the API performed an update operation.
Rows Affected	`1`	Confirms that the request updated one Urgency record.
Execution Time	`0.0117173` seconds	Reports the time taken to process the update request.

A successful request returns HTTP 200 OK. The response confirms that the request successfully updated the Urgency record with ID 1001 and that the operation affected one record.

Error Responses

400 Bad Request

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request payload.",
  "details": [
    "Text is required.",
    "Sort_Order must be a valid integer."
  ]
}

401 Unauthorized

{
  "status": 401,
  "error": "Unauthorized",
  "message": "Invalid or missing API credentials."
}

403 Forbidden

{
  "status": 403,
  "error": "Forbidden",
  "message": "You do not have permission to perform this action."
}

404 Not Found

{
  "status": 404,
  "error": "Not Found",
  "message": "The specified master record was not found."
}

Documentation Index