POST Pending Reason

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

Endpoint

POST /API/v1/Master/IM/PendingReason

Path Details

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

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

Sample Metadata Request

curl --location 'https://<host>/API/v1/Master/IM/PendingReason/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 Pending Reason record is active.
`Text`	String	Yes	Display name or text value of the Pending Reason record.
`Instance`	String	No	Instance or tenant associated with the Pending Reason record.

Sample Payload

{
  "Active": true,
  "Text": "Sample Pending Reason",
  "Instance": "Info"
}

Sample Payload Field Details

Field Name	Sample Value	Data Type	Description
Active	`true`	Boolean	Indicates whether the Pending Reason record is active and available for use.
Text	`"Sample Pending Reason"`	String	Specifies the display name of the Pending Reason record.
Instance	`"Info"`	String	Specifies the application instance associated with the Pending Reason record.

Sample Payload Explanation

Attribute	Value	Explanation
Active Status	`true`	Creates the Pending Reason as an active record that is available for use.
Pending Reason Name	`"Sample Pending Reason"`	Sets the display name of the new Pending Reason record.
Application Instance	`"Info"`	Associates the Pending Reason record with the specified application instance.

Sample Request

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

Sample Request Details

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

Request Body Details

Field Name	Sample Value	Data Type	Required	Description
Active	`true`	Boolean	Yes	Creates the Pending Reason as an active record that is available for use.
Text	`"Sample Pending Reason"`	String	Yes	Sets the display name of the Pending Reason record.
Instance	`"Info"`	String	Yes	Associates the Pending Reason with the specified application instance.

Sample Request Explanation

Attribute	Submitted Value	Result
HTTP Operation	`POST`	Requests the creation of a new Pending Reason record.
Pending Reason Name	`"Sample Pending Reason"`	Creates the Pending Reason with the specified display name.
Active Status	`true`	Makes the new Pending Reason active and available for use.
Application Instance	`"Info"`	Associates the new Pending Reason with the specified application instance.

The request creates an active Pending Reason named Sample Pending Reason 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": "PendingReason",
    "moduleCode": "IM",
    "operation": "INSERT",
    "rowsAffected": 1
  },
  "executionTime": 0.0553389
}

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

Error Responses

400 Bad Request

Returned when the payload is invalid, a required field is missing, or a supplied value fails validation.

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

401 Unauthorized

Returned when valid API credentials are not provided or have expired.

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

403 Forbidden

Returned when the authenticated client does not have permission to create Pending Reason records.

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

Returned when the Pending Reason master entity does not exist or the endpoint URL is invalid.

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

Documentation Index