v3

OpenAPI 3.0.42026-07-312008682.1 MB
Service overbooking limits

Clear service overbooking limits

Deletes service overbooking limits that exactly match the specified conditions. This operation is intended to be used alongside serviceOverbookingLimits/set. The specified conditions must be met exactly. The time interval, however, does not need to correspond to an existing service overbooking limit in the system, instead the API uses a splicing algorithm to work out how to divide up any existing service overbooking limit to meet the specified time interval. Past overbooking limits cannot be cleared outside of OperationalEditableHistoryInterval. Care is needed to specify FirstTimeUnitStartUtc and LastTimeUnitStartUtc in the correct format - see Datetimes. This operation supports Portfolio Access Tokens.

post/api/connector/v1/serviceOverbookingLimits/clear

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.

EnterpriseIdstring uuid nullable

Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise.

ServiceIdstring uuid required

Unique identifier of the Service overbooking limits will be set in.

Response

OK

Unit required