All pages
Powered by GitBook
1 of 3

Loading...

Loading...

Loading...

AM/FA/Inv - Delete Booked ID

Details

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

Synopsis

ID Booking

The Booking ID API enables you to reserve an ID for an entity instead of waiting for an ID to be assigned after creation of the entity is completed.

Endpoints

Book Entity ID
Delete Booked ID

AM/FA/Inv - Book Entity ID

Details

/external/v1/id-booking

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".

Authorizations
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.

Example: assetPossible 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
DELETE /external/v1/id-booking/{bookedId}?type=asset HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Book Entity ID

post

This route is used to book a entity id for a particular entity type.

This booked ID can then be used in the corresponding action API afterwards

(e.g. booking a security id and then using it on the /external/v1/security-admin/create-and-launch endpoint

or booking an asset id and then using it on the /external/v1/primary/asset endpoint). This endpoint can be called by applications with access to scope "createIdBooking".

Authorizations
Body
typestring · enumRequired

The entity type to book a unique identifier.

Example: assetPossible values:
Responses
201
Successfully booked entity id for a particular entity type.
application/json
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
409
The following error codes can be returned: Please refer to the error code dictionary for the details of each error code.
application/json
post
POST /external/v1/id-booking HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "type": "asset"
}
{
  "bookedId": "1234567890",
  "type": "asset"
}