Get a list of folders

get/folders
Internal-Use Only

Returns a list of folders. Standard paging, filtering, and sorting options are provided.

Request Samples

1

Response Samples

1{
2  "links": [
3    {
4      "method": "GET",
5      "rel": "collection",
6      "href": "/folders/folders",
7      "uri": "/folders/folders",
8      "type": "application/vnd.sas.collection"
9    },
10    {
11      "method": "GET",
12      "rel": "self",
13      "href": "/folders/folders?start=0&limit=20",
14      "uri": "/folders/folders?start=0&limit=20",
15      "type": "application/vnd.sas.collection"
16    },
17    {
18      "method": "POST",
19      "rel": "createFolder",
20      "href": "/folders/folders",
21      "uri": "/folders/folders",
22      "type": "application/vnd.sas.content.folder",
23      "responseType": "application/vnd.sas.content.folder"
24    }
25  ],
26  "name": "folders",
27  "accept": "application/vnd.sas.content.folder",
28  "start": 0,
29  "items": [
30    {
31      "creationTimeStamp": "2020-10-27T16:26:54.618197Z",
32      "createdBy": "omitest",
33      "modifiedTimeStamp": "2020-10-27T16:26:54.618198Z",
34      "modifiedBy": "omitest",
35      "version": 1,
36      "id": "b156020a-83f1-41c2-9d63-fe49780526dc",
37      "name": "Samples",
38      "parentFolderUri": "/folders/folders/804ea126-e12b-42ee-b9c4-40cb79db222b",
39      "type": "folder",
40      "memberCount": 7,
41      "links": [
42        {
43          "method": "GET",
44          "rel": "self",
45          "href": "/folders/folders/b156020a-83f1-41c2-9d63-fe49780526dc",
46          "uri": "/folders/folders/b156020a-83f1-41c2-9d63-fe49780526dc",
47          "type": "application/vnd.sas.content.folder"
48        },
49        {
50          "method": "PUT",
51          "rel": "update",
52          "href": "/folders/folders/b156020a-83f1-41c2-9d63-fe49780526dc",
53          "uri": "/folders/folders/b156020a-83f1-41c2-9d63-fe49780526dc",
54          "type": "application/vnd.sas.content.folder",
55          "responseType": "application/vnd.sas.content.folder"
56        },
57        {
58          "method": "DELETE",
59          "rel": "delete",
60          "href": "/folders/folders/b156020a-83f1-41c2-9d63-fe49780526dc",
61          "uri": "/folders/folders/b156020a-83f1-41c2-9d63-fe49780526dc"
62        },
63        {
64          "method": "DELETE",
65          "rel": "deleteRecursively",
66          "href": "/folders/folders/b156020a-83f1-41c2-9d63-fe49780526dc?recursive=true",
67          "uri": "/folders/folders/b156020a-83f1-41c2-9d63-fe49780526dc?recursive=true"
68        },
69        {
70          "method": "GET",
71          "rel": "members",
72          "href": "/folders/folders/b156020a-83f1-41c2-9d63-fe49780526dc/members",
73          "uri": "/folders/folders/b156020a-83f1-41c2-9d63-fe49780526dc/members",
74          "type": "application/vnd.sas.collection",
75          "itemType": "application/vnd.sas.content.folder"
76        },
77        {
78          "method": "POST",
79          "rel": "addMember",
80          "href": "/folders/folders/b156020a-83f1-41c2-9d63-fe49780526dc/members",
81          "uri": "/folders/folders/b156020a-83f1-41c2-9d63-fe49780526dc/members",
82          "type": "application/vnd.sas.content.folder.member",
83          "responseType": "application/vnd.sas.content.folder.member"
84        },
85        {
86          "method": "GET",
87          "rel": "up",
88          "href": "/folders/folders/804ea126-e12b-42ee-b9c4-40cb79db222b",
89          "uri": "/folders/folders/804ea126-e12b-42ee-b9c4-40cb79db222b",
90          "type": "application/vnd.sas.content.folder"
91        },
92        {
93          "method": "GET",
94          "rel": "ancestors",
95          "href": "/folders/ancestors?childUri=/folders/folders/b156020a-83f1-41c2-9d63-fe49780526dc",
96          "uri": "/folders/ancestors?childUri=/folders/folders/b156020a-83f1-41c2-9d63-fe49780526dc",
97          "type": "application/vnd.sas.content.folder.ancestor"
98        },
99        {
100          "method": "POST",
101          "rel": "createChild",
102          "href": "/folders/folders?parentFolderUri=/folders/folders/b156020a-83f1-41c2-9d63-fe49780526dc",
103          "uri": "/folders/folders?parentFolderUri=/folders/folders/b156020a-83f1-41c2-9d63-fe49780526dc",
104          "type": "application/vnd.sas.content.folder"
105        },
106        {
107          "method": "PUT",
108          "rel": "validateRename",
109          "href": "/folders/commons/validations/folders/804ea126-e12b-42ee-b9c4-40cb79db222b/members/0ab9120e-2cbc-4de8-8b6e-e8d81b60d982/name?value={newname}&type=folder",
110          "uri": "/folders/commons/validations/folders/804ea126-e12b-42ee-b9c4-40cb79db222b/members/0ab9120e-2cbc-4de8-8b6e-e8d81b60d982/name?value={newname}&type=folder",
111          "type": "application/vnd.sas.validation"
112        },
113        {
114          "method": "PUT",
115          "rel": "validateNewMemberName",
116          "href": "/folders/commons/validations/folders/b156020a-83f1-41c2-9d63-fe49780526dc/members/@new/name?value={newname}&type={newtype}",
117          "uri": "/folders/commons/validations/folders/b156020a-83f1-41c2-9d63-fe49780526dc/members/@new/name?value={newname}&type={newtype}",
118          "type": "application/vnd.sas.validation"
119        },
120        {
121          "method": "GET",
122          "rel": "transferExport",
123          "href": "/folders/folders/b156020a-83f1-41c2-9d63-fe49780526dc",
124          "uri": "/folders/folders/b156020a-83f1-41c2-9d63-fe49780526dc",
125          "responseType": "application/vnd.sas.transfer.object"
126        },
127        {
128          "method": "PUT",
129          "rel": "transferImportUpdate",
130          "href": "/folders/folders/b156020a-83f1-41c2-9d63-fe49780526dc",
131          "uri": "/folders/folders/b156020a-83f1-41c2-9d63-fe49780526dc",
132          "type": "application/vnd.sas.transfer.object",
133          "responseType": "application/vnd.sas.summary"
134        },
135        {
136          "method": "POST",
137          "rel": "transferImport",
138          "href": "/folders/folders",
139          "uri": "/folders/folders",
140          "type": "application/vnd.sas.transfer.object",
141          "responseType": "application/vnd.sas.summary"
142        }
143      ]
144    },
145    {
146      "<item 2>": null
147    },
148    {
149      "<item 3>": null
150    },
151    {
152      "etc. to item 20": null
153    }
154  ],
155  "limit": 20,
156  "version": 2
157}

