AM/TA - Get File Details

A file is a document associated with a subscription.

Details

/external/v1/file

Synopsis

Get File Details

get

This route is used to retrieve the details of a file, given a set of search filters. This endpoint is paginated, up to 25 records can be retrieved per call. This endpoint can be called by applications with access to scope "readSubscription".

Required scopes

This endpoint requires the following scopes:

• : readSubscription

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Query parameters

pageSizenumberOptional

The number of rows being retrieved. Must be a positive integer.

offsetnumberOptional

The offset (i.e. row start index). Must be a positive integer (or 0).

blockNumbernumber · max: 2147483647Optional

The block number where the action was recorded on the ledger.

Example: 350

transactionIdstring · max: 500Optional

The transaction id where the action was recorded on the ledger.

Example: 456789OIJHGFCVGHJKLKJHGF67JHPattern: ^[a-zA-Z0-9-]*$

channelNamestring · max: 20Optional

The name of the channel where the action was recorded on the ledger.

Example: OG123Pattern: ^[a-zA-Z0-9-]*$

fileIdsFilterstringOptional

The comma delimited list of file ids to filter the file history records. Up to 25 records can be provided. Each record should not exceed 12 characters.

Example: USCCWSF01I00,USCCWSF01I01

fileCorrelationIdsFilterstringOptional

The comma delimited list of file correlation ids to filter the file history records. Up to 25 records can be provided. Each record should not exceed 100 characters.

Example: 1234,5678,7890

fileCorrelationOrgIdstring · max: 12Optional

The organization identifier linked to the correlation ids provided in the "fileCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.

generateDownloadLinkbooleanOptional

True if a file download Link is meant to be generated. It is optional

Example: true

Responses

200

Successfully retrieved the file details

application/json

fileIdstringRequired

The unique identified of the file on the ledger.

Example: US9QIFILE1

extensionall ofRequired

The file extension.

Example: pdf

string · enumOptional

The file extension.

Possible values:

namestringOptional

The name of the file

Example: File name

sizenumberRequired

The size of the file

Example: 3856

statusall ofRequired

The status of the file

Example: created

string · enumOptional

The status of the file

Possible values:

typestringRequired

The type of the file

typeLabelstringOptional

The custom type label of the file

infectedStateall ofRequired

The virus scan state of the file

Example: clean

string · enumOptional

The virus scan state of the file

Possible values:

blockNumbernumberRequired

The block number where this file was uploaded.

Example: 350

transactionIdstringRequired

The transaction id where this file was uploaded.

Example: 456789OIJHGFCVGHJKLKJHGF67JH

channelNamestringRequired

The name of the channel where this file was uploaded.

Example: 456789OIJHGFCVGHJKLKJHGF67JH

linkstringOptional

The file download link (if it was generated)

Example: https://some-download-link.com

associatedInvestorIdsstring[]Optional

The list of investor IDs to which this file is linked to

Example: ["INV1234"]

400

The following error codes can be returned: - GN0002 - GN0004 - GN0005 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

get

/external/v1/file

HTTPcURLJavaScriptPython

GET /external/v1/file HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "fileId": "US9QIFILE1",
    "correlationData": [
      {
        "correlationId": "123245573717",
        "origin": "Identifies file on backoffice",
        "organization": {
          "name": "Test Organization",
          "orgId": "TEST1234"
        },
        "extraData": {
          "some": "Custom Property"
        }
      }
    ],
    "extension": "pdf",
    "name": "File name",
    "size": 3856,
    "status": "created",
    "type": "text",
    "typeLabel": "text",
    "infectedState": "clean",
    "blockNumber": 350,
    "transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
    "channelName": "456789OIJHGFCVGHJKLKJHGF67JH",
    "link": "https://some-download-link.com",
    "organization": {
      "orgId": "TEST1234",
      "name": "Test Organization"
    },
    "associatedInvestorIds": [
      "INV1234"
    ]
  }
]