Get file attachment metadata associated with a document

get/documents/{entityTypeName}/{documentId}/attachments/{attachmentId}
Internal-Use Only

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

Request Samples

1

Response Samples

1{
2  "creationTimeStamp": "2019-11-06T22:01:23.809Z",
3  "modifiedTimeStamp": "2019-11-06T22:01:23.809Z",
4  "createdBy": "videmo",
5  "modifiedBy": "videmo",
6  "id": "608f37fb-d3b5-4381-bff0-4a6fee1c0e84",
7  "location": "/svi-datahub/documents/files/608f37fb-d3b5-4381-bff0-4a6fee1c0e84/files/608f37fb-d3b5-4381-bff0-4a6fee1c0e84",
8  "properties": {},
9  "contentDisposition": "attachment; filename=\"2cb2668d-218a-2f8a-a5aa-6a9ce54ff739\"",
10  "contentType": "text/plain",
11  "encoding": "UTF-8",
12  "links": [
13    {
14      "method": "GET",
15      "rel": "self",
16      "href": "/files/files/608f37fb-d3b5-4381-bff0-4a6fee1c0e84",
17      "uri": "/files/files/608f37fb-d3b5-4381-bff0-4a6fee1c0e84",
18      "type": "application/vnd.sas.file"
19    },
20    {
21      "method": "GET",
22      "rel": "alternate",
23      "href": "/files/files/608f37fb-d3b5-4381-bff0-4a6fee1c0e84",
24      "uri": "/files/files/608f37fb-d3b5-4381-bff0-4a6fee1c0e84",
25      "type": "application/vnd.sas.summary"
26    },
27    {
28      "method": "PATCH",
29      "rel": "patch",
30      "href": "/files/files/608f37fb-d3b5-4381-bff0-4a6fee1c0e84",
31      "uri": "/files/files/608f37fb-d3b5-4381-bff0-4a6fee1c0e84",
32      "type": "application/vnd.sas.file",
33      "responseType": "application/vnd.sas.file"
34    },
35    {
36      "method": "PUT",
37      "rel": "update",
38      "href": "/files/files/608f37fb-d3b5-4381-bff0-4a6fee1c0e84",
39      "uri": "/files/files/608f37fb-d3b5-4381-bff0-4a6fee1c0e84",
40      "type": "application/vnd.sas.file",
41      "responseType": "application/vnd.sas.file"
42    },
43    {
44      "method": "DELETE",
45      "rel": "delete",
46      "href": "/files/files/608f37fb-d3b5-4381-bff0-4a6fee1c0e84",
47      "uri": "/files/files/608f37fb-d3b5-4381-bff0-4a6fee1c0e84"
48    },
49    {
50      "method": "GET",
51      "rel": "content",
52      "href": "/files/files/608f37fb-d3b5-4381-bff0-4a6fee1c0e84/content",
53      "uri": "/files/files/608f37fb-d3b5-4381-bff0-4a6fee1c0e84/content",
54      "type": "text/plain"
55    },
56    {
57      "method": "PUT",
58      "rel": "updateContent",
59      "href": "/files/files/608f37fb-d3b5-4381-bff0-4a6fee1c0e84/content",
60      "uri": "/files/files/608f37fb-d3b5-4381-bff0-4a6fee1c0e84/content",
61      "type": "*/*",
62      "responseType": "application/vnd.sas.file"
63    },
64    {
65      "method": "POST",
66      "rel": "copyFile",
67      "href": "/files/files/608f37fb-d3b5-4381-bff0-4a6fee1c0e84/copy",
68      "uri": "/files/files/608f37fb-d3b5-4381-bff0-4a6fee1c0e84/copy",
69      "responseType": "application/vnd.sas.file"
70    },
71    {
72      "method": "POST",
73      "rel": "create",
74      "href": "/files/files",
75      "uri": "/files/files",
76      "type": "*/*",
77      "responseType": "application/vnd.sas.file"
78    }
79  ],
80  "name": "2cb2668d-218a-2f8a-a5aa-6a9ce54ff739",
81  "originalName": "My Attachment.txt",
82  "size": 443,
83  "typeDefName": "file",
84  "isLink": false,
85  "version": 3
86}

Path Parameters

NameTypeRequiredDescription
attachmentId
string
true

The ID for the attachment metadata.

documentId
string
true

The ID for the document.

entityTypeName
string
true

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

Responses

StatusMeaningDescription
200OKThe request succeeded.Schema
400Bad RequestThe request was invalid.Schema
404Not FoundThe attachment was not found.Schema