Get Exception

get

https://{hostname}/v1/exceptions/{exceptionId}

Use this API to retrieve the details of a specific exception by its unique identifier. A successful 200 response contains the exception, including its requestor, source, approvers, workflow stage, result, closure details, audit fields and attributes. If no exception exists with the given identifier, the API returns 404.

Responses

401

The request is not authenticated. The Authorization: Bearer <token> header is missing, or the access token is invalid or has expired. Request a new access token and retry.

403

The access token is valid but does not have permission for this operation. The token must include the EXCEPTION or EXCEPTION_READ scope. Ask your administrator to grant the scope to the API client.

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json

*/*

200The exception was retrieved successfully. The response body contains the exception.

400The request is invalid. The exceptionId in the path is not a valid UUID. The response body contains the error details and a traceId.

404No exception exists with the given exceptionId. The response body contains the error details and a traceId.

429Too Many Requests. For more information, see API Rate Limits.

500An unexpected error occurred on the server. Retry the request. If the problem persists, contact OneTrust support and quote the traceId from the response body.