Update a file resource

patch/files/{fileId}

Internal-Use Only

Updates the file resource information. The user can change these attributes: name, description, parentUri, documentType, contentDisposition, properties, expirationTimeStamp,typeDefName and searchable

Request Samples

application/vnd.sas.file+json
1

Response Samples

200
application/vnd.sas.file+json
1{
2  "creationTimeStamp": "2022-03-31T20:00:03.609Z",
3  "modifiedTimeStamp": "2022-03-31T20:00:03.826Z",
4  "createdBy": "sas.audit",
5  "modifiedBy": "sas.audit",
6  "id": "cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7",
7  "parentUri": "/jobExecution/jobs/b9fe292d-2a4e-434c-8154-5f490b4b9257",
8  "properties": {
9    "LastState": "running",
10    "JobRequest": "",
11    "Job": "b9fe292d-2a4e-434c-8154-5f490b4b9257",
12    "Provider": "casl"
13  },
14  "contentDisposition": "text/plain",
15  "contentType": "text/plain",
16  "description": "Log File for Job b9fe292d-2a4e-434c-8154-5f490b4b9257",
17  "documentType": "log",
18  "encoding": "UTF-8",
19  "links": [
20    {
21      "method": "GET",
22      "rel": "self",
23      "href": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7",
24      "uri": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7",
25      "type": "application/vnd.sas.file"
26    },
27    {
28      "method": "GET",
29      "rel": "alternate",
30      "href": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7",
31      "uri": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7",
32      "type": "application/vnd.sas.summary"
33    },
34    {
35      "method": "PATCH",
36      "rel": "patch",
37      "href": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7",
38      "uri": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7",
39      "type": "application/vnd.sas.file",
40      "responseType": "application/vnd.sas.file"
41    },
42    {
43      "method": "PUT",
44      "rel": "update",
45      "href": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7",
46      "uri": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7",
47      "type": "application/vnd.sas.file",
48      "responseType": "application/vnd.sas.file"
49    },
50    {
51      "method": "DELETE",
52      "rel": "delete",
53      "href": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7",
54      "uri": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7"
55    },
56    {
57      "method": "GET",
58      "rel": "content",
59      "href": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7/content",
60      "uri": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7/content",
61      "type": "text/plain"
62    },
63    {
64      "method": "PUT",
65      "rel": "updateContent",
66      "href": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7/content",
67      "uri": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7/content",
68      "type": "*/*",
69      "responseType": "application/vnd.sas.file"
70    },
71    {
72      "method": "POST",
73      "rel": "copyFile",
74      "href": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7/copy",
75      "uri": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7/copy",
76      "responseType": "application/vnd.sas.file"
77    },
78    {
79      "method": "POST",
80      "rel": "create",
81      "href": "/files/files",
82      "uri": "/files/files",
83      "type": "*/*",
84      "responseType": "application/vnd.sas.file"
85    }
86  ],
87  "name": "2022-03-31T20:00:03Z-results.log",
88  "size": 742,
89  "searchable": false,
90  "fileStatus": "unlocked",
91  "fileVersion": 0,
92  "expirationTimeStamp": "2022-04-07T20:00:03.651Z",
93  "virusDetected": false,
94  "urlDetected": false,
95  "quarantine": false,
96  "version": 4
97}

Path Parameters

Name	Type	Required	Description
fileId	string	true	The identifier of the file resource to update.

Header Parameters

Name	Type	Required	Description
If-Match	string	false	The entity tag that was obtained from the most recent `ETag` response header.
If-Unmodified-Since	string	false	The timestamp that was obtained from the most recent `Last-Modified` response header. This is ignored when `If-Match` is specified.

Request Body

The file resource to update.

File to Patch

Name	Type	Required	Description
parentUri	string	false	The URI of the object that is associated with or linked to a file resource.
properties	object	false	The properties that are specific to this file. Each property uses a "key" : "value" format. Use a comma to separate properties.
contentDisposition	string	false	The value for the Content-Disposition header. This is specified in response when downloading the file.
description	string	false	The description of the file resource.
documentType	string	false	The type of the file resource.
name	string	true	The name of the file resource.
searchable	boolean	true	It indicates if a file is searchable or not.
typeDefName	string	false	The type definition name of the file. If the file is associated with a folder and the client does not provide the value of this parameter, the file-service tries to find the best possible value using the type-registry service. If it fails to find a default value, it defaults to "file".

Responses

Status	Meaning	Description
200	OK	The request succeeded. The updates were applied, and the new object data is returned in the response body.	Headers	Schema
400	Bad Request	The request was not valid. A validation error occurred. Check the string that was returned in the response for more information. A possible cause is that the filename is not specified in the request body.		Schema
404	Not Found	No file resource exists for the specified identifier.		Schema
412	Precondition Failed	The `If-Match` request header did not match the resource's entity tag or the `If-Unmodified-Since` request header did not match the resource's last modified timestamp. Another operation modified the resource. Get an updated representation of the resource before trying the request again.		Schema
428	Precondition Required	The request headers did not include a `If-Match` or `If-Unmodified-Since` precondition. Specify the appropriate values for the `If-Unmodified-Since` and `If-Match` request headers before trying the request again.		Schema