GET Pending Reason

The GET Pending Reason Incident Master API retrieves Pending Reason master data from the Incident Management (IM) module. The API response matches the Pending Reason records displayed in the UI.

The API supports the following operations:

• Retrieve all Pending Reason master records

• Retrieve a specific Pending Reason master record by record ID

Retrieve List of Pending Reason Master Records

This endpoint retrieves all Pending Reason master records configured in the Incident Management module. Administrators, integrations, and automation tools can use the endpoint for configuration review, validation, reporting, and downstream processing.

Endpoint

GET /API/v1/Master/IM/PendingReason

Request Headers

{
  "Accept": "application/json",
  "X-Api-Key": "<API_KEY>"
}

Sample Request

The following cURL request sends an HTTP GET request to retrieve all Pending Reason master records. The request includes the Accept header to specify JSON as the expected response format and the X-Api-Key header to authenticate the caller.

Replace <API_KEY> with a valid API key before sending the request. Replace {host} with the appropriate server address when calling the API from another environment.

curl --location '{host}/API/v1/Master/IM/PendingReason' \
  --request GET \
  --header 'Accept: application/json' \
  --header 'X-Api-Key: <API_KEY>'

Sample Response

The following sample response returns an array of Pending Reason master records. Each object represents one Pending Reason configured in the Incident Management module. Value uniquely identifies the record, Text provides its display name, and Active indicates whether the Pending Reason is available for use. Instance and Instance_Text identify the application instance associated with the record.

[
  {
    "Value": 1001,
    "Text": "Awaiting User Response",
    "Active": true,
    "Instance": 1,
    "Instance_Text": "Production"
  },
  {
    "Value": 1002,
    "Text": "Awaiting Vendor Response",
    "Active": true,
    "Instance": 1,
    "Instance_Text": "Production"
  }
]

Response Fields

The Pending Reason master list exposes the following fields:

Business Use Cases

Expected Result

• Returns HTTP 200 OK.

• Returns all available Pending Reason master records configured for Incident Management.

• Returns details for each Pending Reason, including its identifier, display name, active status, and instance information.

Sample Expected Result

The API successfully retrieves the list of Pending Reason master records configured for Incident Management.

[
  {
    "Value": 1001,
    "Text": "Awaiting User Response",
    "Active": true,
    "Instance": 1,
    "Instance_Text": "Production"
  },
  {
    "Value": 1002,
    "Text": "Awaiting Vendor Response",
    "Active": true,
    "Instance": 1,
    "Instance_Text": "Production"
  }
]

Retrieve Pending Reason Master Record Details

This endpoint retrieves the details of a specific Pending Reason master record by using its unique record ID.

Endpoint

GET /API/v1/Master/IM/PendingReason/{recordId}

Path Parameter

Request Headers

{
  "Accept": "application/json",
  "X-Api-Key": "<API_KEY>"
}

Sample Request

The following request retrieves the Pending Reason master record with the record ID 1001. Supply recordId as a path parameter in the endpoint URL to identify the specific Pending Reason record.

Use this request when an integration or automated process needs the configuration details of a known Pending Reason. Replace 1001 with the record ID that you want to retrieve. Replace <API_KEY> with a valid API key. Replace {host} with the appropriate server address when calling the API from another environment.

curl --location '{host}/API/v1/Master/IM/PendingReason/1001' \
  --request GET \
  --header 'Accept: application/json' \
  --header 'X-Api-Key: <API_KEY>'

Sample Response

The response returns the Pending Reason master record whose Value matches the record ID specified in the request URL.

{
  "Value": 1001,
  "Text": "Awaiting User Response",
  "Active": true,
  "Instance": 1,
  "Instance_Text": "Production"
}

In this example, the API returns the Pending Reason named Awaiting User Response with the following configuration:

An integration can use these values to verify the Pending Reason configuration before using its identifier in another Incident Management API request.

Note

The Active field shows whether the Pending Reason is available for use. The Instance and Instance_Text fields identify the associated application instance. Retrieving a Pending Reason does not place an Incident in a pending state. The endpoint only returns master configuration data.

Use this response when you need the details of a specific Pending Reason, such as verifying its active status or instance association for a known record ID.

Business Use Cases

Expected Result

• Returns HTTP 200 OK.

• Returns the Pending Reason master record that matches the specified recordId.

• Returns the Pending Reason identifier, display name, active status, and instance information.

Sample Expected Result

The API successfully retrieves the Pending Reason record with the record ID 1001.

{
  "Value": 1001,
  "Text": "Awaiting User Response",
  "Active": true,
  "Instance": 1,
  "Instance_Text": "Production"
}

Error Responses

401 Unauthorized

Returned when the request does not include a valid API key or the caller does not have authenticated access.

The following request does not include the required X-Api-Key header:

curl --location '{host}/API/v1/Master/IM/PendingReason' \
--request GET \
--header 'Accept: application/json'

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

404 Not Found

Returned when the requested Pending Reason record ID does not exist or the endpoint path is incorrect.

The following request attempts to retrieve a Pending Reason record with the record ID 9999:

curl --location '{host}/API/v1/Master/IM/PendingReason/9999' \
--request GET \
--header 'Accept: application/json' \
--header 'X-Api-Key: {API_KEY}'

{
  "message": "Record not found",
  "errorCode": 404,
  "details": "The requested Pending Reason record was not found."
}