AM/TA/Inv - Delete Booked ID

Details

/external/v1/id-booking/{bookId}

Synopsis

Delete booked ID

delete

This route is used to delete a previously booked id for a particular entity type. This endpoint can be called by applications with access to scope "manageIdBooking".

Required scopes

This endpoint requires the following scopes:

• : manageIdBooking

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

bookedIdstringRequired

The unique identifier of the booked id being removed

Example: USS3JKS01I00

Query parameters

typestring · enumRequired

The entity type to book a unique identifier.

Possible values:

Responses

204

Successfully removed booked id for a particular entity type.

400

The following error codes can be returned: - GN0002 Please refer to the error code dictionary for the details of each error code.

application/json

401

The following error codes can be returned: - AU0001 - AU0003 Please refer to the error code dictionary for the details of each error code.

application/json

403

The following error codes can be returned: - AU0002 Please refer to the error code dictionary for the details of each error code.

application/json

404

The following error codes can be returned: - GN0008 Please refer to the error code dictionary for the details of each error code.

application/json

409

The following error codes can be returned: Please refer to the error code dictionary for the details of each error code.

application/json

delete

/external/v1/id-booking/{bookedId}

HTTPcURLJavaScriptPython

DELETE /external/v1/id-booking/{bookedId}?type=asset HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content