AM/FA/Inv - Add File Correlation ID

Use a correlation ID to associate external identifiers with platform IDs.

Details

/external/v1/file/{fileId}/correlation-id/add

Synopsis

Add File Correlation ID

put

This route is used to add a correlation ID to an existing file. This correlation ID is an externally provided id that uniquely identifies the file within the organization making this call.

This correlation ID can't be in use by another file. This correlation ID can be broadcast to all the counterparties that have access to this file and that have a relationship with the organization making this call.

If the ID 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

oauth2

Path parameters

fileIdstringRequired

The unique identifier of the file on the blockchain

Example: USS3JKS01I00

Body

application/json

correlationIdstring · max: 100Required

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

Example: 123245573717

broadcastToCounterpartybooleanOptional

This property defines if correlation information will be sent to all counterparties.

Default: falseExample: true

originstring · max: 100Optional

The organization origin system that created this entity correlation id

Example: Backoffice-system-123

transactionDataall ofRequired

This property contains the information regarding who is signing the transaction on the blockchain as well as how it will be signed

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

Responses

200

Successfully added (or, if the action is being broadcast, triggered the addition of) the correlation id to the file.

application/json

400

The following error codes can be returned:

• GN0002

• FL0016

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:

• FL0007

Please refer to the error code dictionary for the details of each error code.

application/json

409

The following error codes can be returned:

• FL0006

• FL0012

Please refer to the error code dictionary for the details of each error code.

application/json

put

HTTPcURLJavaScriptPython

PUT /external/v1/file/{fileId}/correlation-id/add HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 240

{
  "extraData": {
    "externalId": "123456789",
    "some": "Custom Property"
  },
  "correlationId": "123245573717",
  "broadcastToCounterparty": true,
  "origin": "Backoffice-system-123",
  "transactionData": {
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  }
}

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