Back to Aligni.com

Retrieve an attachment's URI by its 'ID'.

Use this method to retrieve a temporary link that can be used to download an attachment file. The URI is provided by Amazon S3 and will expire and become invalid after 10 minutes.

Note: the attachment is not included in the response. The attachment must be downloaded using the URI provided.

BETA API: This API is beta and is subject to change without notice.

Examples

# request
curl -H 'Accept: application/xml' -H 'Content-Type: application/xml' \
https://demo.aligni.com/api/v2/oid3vLgynoy_Yl1gZkrgkLEq3J/attachments/5/download_uri
# response
<?xml version="1.0" encoding="UTF-8"?>
<attachment_link>
  <uri>/attachment/file.pdf</uri>
  <created_at>2020-07-31T08:24:57-11:00</created_at>
  <expires_at>2020-07-31T08:34:57-11:00</expires_at>
</attachment_link>

Params

Param name Description
api_token
required

Your API token.


Value: Must be a String
id
required

Value: Must be a Integer
content_disposition
optional

String typically used to provide browser clients guidance on how to present the attachment to the user (e.g. show inline or download). For non-browser applications, this can probably be ignored.

Values considered: inline (default) and attachment.


Value: Must be a String