v3

latestOpenAPI 3.0.42026-07-312008682.1 MB
Restrictions

Get all restrictions

Returns all restrictions of the default service provided by the enterprise. Note this operation uses Pagination and supports Portfolio Access Tokens.

post/api/connector/v1/restrictions/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.

TimeFilterstring nullable
StartUtcstring nullable
EndUtcstring nullable
RestrictionIdsstring[] nullable

Unique identifiers of the Restriction.

ResourceCategoryIdsstring[] nullable

Unique identifiers of Resource category.

RateIdsstring[] nullable

Unique identifiers of Rate. Returns all restrictions that affect the given rates, i.e. ones without any Restriction Conditions, ones assigned directly to specified rates, ones assigned to Rate group of specified rates, or ones inherited from base rates.`.

ExactRateIdsstring[] nullable

Unique identifiers of Rate. Returns only those restrictions which have matching ExactRateId set in Restriction Condition.

BaseRateIdsstring[] nullable

Unique identifiers of Rate. Returns only those restrictions which have matching BaseRateId set in Restriction Condition.

Origin'User' | 'Integration'
ServiceIdsstring[] required

Unique identifiers of the Service from which the restrictions are requested.

Response

OK

Cursorstring uuid nullable

Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.