Documentation Index

Fetch the complete documentation index at: https://help.symphonysummitai.com/llms.txt

Use this file to discover all available pages before exploring further.

GET Urgency

New
  • 7 minute(s) read
Prev Next

The GET Urgency Incident Master API retrieves Urgency master data from the Incident Management (IM) module without using the application UI. The API response represents the Urgency records configured in the system.

The API supports the following operations:

Retrieve List of Urgency Master Records

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

Endpoint

GET /API/v1/Master/IM/Urgency

Component

Value

Description

HTTP Method

GET

Retrieves data from the server. This is a read-only operation and does not create, update, or delete records.

API

API

Stands for Application Programming Interface. It provides a standard way for applications to communicate with the system and exchange data.

Version

v1

Indicates Version 1 of the API. Versioning helps maintain compatibility when the API team introduces new versions.

Resource Group

Master

Refers to the Master Data module, which contains reusable reference data such as Category(s), Priority(s), Status(s), and Urgency(s).

Module

IM

Stands for Incident Management. It identifies that the requested master data belongs to the Incident Management module.

Resource

Urgency

Specifies the Urgency master data resource to retrieve. Urgency indicates how quickly an Incident requires attention.

Request Headers

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

Header

Value

Required

Description

Accept

application/json

Yes

Requests the API to return the response in JSON format.

X-Api-Key

{API_KEY}

Yes

API key used to authenticate and approve the caller.

Sample Request

The following cURL request retrieves all Urgency master records. Replace {host} with the appropriate server address and {API_KEY} with a valid API key.

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

Sample Response

The following response returns an array of Urgency master records. Each object represents one Urgency configured in the Incident Management module.

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

In this example, the API returns the Urgency values High and Medium. Medium set as the default Urgency. The Sort_Order values determine the configured display or processing sequence.

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

Response Fields

Field

Type

Example Value

Description

Value

Integer

1

Unique value or identifier of the Urgency record.

Active

Boolean

true

Indicates whether the Urgency record is active and available for use.

Text

String

"High"

Display name of the Urgency.

Is_Default

Boolean

false

Indicates whether the system uses this record as the default Urgency.

Sort_Order

Integer

1

Defines the configured display or processing order of the Urgency record.

Instance

String or Integer

"Info"

Identifier of the application instance associated with the Urgency. The returned data type depends on system configuration.

Instance_Text

String

"Info"

Display name of the application instance associated with the Urgency.

Business Use Cases

Scenario

Resolution

An integration needs valid Urgency values before creating or updating an Incident.

Retrieve the configured Urgency records and use the required Urgency Value in the dependent Incident request.

An external system stores Urgency mappings for Incident synchronization.

Retrieve the latest Urgency records and synchronize them with the external system's mapping table.

An automated process receives an Urgency name but requires its unique identifier.

Retrieve the Urgency master list, locate the record whose Text matches the supplied name, and use its Value in the next Incident API request.

A scheduled integration must keep Urgency reference data current.

Call the API at scheduled intervals and compare the returned records with the Urgency data stored by the consuming system. Add, update, or deactivate mappings as required.

An integration must verify an Urgency before submitting an Incident request.

Confirm that the Urgency exists and that Active is true before using its identifier.

An integration must identify the default Urgency.

Review Is_Default and select the record whose value is true when the workflow requires the configured default Urgency.

A consuming application must display Urgency values in the configured sequence.

Sort the returned records by Sort_Order before displaying or processing them.

An integration migrates Incident data from another system.

Retrieve valid Urgency records and map source-system values to the corresponding identifiers before migrating Incident records.

An integration supports many application instances.

Use Instance and Instance_Text to associate each Urgency with the correct application instance.

Expected Result

  • Returns HTTP 200 OK.

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

  • Returns the identifier, active status, display name, default setting, sort order, and instance information for each Urgency.

Sample Expected Result

The API successfully retrieves the Urgency master records configured for Incident Management.

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

Retrieve Urgency Master Record Details

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

Endpoint

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

Component

Value

Description

HTTP Method

GET

Retrieves data from the server. This is a read-only operation and does not create, update, or delete records.

API

API

Stands for Application Programming Interface. It provides a standard way for applications to communicate with the system and exchange data.

Version

v1

Indicates Version 1 of the API.

Resource Group

Master

Refers to the Master Data module.

Module

IM

Identifies the Incident Management module.

Resource

Urgency

Specifies the Urgency master data resource.

Record Identifier

{recordId}

Unique identifier of the Urgency record. Replace the placeholder with an actual record ID, such as 1.

Path Parameter

Parameter

Type

Required

Description

Example

recordId

Integer or string

Yes

Unique identifier of the Urgency master record to retrieve.

1

Request Headers

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

Header

Value

Required

Description

Accept

application/json

Yes

Requests the API to return the response in JSON format.

X-Api-Key

{API_KEY}

Yes

Provides the API key used to authenticate and approve the caller.

Sample Request

The following request retrieves the Urgency master record with record ID 1. Replace 1 with the required record ID, {host} with the appropriate server address, and {API_KEY} with a valid API key.

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

Sample Response

The response returns the Urgency master record whose identifier matches the value specified in the request URL.

{
  "Value": 1,
  "Active": true,
  "Text": "High",
  "Is_Default": false,
  "Sort_Order": 1,
  "Instance": "Info",
  "Instance_Text": "Info"
}

Note: The sample response is illustrative. The actual record-detail response may include other configuration fields.

Response Field Details

Field

Value

Description

Value

1

Uniquely identifies the Urgency record.

Active

true

Indicates that the Urgency is active and available for use.

Text

High

Specifies the display name of the Urgency.

Is_Default

false

Indicates that this record is not configured as the default Urgency.

Sort_Order

1

Specifies the configured display or processing order of the Urgency.

Instance

Info

Identifies the application instance associated with the Urgency.

Instance_Text

Info

Provides the display name of the associated application instance.

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

Business Use Cases

Scenario

Resolution

An external system receives an Incident containing an Urgency identifier.

Retrieve the specific Urgency record to get its name and configuration before processing or synchronizing the Incident.

An integration must check an Urgency before creating or updating an Incident.

Retrieve the Urgency by recordId and confirm that the returned record is the intended Urgency and that Active is true.

A synchronization process detects that one Urgency record has changed.

Retrieve only the affected Urgency record and update its mapping without retrieving the complete master list.

An imported Incident contains an existing Urgency mapping.

Retrieve the mapped Urgency record to confirm that the stored identifier still corresponds to the expected Urgency.

An automated workflow must apply rules based on the default Urgency setting.

Retrieve the Urgency and review Is_Default before continuing the workflow.

A consuming application must place a known Urgency in the correct sequence.

Retrieve the record and use Sort_Order to determine its configured position.

A reporting system contains an Urgency identifier but not its descriptive name.

Retrieve the Urgency and use Text to associate the display name with the identifier in reports or exports.

An Urgency mapping fails during Incident processing.

Retrieve the Urgency by recordId and compare the returned values with the mapping stored in the external system.

An automated workflow must apply instance-specific rules.

Use Instance and Instance_Text to verify that the Urgency belongs to the expected application instance.

Expected Result

  • Returns HTTP 200 OK.

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

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

Sample Expected Result

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

{
  "Value": 1,
  "Active": true,
  "Text": "High",
  "Is_Default": false,
  "Sort_Order": 1,
  "Instance": "Info",
  "Instance_Text": "Info"
}

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/Urgency/' \
  --request GET \
  --header 'Accept: application/json' \

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

404 Not Found

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

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

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

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