POST Closure Code

The POST Closure Code Incident Master API creates a new Closure Code master record in the Incident Management (IM) module. Authorized administrators, integrations, and automation tools can create Closure Code records without using the application UI.

Endpoint

POST /API/v1/Master/IM/ClosureCode

Path Details

Path Value	Description
`IM`	Module code for Incident Management.
`ClosureCode`	Master entity to create the new record.

Note: Before creating Priority Matrix record, system retrieves its metadata to review required fields, supported fields, payload structure, constraints, and applicable endpoints. GET /API/v1/Master/IM/ClosureCode/metadata?sections=create.

Sample Metadata Request

curl --location 'https://<host>/API/v1/Master/IM/ClosureCode/metadata?sections=create' \
  --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	No	Indicates whether the Closure Code record is active.
`Text`	String	Yes	Display name or text value of the Closure Code record.
`Instance`	String	No	Instance or tenant associated with the Closure Code record.
`Is_Default`	Boolean	No	Indicates whether the Closure Code is the default value.

Sample Payload

{
  "Active": true,
  "Text": "Sample Closure Code",
  "Instance": "Info",
  "Is_Default": false
}

Sample Payload Field Details

Field Name	Sample Value	Data Type	Description
Active	`true`	Boolean	Indicates whether the Closure Code record is active and available for use.
Text	`"Sample Closure Code"`	String	Specifies the display name of the Closure Code record.
Instance	`"Info"`	String	Specifies the application instance associated with the Closure Code record.
Is_Default	`false`	Boolean	Indicates whether the Closure Code serves as the default Closure Code.

Sample Payload Explanation

Attribute	Value	Explanation
Active Status	`true`	Creates the Closure Code as an active record that is available for use.
Closure Code Name	`"Sample Closure Code"`	Sets the display name of the new Closure Code record.
Application Instance	`"Info"`	Associates the Closure Code record with the specified application instance.
Default Status	`false`	Creates the Closure Code as a non-default Closure Code.

Note: While creating a Default Closure Code by setting Is_Default: true, only one default Closure Code must exist, setting more than one will return error.

Sample Request

curl --location 'https://<host>/API/v1/Master/IM/ClosureCode' \
  --request POST \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <API_KEY>' \
  --data-raw '{
    "Active": true,
    "Text": "Sample Closure Code",
    "Instance": "Info",
    "Is_Default": false
  }'

Sample Request Details

Component	Value	Description
HTTP Method	`POST`	Creates a new Closure Code master record.
Endpoint URL	`https://<host>/API/v1/Master/IM/ClosureCode`	API endpoint used to create a Closure Code record.
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	`ClosureCode`	Identifies the Closure Code master entity.
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 values used to create the Closure Code record.

Request Body Details

Field Name	Sample Value	Data Type	Required	Description
Active	`true`	Boolean	Yes	Creates the Closure Code as an active record that is available for use.
Text	`"Sample Closure Code"`	String	Yes	Sets the display name of the Closure Code record.
Instance	`"Info"`	String	Yes	Associates the Closure Code with the specified application instance.
Is_Default	`false`	Boolean	Yes	Specifies that the Closure Code is not the default Closure Code.

Sample Request Explanation

Attribute	Submitted Value	Result
HTTP Operation	`POST`	Requests the creation of a new Closure Code record.
Closure Code Name	`"Sample Closure Code"`	Creates the Closure Code with the specified display name.
Active Status	`true`	Makes the new Closure Code active and available for use.
Application Instance	`"Info"`	Associates the new Closure Code with the specified application instance.
Default Status	`false`	Does not configure the new Closure Code as the default Closure Code.

The request creates an active Closure Code named Sample Closure Code, does not set the record as the default Closure Code, and associates the record with the specified application instance.

Sample Success Response

HTTP 201 Created

{
  "message": "Master record created successfully.",
  "data": {
    "success": true,
    "recordId": 17,
    "displayName": "ClosureCode",
    "moduleCode": "IM",
    "operation": "INSERT",
    "rowsAffected": 1
  },
  "executionTime": 0.0553389
}

A successful request creates the Closure Code record and returns the generated record identifier and execution details.

Sample Success Response Field Details

Field Name	Sample Value	Data Type	Description
message	`"Master record created successfully."`	String	Confirms the Closure Code record creation succeeded.
data	Response object	Object	Contains details about the completed create operation.
data.success	`true`	Boolean	Indicates whether the Closure Code create operation succeeded.
data.recordId	`17`	Integer	Unique identifier generated for the newly created Closure Code record.
data.displayName	`"ClosureCode"`	String	Identifies the created master entity.
data.moduleCode	`"IM"`	String	Identifies the Incident Management module associated with the new record.
data.operation	`"INSERT"`	String	Indicates that the API performed an insert operation.
data.rowsAffected	`1`	Integer	Indicates the number of Closure Code records created by the request.
executionTime	`0.0553389`	Number	Indicates the time taken to process the request, in seconds.

Sample Success Response Explanation

Response Attribute	Returned Value	Meaning
HTTP Status	`201 Created`	Indicates that the API successfully created a new resource.
Response Message	`"Master record created successfully."`	Confirms that the Closure Code creation operation completed successfully.
Operation Status	`true`	Confirms the Closure Code record created successfully.
Generated Record ID	`17`	Identifies the newly created Closure Code record.
Master Entity	`"ClosureCode"`	Confirms that the created record belongs to the Closure Code master.
Module	`"IM"`	Confirms that the record belongs to the Incident Management module.
Operation	`"INSERT"`	Confirms that the API performed a create operation.
Rows Affected	`1`	Confirms that the request created one Closure Code record.
Execution Time	`0.0553389` seconds	Reports the time taken to process the create request.

A successful request returns HTTP 201 Created. The response confirms that the API created a new Closure Code record, generated record ID 17, and affected one record.

Error Responses

400 Bad Request

Returned when the payload is invalid, a required field is missing, or a supplied value fails validation.

{
  "message": "Invalid request payload.",
  "errorCode": 400,
  "details": "One or more fields failed validation."
}

401 Unauthorized

Returned when valid API credentials are not provided or have expired.

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

403 Forbidden

Returned when the authenticated client does not have permission to create Closure Code records.

{
  "message": "You do not have permission to create master records.",
  "errorCode": 403,
  "details": "The authenticated user lacks the required privileges to perform this operation."
}

404 Not Found

Returned when the Closure Code master entity does not exist or the endpoint URL is invalid.

{
  "message": "Master entity not found.",
  "errorCode": 404,
  "details": "The requested master entity or endpoint does not exist."
}

Documentation Index