Individual Form

Listing Form Attachments

Changed on

This endpoint allows you to fetch the list of expected attachment files, and will tell you whether the server is in possession of each file or not, and a hash of the file contents. To modify an attachment, you'll need to create a Draft. The property datasetExists indicates whether the attachment is a link to a Dataset instead of an actual file.

get/v1/projects/{projectId}/forms/{xmlFormId}/attachments

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/projects/{projectId}/forms/{xmlFormId}/attachments
  • Auth
    none declared

Path parameters

projectIdnumber required

The numeric ID of the Project

xmlFormIdstring required

The xmlFormId of the Form being referenced.

Response

OK

namestring required

The name of the file as specified in the XForm.

type'image' | 'audio' | 'video' | 'file' required
existsboolean required

True if the server has the file or the Attachment is linked to a Dataset, otherwise false.

blobExistsboolean required

True only when a file has been uploaded for this attachment slot. False when no file has been uploaded, or when the attachment is linked to a Dataset instead of a file.

datasetExistsboolean required

Whether attachment is linked to a Dataset.

sizeinteger nullable

The size of the uploaded file in bytes. Only present when blobExists is true. May be null for files on external blob store uploaded before version 2026.3.

updatedAtstring

ISO date format. The last time this file's binary content was set (POST) or cleared (DELETE).

Example response

[
  {
    "name": "myfile.png",
    "exists": true,
    "blobExists": true,
    "datasetExists": true,
    "size": 4096,
    "updatedAt": "2018-03-21T12:45:02.312Z"
  }
]

Changes