Make a partial update to a folder

patch/folders/{folderId}

Internal-Use Only

Updates the provided fields of a folder. The client can provide a sparsely populated object, and only the non-null fields contribute to the updates. A body such as { "name": "NewFolderName" } causes the folder to have its name changed, but no other field is affected. The full resulting object is returned in the response.

Request Samples

application/json
default
1

Response Samples

200
application/json
1{
2  "creationTimeStamp": "2019-08-08T12:53:51.309Z",
3  "modifiedTimeStamp": "2019-08-08T12:53:51.309Z",
4  "createdBy": "testuser",
5  "modifiedBy": "testuser",
6  "id": "6e6aa6e9-7c6a-4491-84fd-84051031a44d",
7  "name": "My Folder",
8  "parentFolderUri": "/folders/folders/f210f767-7f3a-4109-849b-f1b7d1c5d11a",
9  "description": "My Folder for testuser",
10  "type": "myFolder",
11  "memberCount": 0,
12  "properties": {
13    "allowMove": "false"
14  },
15  "links": [
16    {
17      "method": "GET",
18      "rel": "self",
19      "href": "/folders/folders/6e6aa6e9-7c6a-4491-84fd-84051031a44d",
20      "uri": "/folders/folders/6e6aa6e9-7c6a-4491-84fd-84051031a44d",
21      "type": "application/vnd.sas.content.folder"
22    },
23    {
24      "method": "GET",
25      "rel": "up",
26      "href": "/folders/folders/f210f767-7f3a-4109-849b-f1b7d1c5d11a",
27      "uri": "/folders/folders/f210f767-7f3a-4109-849b-f1b7d1c5d11a",
28      "type": "application/vnd.sas.content.folder"
29    },
30    {
31      "method": "PUT",
32      "rel": "validateNewMemberName",
33      "href": "/folders/commons/validations/folders/6e6aa6e9-7c6a-4491-84fd-84051031a44d/members/@new/name?value={newname}&type={newtype}",
34      "uri": "/folders/commons/validations/folders/6e6aa6e9-7c6a-4491-84fd-84051031a44d/members/@new/name?value={newname}&type={newtype}"
35    },
36    {
37      "method": "GET",
38      "rel": "ancestors",
39      "href": "/folders/ancestors?childUri=/folders/folders/6e6aa6e9-7c6a-4491-84fd-84051031a44d",
40      "uri": "/folders/ancestors?childUri=/folders/folders/6e6aa6e9-7c6a-4491-84fd-84051031a44d",
41      "type": "application/vnd.sas.content.folder.ancestor"
42    },
43    {
44      "method": "DELETE",
45      "rel": "delete",
46      "href": "/folders/folders/6e6aa6e9-7c6a-4491-84fd-84051031a44d",
47      "uri": "/folders/folders/6e6aa6e9-7c6a-4491-84fd-84051031a44d"
48    },
49    {
50      "method": "DELETE",
51      "rel": "deleteRecursively",
52      "href": "/folders/folders/6e6aa6e9-7c6a-4491-84fd-84051031a44d?recursive=true",
53      "uri": "/folders/folders/6e6aa6e9-7c6a-4491-84fd-84051031a44d?recursive=true"
54    },
55    {
56      "method": "GET",
57      "rel": "members",
58      "href": "/folders/folders/6e6aa6e9-7c6a-4491-84fd-84051031a44d/members",
59      "uri": "/folders/folders/6e6aa6e9-7c6a-4491-84fd-84051031a44d/members",
60      "type": "application/vnd.sas.collection",
61      "itemType": "application/vnd.sas.content.folder.member"
62    },
63    {
64      "method": "POST",
65      "rel": "addMember",
66      "href": "/folders/folders/6e6aa6e9-7c6a-4491-84fd-84051031a44d/members",
67      "uri": "/folders/folders/6e6aa6e9-7c6a-4491-84fd-84051031a44d/members",
68      "type": "application/vnd.sas.content.folder.member"
69    },
70    {
71      "method": "POST",
72      "rel": "createChild",
73      "href": "/folders/folders?parentFolderUri=/folders/folders/6e6aa6e9-7c6a-4491-84fd-84051031a44d",
74      "uri": "/folders/folders?parentFolderUri=/folders/folders/6e6aa6e9-7c6a-4491-84fd-84051031a44d",
75      "type": "application/vnd.sas.content.folder"
76    },
77    {
78      "method": "GET",
79      "rel": "transferExport",
80      "href": "/folders/folders/6e6aa6e9-7c6a-4491-84fd-84051031a44d",
81      "uri": "/folders/folders/6e6aa6e9-7c6a-4491-84fd-84051031a44d",
82      "responseType": "application/vnd.sas.transfer.object"
83    },
84    {
85      "method": "PUT",
86      "rel": "transferImportUpdate",
87      "href": "/folders/folders/6e6aa6e9-7c6a-4491-84fd-84051031a44d",
88      "uri": "/folders/folders/6e6aa6e9-7c6a-4491-84fd-84051031a44d",
89      "type": "application/vnd.sas.transfer.object",
90      "responseType": "application/vnd.sas.summary"
91    }
92  ],
93  "version": 1
94}

Path Parameters

Name	Type	Required	Description
folderId	string<object-id>	true	The identifier of a specific folder, or of one of the delegate strings @myFolder, @appDataFolder, @myHistory, @myFavorites, or @public.

Header Parameters

Name	Type	Required	Description
If-Match	string	false	The ETag that was returned from a GET, POST, or PUT of this folder.
If-Unmodified-Since	string	false	The value of the lastModified date of the folder. If the folder has been updated since this time, the update fails.

Request Body

Folder

The schema for creating a new folder.

Example:

{"name":"Test Folder 1","description":"A Test Folder","type":"folder"}

Name	Type	Required	Description
name	string	true	Localizable folder name.
description	string	false	Localizable folder description.
type	string	false	Specialized subtype for this folder. The default value is 'folder'. Default: folder
parentFolderUri	string	false	The URI of this folder's parent folder. This is writable by the client. In order to perform a move, PUT this folder with an updated parentFolderUri pointing to the new parent. It is valid for this field to be null, which indicates a root folder.
version	integer	false	This media type's schema version number. This representation is version 1.

Responses

Status	Meaning	Description
200	OK	The request succeeded. The folder was updated.	Headers	Schema
400	Bad Request	The request was invalid. The JSON was malformed, or invalid for the request.		Schema
404	Not Found	No folder exists at the requested path.		Schema
409	Conflict	The request could not be completed due to a conflict with the current state of the resource. Changing the name as requested would cause a naming conflict.		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.		Schema
422	Unprocessable Entity	The request cannot be processed. One or more elements of the body are invalid.		Schema