PUT Resolution Code

The PUT Resolution Code Incident Master API updates an existing Resolution Code master record in the Incident Management (IM) module. Authorized administrators, integrations, and automation tools can change Resolution Code records without using the application UI.

Use Case scenarios	Solution
Rename an Incident Resolution Code	Update the `Text` field for the specified Resolution Code record.
Activate or deactivate a Resolution Code	Set `Active` to `true` or `false`.
Correct Resolution Code master data	Update an existing record to reflect the required business terminology.
Support configuration automation	Allow authorized integrations to update Resolution Code master data programmatically.

Endpoint

PUT /API/v1/Master/IM/ResolutionCode/{recordId}

The endpoint identifies the Resolution Code record by its unique record ID.

Path Parameters

Parameter	Data Type	Required	Description	Example
`recordId`	Integer or string	Yes	Unique identifier of the Resolution Code record to update.	`1001`

The endpoint contains the following fixed path values:

Path Value	Description
`IM`	Module code for Incident Management.
`ResolutionCode`	Master name for the Resolution Code entity.

Before updating an Resolution Code record, system retrieves its update metadata to review required fields, supported fields, payload structure, validation constraints, and applicable endpoint. GET /API/v1/Master/IM/ResolutionCode/metadata?sections=update.

curl --location 'https://<host>/API/v1/Master/IM/ResolutionCode/metadata?sections=update' \
  --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	Yes	Indicates whether the Resolution Code record is active.
`Text`	String	Yes	Display name or text value of the Resolution Code record.

Sample Payload

{
  "Active": true,
  "Text": "Sample Resolution Code Name"
}

Sample Payload Field Details

Field Name	Sample Value	Data Type	Description
Active	`true`	Boolean	Indicates whether the Resolution Code record is active and available for use.
Text	`"Sample Resolution Code Name"`	String	Specifies the display name of the Resolution Code record.

Sample Payload Explanation

Attribute	Value	Explanation
Active Status	`true`	Keeps the Resolution Code record active and available for use.
Resolution Code Name	`"Sample Resolution Code Name"`	Sets the display name of the Resolution Code record.

Sample Request

curl --location 'https://<host>/API/v1/Master/IM/ResolutionCode/1001' \
  --request PUT \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <API_KEY>' \
  --data-raw '{
    "Active": true,
    "Text": "Sample Resolution Code Name"
  }'

The sample request updates the Resolution Code record whose record ID is 1001.

Sample Request Details

Component	Value	Description
HTTP Method	`PUT`	Updates an existing Resolution Code master record.
Endpoint URL	`https://<host>/API/v1/Master/IM/ResolutionCode/1001`	API endpoint used to update the Resolution Code record with record ID `1001`.
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	`ResolutionCode`	Identifies the Resolution Code master entity.
Record ID	`1001`	Unique identifier of the Resolution Code record to update.
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 updated values for the specified Resolution Code record.

Request Body Details

Field Name	Sample Value	Data Type	Required	Description
Active	`true`	Boolean	Yes	Keeps the Resolution Code record active and available for use.
Text	`"Sample Resolution Code Name"`	String	Yes	Updates the display name of the Resolution Code record.

Sample Request Explanation

Attribute	Updated Value	Result
Resolution Code Record ID	`1001`	Identifies the existing Resolution Code record to update.
Active Status	`true`	Keeps the Resolution Code record active.
Resolution Code Name	`"Sample Resolution Code Name"`	Updates the display name of the Resolution Code record.

The request updates the Resolution Code record with ID 1001, changes its display name to Sample Resolution Code Name, and keeps the record active.

Sample Success Response

HTTP 200 OK

{
  "message": "Master record updated successfully.",
  "data": {
    "success": true,
    "recordId": 1001,
    "displayName": "ResolutionCode",
    "moduleCode": "IM",
    "operation": "UPDATE",
    "rowsAffected": 1
  },
  "executionTime": 0.0117173
}

A successful request updates the specified Resolution Code record and returns details about the completed operation.

Sample Success Response Field Details

Field Name	Sample Value	Data Type	Description
message	`"Master record updated successfully."`	String	Confirms the API successfully updated the Resolution Code record.
data	Response object	Object	Contains details about the completed update operation.
data.success	`true`	Boolean	Indicates whether the Resolution Code update operation succeeded.
data.recordId	`1001`	Integer	Identifies the Resolution Code record updated by the request.
data.displayName	`"ResolutionCode"`	String	Identifies the master entity the API updated.
data.moduleCode	`"IM"`	String	Identifies the Incident Management module associated with the updated record.
data.operation	`"UPDATE"`	String	Identifies the operation the API performed on the Resolution Code record.
data.rowsAffected	`1`	Integer	Indicates the number of Resolution Code records updated by the request.
executionTime	`0.0117173`	Number	Indicates the time taken to process the request, in seconds.

Sample Success Response Explanation

Response Attribute	Returned Value	Meaning
HTTP Status	`200 OK`	Indicates that the API successfully processed the request.
Response Message	`"Master record updated successfully."`	Confirms that the Resolution Code update completed successfully.
Operation Status	`true`	Confirms that the Resolution Code update operation succeeded.
Updated Record ID	`1001`	Identifies the Resolution Code record affected by the request.
Master Entity	`"ResolutionCode"`	Confirms that the updated record belongs to the Resolution Code master.
Module	`"IM"`	Confirms that the record belongs to the Incident Management module.
Operation	`"UPDATE"`	Confirms that the API performed an update operation.
Rows Affected	`1`	Confirms that the operation updated one Resolution Code record.
Execution Time	`0.0117173` seconds	Reports the time taken to process the update request.

A successful request returns HTTP 200 OK. The response confirms that the API successfully updated the Resolution Code record with ID 1001 and that the operation affected one record.

Error Responses

400 Bad Request

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request payload.",
  "details": [
    "Text is required."
  ]
}

401 Unauthorized

{
  "status": 401,
  "error": "Unauthorized",
  "message": "Invalid or missing API credentials."
}

403 Forbidden

{
  "status": 403,
  "error": "Forbidden",
  "message": "You do not have permission to perform this action."
}

404 Not Found

{
  "status": 404,
  "error": "Not Found",
  "message": "The specified master record was not found."
}

Documentation Index