API DocsRESTRemote file service

GetRemoteFile

Retrieve a remote file.

GET
/api/v1/remote-files/{remoteFileId}

Path Parameters

remoteFileId
Required
string

curl -X GET "<API_URL>/api/v1/remote-files/string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "remoteFile": {
    "remoteFileId": "string",
    "organizationId": "string",
    "entityId": "string",
    "entityType": "ENTITY_TYPE_UNSPECIFIED",
    "fileName": "string",
    "fileMimeType": "string",
    "fileContentEncoding": "string",
    "storageKey": "string",
    "fileSize": "string",
    "description": "string",
    "videoMetadata": {
      "height": 0,
      "width": 0,
      "durationSeconds": 0.1,
      "timestamp": "2019-08-24T14:15:22Z"
    },
    "imageMetadata": {
      "height": 0,
      "width": 0
    },
    "audioMetadata": {
      "durationSeconds": 0.1,
      "timestamp": "2019-08-24T14:15:22Z"
    },
    "createdByUserId": "string",
    "modifiedByUserId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z"
  }
}

Previous

DeleteRemoteFile DELETE

Next

GetRemoteFileUrl GET