PaginateConsolidations

post

https://nedap-harmony.com/api/{workspaceId}/consolidations/v1/paginate

Paginate Consolidations

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

workspaceId

uuid

required

WorkspaceId of the workspace the API call is for.

Query Params

test

boolean

Whether this is a request for 'Test' or 'Live' environment. True refers to the 'Test' environment, no value or False refers to the 'Live' environment.

sortDirection

string

enum

Direction to sort in.

Allowed:

pageSize

int32

Page size of each page.

nextPageToken

string

Next page token.

includeFilterInNextPageToken

boolean

When true (default), the filter is included in the next page token for backward compatibility. Set to false to exclude the filter from the token, reducing token size — clients that do this must re-send the filter in the request body on every page request.

sortField

string

enum

Field to sort by.

Allowed:

Body Params

Filter for the Consolidations.

states

array of objects | null

states

notStates

array of objects | null

notStates

bizTransactionTypes

array of strings | null

bizTransactionTypes

bizTransactionBizTransactions

array of uris | null

bizTransactionBizTransactions

parentIds

array of uris | null

parentIds

location

uri | null

eventTime

object

Responses

401

Unauthorized

403

Forbidden

429

Too Many Requests

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK