GET Classification

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 developers introduce new API versions.

Resource Group

Master

Refers to the Master Data module, which contains reusable reference data such as Classifications, Categories, Priorities, Statuses, and Locations.

Module

IM

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

Resource

Classification

Specifies the Classification master data resource to retrieve. Classifications help organize and classify Incident records.

Accept

application/json

Yes

Requests the API to return the response in JSON format.

X-Api-Key

<API_KEY>

Yes

API key for authentication and authorization.

Value

Integer

1001

Unique value or identifier of the Classification record.

Text

String

"Hardware"

Display name of the Classification.

Active

Boolean

true

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

Parent_Value

Integer or Null

null

Value of the parent Classification, if applicable. A value of null indicates that the Classification does not have a parent Classification.

Instance

Integer or String

1

Identifier of the instance associated with the Classification.

Instance_Text

String

"Production"

Display name of the instance associated with the Classification.

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

Call the GET Classification Incident Master API to retrieve the configured Classification records. Use the returned Classification identifier in the Incident create or update request.

An external system stores Classification mappings for Incident synchronization.

Call the API to retrieve the latest Classification master records and synchronize them with the external system’s mapping table.

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

Retrieve the Classification master list, locate the record with the matching Classification name, and use its Value in the next Incident API request.

A scheduled integration must keep Classification reference data up to date.

Call the API at scheduled intervals and compare the response with the Classification records stored in the consuming system. Add, update, or deactivate mappings as required.

An integration must verify a Classification before submitting an Incident request.

Call the API and confirm that the Classification exists and that its Active value is true. This prevents the integration from submitting an invalid or inactive Classification.

An integration must identify the parent of a Classification.

Use the Parent_Value returned in the response to determine the Classification hierarchy and apply the appropriate parent-child mapping.

You are migrating Incident data from another system.

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

An integration supports many application instances.

Use the Instance and Instance_Text values to associate each Classification with the correct instance during synchronization or Incident processing.

HTTP Method

GET

Retrieves data from the server. This is a rea-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 as new API versions emerge.

Resource Group

Master

Refers to the Master Data module, which contains reusable reference data.

Module

IM

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

Resource

Classification

Specifies the Classification master data resource to retrieve.

Record Identifier

{recordId}

The unique identifier of the Classification record to retrieve. Replace this placeholder with an actual record ID, such as 1001.

Accept

application/json

Yes

Requests the API to return the response in JSON format.

X-Api-Key

<API_KEY>

Yes

Provides the API key to authenticate the caller and grant access to the endpoint.

Value

1001

Uniquely identifies the Classification record.

Text

Hardware

Specifies the display name of the Classification.

Active

true

Indicates that the Classification is active and available for use.

Parent_Value

null

Indicates that this Classification is not linked to a parent Classification.

Instance

1

Identifies the application instance associated with the Classification.

Instance_Text

Production

Provides the display name of the associated application instance.

An external system receives an Incident that contains a Classification record ID.

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

An integration must check a Classification before creating or updating an Incident.

Retrieve the Classification by recordId and verify that the returned record is the intended Classification and is active before including the identifier in the Incident request.

A synchronization process detects that one Classification record has changed.

Retrieve only the affected Classification record and update its mapping in the target system without retrieving the complete Classification master list.

An Incident imported from another system contains an existing Classification mapping.

Retrieve the mapped Classification record to confirm that the stored record ID still corresponds to the expected Classification.

An automated workflow must apply rules based on a Classification’s configuration.

Retrieve the Classification record and check its active status, parent relationship, and instance information before continuing the workflow.

A reporting system contains an Incident Classification ID but not its descriptive name.

Retrieve the Classification record and use its Text value to associate the Classification name with the ID in reports or exported data.

An integration must identify the hierarchy of a known Classification.

Retrieve the Classification record and check Parent_Value to determine whether it belongs to a parent Classification.

A Classification mapping fails during Incident processing.

Retrieve the Classification using the mapped recordId and compare the returned values with the mapping stored in the external system to identify the mismatch.