Skip to main content

Get Attachment by Id

Request

This method gets the metadata for the attachment file with a specific. attachment id value.

Path
attachmentIdstring, (uuid)required

The id of the attachment.

Headers
Authorizationstring, >= 1required

Specify the Access token with prefix 'Bearer '.

Payload
// No request payload

Responses

Bodyapplication/json
attachmentIdstring, (uuid)required

Unique Identifier for the attachment

Example:"56d10de6-f2c0-4edd-ba29-b70736aa2093"
attachmentNamestringrequired

File name of the attachment

Example:"Example_Invoice.pdf"
attachmentTypestringrequired

Extension of the document

Example:"application/pdf"
attachmentSizenumber, [ 0 .. 1000000000 )required

size of the attachment in bytes

Default:0
Example:259387
createdDatestring, (date-time)required

Created date

Example:"2017-01-31T09:03:08.340Z"
createdBystringrequired

User key of the author of the attachment

Example:"john.doe@example.com"
lastUpdatedDatestring, (date-time)required

Last accessed date for the record

Example:"2017-04-06T17:10:44.807Z"
Response
{ "attachmentId": "56d10de6-f2c0-4edd-ba29-b70736aa2093", "attachmentName": "Example_Invoice.pdf", "attachmentType": "application/pdf", "attachmentSize": 259387, "createdDate": "2017-01-31T09:03:08.340Z", "createdBy": "john.doe@example.com", "lastUpdatedDate": "2017-04-06T17:10:44.807Z" }
Was this page helpful?