POST Urgency

The POST Urgency Incident Master API creates a new Urgency master record in the Incident Management (IM) module. Authorized administrators, integrations, and automation tools can create Urgency records without using the application UI.

Endpoint

POST /API/v1/Master/IM/Urgency

Path Details

Path Value	Description
`IM`	Module code for Incident Management.
`Urgency`	Master entity in which the API creates the new record.

Note: Before creating an Urgency record, system retrieves its metadata to review required fields, supported fields, payload structure, constraints, and applicable endpoints. GET /API/v1/Master/IM/Urgency/metadata?sections=create.

Sample Metadata Request

curl --location 'https://<host>/API/v1/Master/IM/Urgency/metadata?sections=create' \
  --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	No	Indicates whether the Urgency record is active.
`Text`	String	Yes	Display name or text value of the Urgency record.
`Is_Default`	Boolean	No	Indicates whether the Urgency is the default value.
`Sort_Order`	Integer	No	Defines the display or processing order of the Urgency record.
`Instance`	String	No	Instance or tenant associated with the Urgency record.

Sample Payload

{
  "Active": true,
  "Text": "Sample Urgency Name",
  "Is_Default": false,
  "Sort_Order": 0,
  "Instance": "Info"
}

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.
Is_Default	`false`	Boolean	Indicates whether the Urgency acts as the default Urgency value.
Sort_Order	`0`	Integer	Specifies the display or processing order of the Urgency record.
Instance	`"Info"`	String	Specifies the application instance associated with the Urgency record.

Sample Payload Explanation

Attribute	Value	Explanation
Active Status	`true`	Creates the Urgency as an active record that is available for use.
Urgency Name	`"Sample Urgency Name"`	Sets the display name of the new Urgency record.
Default Status	`false`	Creates the Urgency as a non-default Urgency value.
Sort Order	`0`	Sets the display or processing order of the Urgency record to `0`.
Application Instance	`"Info"`	Associates the Urgency record with the specified application instance.

Note: While creating a Default Urgency by setting Is_Default: true, only one default Urgency must exist, setting more than one will return error.

Sample Request

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

Sample Request Details

Component	Value	Description
HTTP Method	`POST`	Creates a new Urgency master record.
Endpoint URL	`https://<host>/API/v1/Master/IM/Urgency`	API endpoint used to create an Urgency record.
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.
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 approve the request.
Request Body	JSON payload	Contains the values used to create the Urgency record.

Request Body Details

Field Name	Sample Value	Data Type	Required	Description
Active	`true`	Boolean	Yes	Creates the Urgency as an active record that is available for use.
Text	`"Sample Urgency Name"`	String	Yes	Sets the display name of the Urgency record.
Is_Default	`false`	Boolean	Yes	Specifies that the Urgency is not the default Urgency value.
Sort_Order	`0`	Integer	Yes	Sets the display or processing order of the Urgency record.
Instance	`"Info"`	String	Yes	Associates the Urgency with the specified application instance.

Sample Request Explanation

Attribute	Submitted Value	Result
HTTP Operation	`POST`	Requests the creation of a new Urgency record.
Urgency Name	`"Sample Urgency Name"`	Creates the Urgency with the specified display name.
Active Status	`true`	Makes the new Urgency active and available for use.
Default Status	`false`	Does not configure the new Urgency as the default Urgency value.
Sort Order	`0`	Assigns the display or processing order `0` to the new Urgency record.
Application Instance	`"Info"`	Associates the new Urgency record with the specified application instance.

The request creates an active Urgency record named Sample Urgency Name, does not set the record as the default Urgency, assigns a sort order of 0, and associates the record with the specified application instance.

Sample Success Response

HTTP 201 Created

{
  "message": "Master record created successfully.",
  "data": {
    "success": true,
    "recordId": 17,
    "displayName": "Urgency",
    "moduleCode": "IM",
    "operation": "INSERT",
    "rowsAffected": 1
  },
  "executionTime": 0.0553389
}

A successful request creates the Urgency record and returns the generated record identifier and execution details.

Sample Success Response Field Details

Field Name	Sample Value	Data Type	Description
message	`"Master record created successfully."`	String	Confirms that the system created the Urgency record successfully.
data	Response object	Object	Contains details about the completed create operation.
data.success	`true`	Boolean	Indicates whether the Urgency create operation succeeded.
data.recordId	`17`	Integer	Unique identifier generated for the newly created Urgency record.
data.displayName	`"Urgency"`	String	Identifies the master entity the system created.
data.moduleCode	`"IM"`	String	Identifies the Incident Management module associated with the new record.
data.operation	`"INSERT"`	String	Indicates that the API performed an insert operation.
data.rowsAffected	`1`	Integer	Indicates the number of Urgency records created by the request.
executionTime	`0.0553389`	Number	Indicates the time taken to process the request, in seconds.

Sample Success Response Explanation

Response Attribute	Returned Value	Meaning
HTTP Status	`201 Created`	Indicates that the API successfully created a new resource.
Response Message	`"Master record created successfully."`	Confirms that the system completed the Urgency creation operation successfully.
Operation Status	`true`	Confirms that the system created the Urgency record successfully.
Generated Record ID	`17`	Identifies the newly created Urgency record.
Master Entity	`"Urgency"`	Confirms that the created record belongs to the Urgency master.
Module	`"IM"`	Confirms that the record belongs to the Incident Management module.
Operation	`"INSERT"`	Confirms that the API performed a create operation.
Rows Affected	`1`	Confirms that the system created one Urgency record.
Execution Time	`0.0553389` seconds	Reports the time taken to process the create request.

A successful request returns HTTP 201 Created. The response confirms that the system created a new Urgency record, the generated record ID is 17, and the request affected one record.

Error Responses

400 Bad Request

{
  "message": "Invalid request payload.",
  "errorCode": 400,
  "details": "One or more fields failed validation."
}

401 Unauthorized

{
  "message": "Unauthorized access.",
  "errorCode": 401,
  "details": "Valid API credentials are required."
}

403 Forbidden

{
  "message": "You do not have permission to create master records.",
  "errorCode": 403,
  "details": "The authenticated user lacks the required privileges to perform this operation."
}

404 Not Found

{
  "message": "Master entity not found.",
  "errorCode": 404,
  "details": "The requested master entity or endpoint does not exist."
}

Documentation Index