AM/TA/Inv - Book Entity ID

Details

/external/v1/id-booking

Synopsis

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

Required scopes

This endpoint requires the following scopes:

• : createIdBooking

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Body

application/json

typeall ofRequired

The entity type to book a unique identifier.

Example: asset

string · enumOptional

The entity type to book a unique identifier.

Possible 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

/external/v1/id-booking

HTTPcURLJavaScriptPython

POST /external/v1/id-booking HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "type": "asset"
}

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