POST Priority

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

Endpoint

POST /API/v1/Master/IM/Priority

Path Details

Path Value	Description
`IM`	Module code for Incident Management.
`Priority`	Master entity used to create the new record.

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

Sample Metadata Request

curl --location 'https://<host>/API/v1/Master/IM/Priority/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 Priority record is active.
`Highlight_Color`	String	No	Hexadecimal color used to highlight the Priority.
`Description`	String	No	Description of the Priority and its intended use.
`Is_Default`	Boolean	No	Indicates whether the Priority is the default value.
`Skip_Days_For_Resolution_SLA`	Integer	No	Number of days excluded from resolution SLA calculations.
`Resolution_SLA_In_Minutes`	Integer	No	Resolution SLA duration in minutes.
`Skip_Days_For_Response_SLA`	Integer	No	Number of days excluded from response SLA calculations.
`Response_SLA_In_Minutes`	Integer	No	Response SLA duration in minutes.
`Text_Display`	String	No	Formatted display name of the Priority.
`Text`	String	Yes	Name or text value of the Priority.
`Sort_Order`	Integer	No	Display or processing order of the Priority record.
`Instance`	String	No	Instance or tenant associated with the Priority record.

Sample Payload

{
  "Active": true,
  "Highlight_Color": "#de7c7c",
  "Description": "Sample Description",
  "Is_Default": false,
  "Skip_Days_For_Resolution_SLA": 0,
  "Resolution_SLA_In_Minutes": 0,
  "Skip_Days_For_Response_SLA": 0,
  "Response_SLA_In_Minutes": 0,
  "Text_Display": "Sample Priority Display Name",
  "Text": "Sample Priority Name",
  "Sort_Order": 0,
  "Instance": "Info"
}

Sample Payload Field Details

Field Name	Sample Value	Data Type	Description
Active	`true`	Boolean	Indicates whether the Priority record is active and available for use.
Highlight_Color	`"#de7c7c"`	String	Specifies the color used to highlight the Priority in the application interface. The sample value uses a hexadecimal color code.
Description	`"Sample Description"`	String	Provides other information about the Priority and its intended use.
Is_Default	`false`	Boolean	Indicates whether the Priority serves as the default Priority.
Skip_Days_For_Resolution_SLA	`0`	Integer	Specifies the number of days excluded from the resolution SLA calculation.
Resolution_SLA_In_Minutes	`0`	Integer	Specifies the target resolution time for the Priority, in minutes.
Skip_Days_For_Response_SLA	`0`	Integer	Specifies the number of days excluded from the response SLA calculation.
Response_SLA_In_Minutes	`0`	Integer	Specifies the target response time for the Priority, in minutes.
Text_Display	`"Sample Priority Display Name"`	String	Specifies the formatted or user-facing display name of the Priority.
Text	`"Sample Priority Name"`	String	Specifies the name or text value of the Priority record.
Sort_Order	`0`	Integer	Specifies the display or processing order of the Priority record.
Instance	`"Info"`	String	Specifies the application instance associated with the Priority record.

Sample Payload Explanation

Attribute	Value	Explanation
Active Status	`true`	Creates the Priority as an active record that is available for use.
Highlight Color	`"#de7c7c"`	Applies the specified hexadecimal color to highlight the Priority in the interface.
Description	`"Sample Description"`	Adds descriptive information about the Priority.
Default Status	`false`	Creates the Priority as a non-default Priority (not the default).
Resolution SLA Skip Days	`0`	Specifies that the system excludes no days from the resolution SLA calculation.
Resolution SLA Duration	`0` minutes	Sets the target resolution time to zero minutes.
Response SLA Skip Days	`0`	Excludes no days from the response SLA calculation.
Response SLA Duration	`0` minutes	Sets the target response time to zero minutes.
Priority Display Name	`"Sample Priority Display Name"`	Sets the formatted or user-facing display name of the Priority.
Priority Name	`"Sample Priority Name"`	Sets the name of the Priority record.
Sort Order	`0`	Sets the display or processing order of the Priority record to `0`.
Application Instance	`"Info"`	Associates the Priority record with the specified application instance.

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

Sample Request

