Error handling

When a request to the OpenText Core Software Delivery Platform REST API cannot be completed, the server returns an HTTP status code that indicates the category of the problem, and a JSON body that describes it.

The error object

An error is returned as a JSON object with the following properties:

Property Description

error_code

A code that identifies the kind of error. Use it to handle specific errors in your integration.

description

A description of the error.

description_translated

The description, localized to the language of the request.

correlation_id

An identifier for the request. Provide it when reporting a problem, so that the corresponding server logs can be located.

properties

Additional details about the error, as name-value pairs.

business_error

Indicates whether the error results from a business rule, as opposed to a technical failure.

 
{
    "error_code": "platform.entity_not_found",
    "correlation_id": "a1b2c3d4",
    "description": "Entity was not found.",
    "description_translated": "Entity was not found.",
    "properties": {},
    "business_error": true
}

Errors in bulk operations

When an operation acts on multiple entities and some of them fail, the individual errors are returned in the errors array of the collection response, so that you can identify which entities failed. Each error in the array includes an index property that indicates the position, within the request, of the entity that the error applies to. For details on the collection structure, see Collection representation.

See also