v3

latestOpenAPI 3.0.42026-07-312008682.1 MB
Availability blocks

Get all availability blocks

Returns all availability blocks filtered by services, unique identifiers and other filters. Note this operation uses Pagination and supports Portfolio Access Tokens.

post/api/connector/v1/availabilityBlocks/getAll

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

EnterpriseIdsstring[] nullable

Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.

ServiceIdsstring[] nullable

Unique identifiers of the Services to which Availability blocks are assigned.

AvailabilityBlockIdsstring[] nullable

Unique identifiers of the requested Availability blocks.

ExternalIdentifiersstring[] nullable

Identifiers of Availability blocks from external systems.

StatesAvailabilityBlockStateEnum[] nullable

States the availability blocks should be in.

ActivityStatesActivityStates[] nullable

Whether to return only active, only deleted or both records.

Response

OK

Cursorstring uuid nullable

Unique identifier of the last returned availability block. This can be used in Limitation in a subsequent request to fetch the next batch of availability block.