curl --location 'https://<host>/API/v1/Master/IM/Priority' \
  --request POST \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <API_KEY>' \
  --data-raw '{
    "Active": true,
    "Highlight_Color": "#de7c7c",
    "Description": "Sample Description",
    "Is_Default": false,
    "Skip_Days_For_Resolution_SLA": 0,
    "Resolution_SLA_In_Minutes": 0,
    "Skip_Days_For_Response_SLA": 0,
    "Response_SLA_In_Minutes": 0,
    "Text_Display": "Sample Priority Display Name",
    "Text": "Sample Priority Name",
    "Sort_Order": 0,
    "Instance": "Info"
  }'

Sample Request Details

Component	Value	Description
HTTP Method	`POST`	Creates a new Priority master record.
Endpoint URL	`https://<host>/API/v1/Master/IM/Priority`	API endpoint used to create a Priority 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	`Priority`	Identifies the Priority 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 Priority record.

Request Body Details

Field Name	Sample Value	Data Type	Required	Description
Active	`true`	Boolean	Yes	Creates the Priority as an active record that is available for use.
Highlight_Color	`"#de7c7c"`	String	Yes	Sets the highlight color of the Priority by using a hexadecimal color code.
Description	`"Sample Description"`	String	Yes	Sets the description of the Priority and its intended use.
Is_Default	`false`	Boolean	Yes	Specifies that the Priority is not the default Priority.
Skip_Days_For_Resolution_SLA	`0`	Integer	Yes	Sets the number of days excluded from the resolution SLA calculation.
Resolution_SLA_In_Minutes	`0`	Integer	Yes	Sets the target resolution time in minutes.
Skip_Days_For_Response_SLA	`0`	Integer	Yes	Sets the number of days excluded from the response SLA calculation.
Response_SLA_In_Minutes	`0`	Integer	Yes	Sets the target response time in minutes.
Text_Display	`"Sample Priority Display Name"`	String	Yes	Sets the formatted or user-facing display name of the Priority.
Text	`"Sample Priority Name"`	String	Yes	Sets the name or text value of the Priority record.
Sort_Order	`0`	Integer	Yes	Sets the display or processing order of the Priority record.
Instance	`"Info"`	String	Yes	Associates the Priority with the specified application instance.

Sample Request Explanation

Attribute	Submitted Value	Result
HTTP Operation	`POST`	Requests the creation of a new Priority record.
Priority Name	`"Sample Priority Name"`	Creates the Priority with the specified name.
Priority Display Name	`"Sample Priority Display Name"`	Sets the formatted or user-facing display name of the Priority.
Description	`"Sample Description"`	Adds descriptive information to the Priority record.
Active Status	`true`	Makes the new Priority active and available for use.
Default Status	`false`	Does not configure the new Priority as the default Priority.
Highlight Color	`"#de7c7c"`	Applies the specified highlight color to the Priority.
Resolution SLA Skip Days	`0`	Excludes no days from the resolution SLA calculation.
Resolution SLA Duration	`0` minutes	Sets the target resolution time to zero minutes.
Response SLA Skip Days	`0`	Excludes no days from the response SLA calculation.
Response SLA Duration	`0` minutes	Sets the target response time to zero minutes.
Sort Order	`0`	Assigns the display or processing order `0` to the Priority.
Application Instance	`"Info"`	Associates the new Priority with the specified application instance.

The request creates an active Priority named Sample Priority Name, sets its display name and description, assigns its SLA values and highlight color, 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": "Priority",
    "moduleCode": "IM",
    "operation": "INSERT",
    "rowsAffected": 1
  },
  "executionTime": 0.0553389
}

A successful request creates the Priority 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 API created the Priority record successfully.
data	Response object	Object	Contains details about the completed create operation.
data.success	`true`	Boolean	Indicates whether the Priority create operation succeeded.
data.recordId	`17`	Integer	Unique identifier generated for the newly created Priority record.
data.displayName	`"Priority"`	String	Identifies the master entity that the API 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 Priority 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 Priority creation operation completed successfully.
Operation Status	`true`	Confirms that the API created the Priority record successfully.
Generated Record ID	`17`	Identifies the newly created Priority record.
Master Entity	`"Priority"`	Confirms that the created record belongs to the Priority 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 API created one Priority 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 API created a new Priority record, generated record ID 17, and 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