Create file attachment metadata on a document

post/documents/{entityTypeName}/{documentId}/attachments

Internal-Use Only

Creates file attachment metadata on a document. To create an attachment, upload the file to the SAS Viya Files service, and then use the Files service response to construct a request to the Data Hub createDocumentAttachment endpoint. Here is an example of how to upload a file to the Files service (as of version 1.1 of the Files service):

POST /files/files?parentFolderUri=/folders/folders/${clientGeneratedUuid} The payload of the request is the file. Refer to the Files API documentation for complete information about how to upload a file. The client generates the UUID, which acts as the file name. That UUID is used in the Data Hub attachments request in the "id" and "location" properties. The "location" property is the relative URI path to download the document from the Files service. Obtain additional property values, such as "type" and "size", from the response of the POST request to the Files service.

Request Samples

application/json
1

Response Samples

201
application/json
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

Name	Type	Required	Description
documentId	string	true	The ID for the document.
entityTypeName	string	true	The name of the entity type to which the document belongs.

Request Body

The metadata that associates a file with a document.

The metadata for a file associated that is with a document. The actual file content is stored by the Files service.

Example:

{"$ref":"#/components/examples/fileExample"}

Name	Type	Required	Description
links	array [SAS Link]	false	A list of vnd.sas.link objects as per Link representation.
id	string<uuid>	false	A UUID that uniquely identifies this file.
name	string	false	The name of the file.
originalName	string	false	The original name of the file when it was uploaded.
category	string	false	The category to which the file belongs.
location	string	false	A URI for the content of the file.
type	string	false	The MIME type of the file.
size	integer	false	The size (in KB) of the file.
description	string	false	A description of the file.
properties	object	false	The properties to associate with the file.
uploadedAt	string<date-time>	false	The timestamp that indicates when the file was uploaded.
uploadedBy	string	false	The user who uploaded the file.
extractedContent	string	false	Any content that has been extracted for indexing. If the file assocation is an external link, this field can be used to provide extracted content that will be indexed.
isLink	boolean	false	Identifies the location of the content. True is assigned if the file association is a link to an external file. False is assigned if the file has been uploaded to the system as an attachment. This field is read-only. Incoming values are ignored.

Responses

Status	Meaning	Description
201	Created	The file attachment metadata on a document was created.	Headers	Schema
400	Bad Request	The request was invalid.		Schema