Update the file association object with the specified file ID

put/documents/{objectTypeName}/{objectId}/files/{fileId}

Internal-Use Only

Updates the file metadata for the file with the specified object type, object type ID, and file ID. You can update the following fields: name, description, displayOrder and properties. If the file association is a link to an external file, you can also update the extractedContent field. Updates to any other fields are ignored.

Request Samples

Response Samples

200
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
fileId	string	true	The ID of the file.
objectId	string	true	The ID of the object.
objectTypeName	string	true	The name of the object type to which the object belongs.

Query Parameters

Name	Type	Required	Description
includeExtractedContent	boolean	false	If the file metadata contains any extracted content and this parameter is set to true, extracted file content is included in the response. Default: false

Header Parameters

Name	Type	Required	Description
If-Match	string	false	The ETag of the representation in the request. If this header value is provided, it must match the ETag of the current version of the resource on the server. Otherwise, the server responds with a 412 error.

Responses

Status	Meaning	Description
200	OK	The file metadata update was successful.	Headers	Schema
400	Bad Request	The request was invalid. The file ID cannot be null.		Schema
404	Not Found	The object does not exist, the user does not have the correct permissions to view the object, or the file ID in the request body does not match the file ID in the URI path.		Schema
412	Precondition Failed	The file association in the request body was out of date or it did not include a version number.		Schema