Query Parameters

NameTypeRequiredDescription
childUri
string<relative URI>
false

Return only folders containing a child member with the specified URI. For now, childUri, referenceUri, memberUri, and filter are mutually exclusive. The childUri has special semantics, because it should return only a single item. The URL form /folders/.?childUri={resourceUri} can be used to return a single item.

filter
string<filter-criteria>
false

Filter criteria for returned folders. See Filtering in REST APIs. Any member of the Folder object can be used to filter the results: id, name, description, createdBy, modifiedBy, properties, type, or parent. Date fields currently cannot be used to filter results. Sample queries Get Root Folders: /folders?filter=isNull(parent) Get folders by name: /folders?filter=contains(name, 'Sample') Get folders by type: /folders?filter=in(type, 'history', 'favorites')

limit
integer
false

Maximum number of folders to return. The default value is 20.

memberUri
string<relative URI>
false

Return only folders containing any member with the specified URI. For now, childUri, referenceUri, memberUri, and filter are mutually exclusive.

referenceUri
string<relative URI>
false

Return only folders containing a reference member with the specified URI. For now, childUri, referenceUri, memberUri, and filter are mutually exclusive.

sortBy
string<sort-criteria>
false

Sort returned folder. See Sorting in REST APIs. The default sort order is name:ascending. Other valid sorting options are orderNum the order specified by the user added the timestamp when the item was added to the folder name the folder name

start
integer
false

0-based offset of first folder to return. The default value is 0.

Header Parameters

NameTypeRequiredDescription
Accept-Item
string
false

If provided, this should be an alternative media type that the service recognizes. If the media type is not one that the service can provide, a 406 response is returned.

Accept-Language
string
false

Enumerates the languages that the client prefers to use for the response. This can be used to provide localized data where available.

Responses

StatusMeaningDescription
200OKThe request succeeded.Schema
400Bad RequestThe request was invalid. An invalid filter or combination of request parameters was provided.Schema