Get headers for all file attachment metadata associated with a document

head/documents/{entityTypeName}/{documentId}/attachments
Internal-Use Only

Gets headers for all file attachment metadata that is associated with a document. The "location" property in the response contains the relative URI path to the document. To retrieve the contents of an attachment, use that URI to download the document from the Files service: GET ${hostAndPort}${valueOfLocationProperty} . Note that hostAndPort is the host and port of the Files service.

Request Samples

1

Response Samples

1No example avaliable

Path Parameters

NameTypeRequiredDescription
documentId
string
true

The ID for the document.

entityTypeName
string
true

The name of the entity type to which the document belongs.

Query Parameters

NameTypeRequiredDescription
filter
string
false

The criteria by which to filter the attachments.

limit
integer
false

The maximum number of attachments to return in this page of results. The actual number of returned items is fewer if the collection is exhausted.

Default:
10
sortBy
string
false

The criteria by which to sort the attachments.

Default:
uploadedAt:descending
start
integer
false

The starting index of the first document in a page.

Default:
0

Responses

StatusMeaningDescription
200OKThe request succeeded.
400Bad RequestThe request was invalid.