GET Impact

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

The API supports the following operations:

• Retrieve all Impact master records

• Retrieve a specific Impact master record by record ID

Retrieve List of Impact Master Records

This endpoint retrieves all Impact 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/Impact

Request Headers

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

Sample Request

The following cURL request sends an HTTP GET request to retrieve all Impact 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 http://localhost:57757 with the appropriate server address when calling the API from another environment.

curl --location 'http://localhost:57757/API/v1/Master/IM/Impact' \
  --request GET \
  --header 'Accept: application/json' \
  --header 'X-Api-Key: <API_KEY>'

Sample Response

The following sample response returns an array of Impact master records. Each object is an Impact in the Incident Management module. Value uniquely identifies the record, Text provides its display name, Active indicates availability, and Sort_Order defines its display or processing sequence.

[
  {
    "Value": 1,
    "Text": "High",
    "Active": true,
    "Sort_Order": 1,
    "Instance": 1,
    "Instance_Text": "Production"
  },
  {
    "Value": 2,
    "Text": "Medium",
    "Active": true,
    "Sort_Order": 2,
    "Instance": 1,
    "Instance_Text": "Production"
  }
]

Note: The sample values are illustrative. Actual values depend on the Impact records and instances configured in the tenant.

Response Fields

The Impact master list exposes the following fields:

Business Use Cases

Expected Result

• Returns HTTP 200 OK.

• Returns all available Impact master records configured for Incident Management.

• Returns details for each Impact, including its identifier, display name, active status, sort order, and instance information.

Sample Expected Result

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

[
  {
    "Value": 1,
    "Text": "High",
    "Active": true,
    "Sort_Order": 1,
    "Instance": 1,
    "Instance_Text": "Production"
  },
  {
    "Value": 2,
    "Text": "Medium",
    "Active": true,
    "Sort_Order": 2,
    "Instance": 1,
    "Instance_Text": "Production"
  }
]

Retrieve Impact Master Record Details

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

Endpoint

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

Path Parameter

Request Headers

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

Sample Request

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

Use this request when an integration or automated process needs the configuration details of a known Impact record. Replace 1 with the record ID of the Impact that you want to retrieve. Replace <API_KEY> with a valid API key. Replace http://localhost:57757 with the appropriate server address when calling the API from another environment.

curl --location 'http://localhost:57757/API/v1/Master/IM/Impact/1' \
  --request GET \
  --header 'Accept: application/json' \
  --header 'X-Api-Key: <API_KEY>'

Sample Response

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

{
  "Value": 1,
  "Text": "High",
  "Active": true,
  "Sort_Order": 1,
  "Instance": 1,
  "Instance_Text": "Production"
}

In this example, the API returns the Impact named High with the following configuration:

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

Note

The Active field shows whether the Impact is available for use. The Sort_Order field describes its configured sequence. The Instance and Instance_Text fields identify the associated application instance.

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

Business Use Cases

Expected Result

• Returns HTTP 200 OK.

• Returns the Impact master record that matches the specified recordId.

• Returns the Impact identifier, display name, active status, sort order, and instance information.

Sample Expected Result

The API successfully retrieves the Impact record with the record ID 1.

{
  "Value": 1,
  "Text": "High",
  "Active": true,
  "Sort_Order": 1,
  "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/Impact' \
--request GET \
--header 'Accept: application/json'

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

404 Not Found

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

The following request attempts to retrieve an Impact record with the record ID 9999:

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

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