Diagnostics and troubleshooting

This topic describes the information the OpenText Core Software Delivery Platform REST API provides to help you diagnose failed requests, and the server setting that controls how much detail is returned. For the structure of the error object, see Error handling.

In this topic:

Correlation IDs

Every error response includes a correlation_id. This value ties the response you received to the corresponding entry in the server logs. When you report a problem to your administrator or to support, include the correlation ID so that the specific request can be located.

Business errors versus system errors

The business_error flag on the error object indicates whether the error is a business error, meaning the request was rejected because of a business rule or validation, rather than an unexpected system failure. A business error usually means the request should be corrected before retrying, whereas a system error may be transient.

Translated descriptions

In addition to the description, the error object can include a description_translated value, which is the error description in the caller's language. Prefer the translated description when presenting errors to end users.

Exposing full exception detail

By default, error responses do not include a server stack trace. A site parameter, EXPOSE_FULL_EXCEPTION_FOR_REST, controls this behavior. When it is enabled, error responses include a stack_trace field with the full exception detail, which can help during development and troubleshooting.

Note: Exposing full exception detail can reveal internal information and is intended for controlled, non-production diagnosis. For where site parameters are described, see Site parameter metadata.