Attachments

Routes for managing attachments

Get Attachment

GET/attachments/:attachmentId

Retrieve details of a specific attachment.

Required attributes

Name
attachmentId
Type
string
Description
The id of the attachment you wish to load

cURL

    curl https://your.platform.url/api/gateway/attachments/8c63ce30-bb74-4910-9c2e-510fb3792d5e \
      -H "Authorization: Bearer {token}"

Sample Response

{
  "id": "8c63ce30-bb74-4910-9c2e-510fb3792d5e",
  "name": "Screenshot 2023-12-05 at 10.54.59.png",
  "fileSize": 101028,
  "type": "image",
  "description": null,
  "isWriteable": true,
  "createdAt": "2024-02-20T14:02:18.000Z",
  "updatedAt": "2024-02-29T09:03:04.000Z",
  "status": "file_available",
  "url": "/attachments/8c63ce30-bb74-4910-9c2e-510fb3792d5e/stream",
  "hash": "a8115cd919b58f593029294cbf3e5440169f566d7634122f0212a7a5401ba74a",
  "presignedKey": null,
  "presignedUrl": null,
  "key": "b9939b65-5efa-49a4-9c1e-b413a0b3da41.png",
  "metadata": {},
  "currentUser": {
    "openSignature": true,
    "signatureAttachmentId": null,
    "signatureId": null,
    "signatureRequired": true,
    "signatureRequestId": "036d195f-027f-4790-a496-a03eac64afac",
    "signatureStatus": null,
    "signatureType": "electronic",
    "attachmentAccessed": true,
    "currentMultiUserSigned": false
  },
  "sigType": "electronic",
  "permissions": {
    "user": {
      "none": [],
      "read": [
        "775922a0-cff8-11ee-8f8c-35cdaa30f76b"
      ],
      "write": [
        "6cef7bac-0ea5-4c3d-9e57-085fc757e021"
      ]
    },
    "group": {
      "none": [],
      "read": [
        "a713c659-cd3d-4bb6-a137-bf56e65c1d3f"
      ],
      "write": []
    },
    "write": {
      "dealManager": true
    },
    "released": false
  },
  "accessLogs": [
    {
      "id": "83bade98-a739-4ad3-ae00-a53f5155090b",
      "userId": "6cef7bac-0ea5-4c3d-9e57-085fc757e021",
      "userName": "Mr test_user",
      "createdAt": "2024-02-20 14:07"
    }
  ],
  "readAccess": [
    "775922a0-cff8-11ee-8f8c-35cdaa30f76b",
    "a713c659-cd3d-4bb6-a137-bf56e65c1d3f"
  ],
  "writeAccess": [
    "6cef7bac-0ea5-4c3d-9e57-085fc757e021"
  ],
  "isDocumentCounteringEnabled": false,
  "directoryId": "367bb9b3-c912-4152-bc32-28e3f5a461d6"
}

Stream Attachment

GET/attachments/:attachmentId/stream

Stream the contents of a specific attachment.

Required attributes

Name
attachmentId
Type
string
Description
The id of the attachment you wish to stream

cURL

    curl https://your.platform.url/api/gateway/attachments/8c63ce30-bb74-4910-9c2e-510fb3792d5e/stream \
      -H "Authorization: Bearer {token}"