Individual Form

Downloading a Form Attachment

Changed on

To download a single file, use this endpoint.

The appropriate Content-Disposition (attachment with a filename) and Content-Type will be given. Content-Type will be either:

  1. the type supplied at upload time, or if not supplied
  2. a type derived from the file extension, or if none found
  3. application/octet-stream

This endpoint supports ETag, which can be used to avoid downloading the same content more than once. When an API consumer calls this endpoint, it returns a value in ETag header, you can pass this value in the header If-None-Match of subsequent requests. If the file has not been changed since the previous request, you will receive 304 Not Modified response otherwise you'll get the latest file.

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

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/{filename}
  • Auth
    none declared

Path parameters

projectIdnumber required

The numeric ID of the Project

xmlFormIdstring required

The xmlFormId of the Form being referenced.

filenamestring required

The name of the file to download.

Response

OK

Changes