Search Exceptions

Use this API to retrieve a list of all exceptions or search for exceptions based on the specified criteria. A successful 200 response contains one page of exceptions in content, together with the paging details that are needed to request the next page. If no exception matches the request, the API still returns 200, with an empty content list and a totalElements of 0; it does not return an error.

🗒

Things to Know

  • If the request body is omitted or criteria is not provided, no filter is applied and all exceptions are returned.
  • Use sort in the format field,direction. When sort is not provided, results are sorted by createdDate in descending order.
  • fullText searches the text fields of an exception; it does not search every field.
  • The BETWEEN operator requires both value for the lower bound and toValue for the upper bound.
Query Params
int32
≥ 0
Defaults to 0

The page number to retrieve.

int32
1 to 2000
Defaults to 20

The number of records per page.

string
enum

The sort criteria that dictates the order of the results.

Allowed:
Body Params

The optional criteria used to filter the exceptions that are returned.

criteria
object

The criteria that filter the exceptions that are returned. They combine a free-text search with filters on field values.

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
Missing 2 required scopes
URL
LoadingLoading…
Response
Choose an example:
application/json
*/*