POST Priority Matrix

The POST Priority Matrix Incident Master API creates a new Priority Matrix record in the Incident Management (IM) module. The matrix maps an Impact and Urgency combination to a Priority value. Authorized administrators, integrations, and automation tools can create this mapping without using the application UI.

Endpoint

POST /API/v1/Master/IM/PriorityMatrix

Path Details

Path Value	Description
`IM`	Module code for Incident Management.
`PriorityMatrix`	Master entity used to create the new matrix mapping.

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

Sample Metadata Request

curl --location 'https://<host>/API/v1/Master/IM/PriorityMatrix/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 Matrix record is active.
`Impact`	Integer	Yes	Identifier of the Impact value used in the mapping.
`Urgency`	Integer	Yes	Identifier of the Urgency value used in the mapping.
`Priority`	Integer	Yes	Identifier of the Priority assigned to the Impact and Urgency combination.
`Instance`	String	No	Instance or tenant associated with the Priority Matrix mapping.

Sample Payload

{
  "Active": true,
  "Impact": 0,
  "Urgency": 0,
  "Priority": 0,
  "Instance": "Info"
}

Sample Payload Field Details

Field Name	Sample Value	Data Type	Description
Active	`true`	Boolean	Indicates whether the Priority Matrix mapping is active and available for use.
Impact	`0`	Integer	Specifies the identifier of the Impact record associated with the Priority Matrix mapping.
Urgency	`0`	Integer	Specifies the identifier of the Urgency record associated with the Priority Matrix mapping.
Priority	`0`	Integer	Specifies the identifier of the Priority record assigned to the Impact and Urgency combination.
Instance	`"Info"`	String	Specifies the application instance associated with the Priority Matrix mapping.

Sample Payload Explanation

Attribute	Value	Explanation
Active Status	`true`	Creates the Priority Matrix mapping as an active record that is available for use.
Impact Identifier	`0`	Associates the mapping with the Impact record identified by `0`.
Urgency Identifier	`0`	Associates the mapping with the Urgency record identified by `0`.
Priority Identifier	`0`	Assigns the Priority record identified by `0` to the specified Impact and Urgency combination.
Application Instance	`"Info"`	Associates the Priority Matrix mapping with the specified application instance.

Sample Request

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

Sample Request Details

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

Request Body Details

Field Name	Sample Value	Data Type	Required	Description
Active	`true`	Boolean	Yes	Creates the Priority Matrix mapping as an active record that is available for use.
Impact	`0`	Integer	Yes	Identifies the Impact record associated with the mapping.
Urgency	`0`	Integer	Yes	Identifies the Urgency record associated with the mapping.
Priority	`0`	Integer	Yes	Identifies the Priority assigned to the Impact and Urgency combination.
Instance	`"Info"`	String	Yes	Associates the Priority Matrix mapping with the specified application instance.

Sample Request Explanation

Attribute	Submitted Value	Result
HTTP Operation	`POST`	Requests the creation of a new Priority Matrix mapping.
Active Status	`true`	Makes the new mapping active and available for use.
Impact Identifier	`0`	Associates the new mapping with the specified Impact record.
Urgency Identifier	`0`	Associates the new mapping with the specified Urgency record.
Priority Identifier	`0`	Assigns the specified Priority to the Impact and Urgency combination.
Application Instance	`"Info"`	Associates the new mapping with the specified application instance.

The request creates an active Priority Matrix mapping that assigns the Priority identified by 0 to the combination of the Impact identified by 0 and the Urgency identified by 0, and associates the mapping with the specified application instance.

Sample Success Response

HTTP 201 Created

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

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

Error Responses

400 Bad Request

Returned when a required field is missing, a referenced value is invalid, or the payload does not match the expected schema.

{
  "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