AM/FA/Inv - Remove Issuance Close Correlation ID

A correlation ID associates an external identifiers with a platform ID.

Details

/external/v1/issuance-close/{closeId}/correlation-id/remove

Synopsis

Remove Issuance Close Correlation ID

put

This route is used to remove a correlation ID from an existing issuance close. This correlation ID is an externally provided id that uniquely identifies the issuance close within the organization making this call.

This correlation ID should be in use by the issuance close involved in this call.

This action can be broadcast to all the counterparties that have access to this issuance close.

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

Authorizations

Path parameters

closeIdstringRequired

The unique identifier of the issuance close on the ledger

Example: US9QIMAOAS1Q

Body

correlationIdstring · max: 100Required

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

Example: 123245573717

transactionDataall ofRequired

This property contains the transactional data information, i.e. which is the security where we are adding a correlation id to a entity

Example: {"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}

Responses

200

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

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

application/json

409

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

application/json

put

HTTPcURLJavaScriptPython

PUT /external/v1/issuance-close/{closeId}/correlation-id/remove HTTP/1.1
Host: 
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"
  }
}