AM/TA/Inv - Remove Asset Correlation ID

A correlation ID associates an external identifier with a platform ID. An asset represents multiple shares, or a lot, of a given security.

Details

/external/v1/asset/{assetId}/correlation-id/remove

Synopsis

Remove Asset Correlation ID

put

This route is used to remove a correlation ID from an existing asset. This correlation ID is an externally provided id that uniquely identifies the asset within the organization making this call. This correlation ID should be in use by the asset involved in this call. This action can be broadcast to all the counterparties that have access to this asset. If the action is to be broadcast, then it will trigger an asynchronous process (the id of which is returned on the success response) which can be monitored using the "Transactions API" endpoints. This endpoint can be called by applications with access to scope "manageReferenceData".

Required scopes

This endpoint requires the following scopes:

• : manageReferenceData

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

assetIdanyRequired

The unique identifier of the asset on the blockchain. This can be a 12 characters platform generated identifier or a correlation id provided by the client.If its length is different from 12 it will be treatead as a correlation id. Particularly relevant for correlation ids, it is recommended that the ID is url encoded if it contains any special characters.

Example: US9QIMAOAS1Q

Query parameters

isAssetCorrelationIdanyOptional

This property is to be used if the value passed in the "assetId" path parameter is a correlation id instead of a platform generated id. If set to "true" then the platform will try to obtain the asset data using the path parameter as a correlation id instead of a platform generated id.

Example: true

assetCorrelationOrgIdanyOptional

This is to be used if the value passed in the "assetId" path parameter is a correlation id instead of a platform generated id. This is the organization identifier linked to that path param. If not provided the organization id will be inferred from the access token. This will be ignored if the value in the path parameter is 12 characters long and the isAssetCorrelationId is either absent or not "true".

Example: US9QI

Body

application/json

correlationIdstring · max: 100Required

Externally provided id that uniquely identifies an entity within an organization.

Example: 123245573717

Responses

200

Successfully removed (or, if the action is being broadcast, triggered the removal of) the correlation id from the asset.

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 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: - IS0009 - AS0001 Please refer to the error code dictionary for the details of each error code.

application/json

409

The following error codes can be returned: - IS0016 - IS0119 - AS0027 - AS0026 - AS0028 Please refer to the error code dictionary for the details of each error code.

application/json

put

/external/v1/asset/{assetId}/correlation-id/remove

HTTPcURLJavaScriptPython

PUT /external/v1/asset/{assetId}/correlation-id/remove HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 204

{
  "extraData": {
    "externalId": "123456789",
    "some": "Custom Property"
  },
  "correlationId": "123245573717",
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  }
}

{
  "processData": {
    "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
    "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
  }
}