Query Clearing Run

Use RSQL query language. Intro here: https://aboullaite.me/rsql/.

Zero-based page index (0..n). Default is 0.

Size of the page to be returned. Max page size allowed is 100, default is 10.

A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.
If sorting direction is not provided, default direction is 'asc'.
Default sorting criteria: 'ident'.

Standard response for successful HTTP requests.

Meta data about the current page and query.

Size of the page as specified by the query.

Page number of total pages available.

Total count of all elements available for the query.

Total count of all pages available for the query.

Ident of this clearing run.
Must not be null.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

Status of this clearing run.
Must not be null.
Must be one of:

PREPARING

RUNNING

DONE

REVERSING

REVERSED

OPOS Case Clearing Definition

OPOS Case Clearing Run results. All numerical values are initialized with 0 and can change during the lifecycle of the clearing run.

Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).

Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).

error response for all http error codes in range 4XX

textual representation of http status code, e.g. 'BAD_REQUEST' for status code 400

message describing the error

timestamp in UTC when the error occurred

URL path where the error occurred

UUID generated by the server to identify the error occurred, should be stated in case of any inquiries

optional list of multiple errors occurred

error response for all http error codes in range 5XX

textual representation of http status code, e.g. 'BAD_REQUEST' for status code 400

message describing the error

timestamp in UTC when the error occurred

URL path where the error occurred

UUID generated by the server to identify the error occurred, should be stated in case of any inquiries

optional list of multiple errors occurred

200Standard response for successful HTTP requests.

4XXerror response for all http error codes in range 4XX

5XXerror response for all http error codes in range 5XX