Get ancestors for a list of resource URIs

post/ancestors

Internal-Use Only

Get the ancestors of a set of URIs. Each URI is represented in the result as an Ancestor object.

Request Samples

application/json
1

Response Samples

200
application/vnd.sas.collection+json
1{
2  "version": 2,
3  "accept": "application/vnd.sas.content.folder.ancestor",
4  "count": 3,
5  "start": 0,
6  "limit": 10,
7  "name": "folders",
8  "items": [
9    {
10      "childUri": "/files/files/1230193209132",
11      "ancestors": [],
12      "version": 1
13    },
14    {
15      "childUri": "/reports/reports/aldjkslkjflskfjskf",
16      "ancestors": [],
17      "version": 1
18    },
19    {
20      "childUri": "/files/files/016cf2b0-ef36-4344-9896-0439a027d8ab",
21      "ancestors": [
22        {
23          "creationTimeStamp": "2022-06-17T18:33:22.711019Z",
24          "createdBy": "stpweb1",
25          "modifiedTimeStamp": "2022-06-17T18:33:22.71102Z",
26          "modifiedBy": "stpweb1",
27          "version": 1,
28          "id": "f4300a6d-407e-46fc-9c8a-e8142bd5d172",
29          "name": "My Folder",
30          "parentFolderUri": "/folders/folders/c18ba574-76d3-4104-b9b3-9332b6106453",
31          "description": "My Folder for stpweb1",
32          "type": "myFolder",
33          "memberCount": 3,
34          "properties": {
35            "allowMove": "false"
36          },
37          "links": [
38            {
39              "method": "GET",
40              "rel": "self",
41              "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172",
42              "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172",
43              "type": "application/vnd.sas.content.folder"
44            },
45            {
46              "method": "DELETE",
47              "rel": "delete",
48              "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172",
49              "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172"
50            },
51            {
52              "method": "DELETE",
53              "rel": "deleteRecursively",
54              "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172?recursive=true",
55              "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172?recursive=true"
56            },
57            {
58              "method": "GET",
59              "rel": "members",
60              "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members",
61              "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members",
62              "type": "application/vnd.sas.collection",
63              "itemType": "application/vnd.sas.content.folder"
64            },
65            {
66              "method": "POST",
67              "rel": "addMember",
68              "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members",
69              "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members",
70              "type": "application/vnd.sas.content.folder.member",
71              "responseType": "application/vnd.sas.content.folder.member"
72            },
73            {
74              "method": "GET",
75              "rel": "up",
76              "href": "/folders/folders/c18ba574-76d3-4104-b9b3-9332b6106453",
77              "uri": "/folders/folders/c18ba574-76d3-4104-b9b3-9332b6106453",
78              "type": "application/vnd.sas.content.folder"
79            },
80            {
81              "method": "GET",
82              "rel": "ancestors",
83              "href": "/folders/ancestors?childUri=/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172",
84              "uri": "/folders/ancestors?childUri=/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172",
85              "type": "application/vnd.sas.content.folder.ancestor"
86            },
87            {
88              "method": "POST",
89              "rel": "createChild",
90              "href": "/folders/folders?parentFolderUri=/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172",
91              "uri": "/folders/folders?parentFolderUri=/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172",
92              "type": "application/vnd.sas.content.folder"
93            },
94            {
95              "method": "PUT",
96              "rel": "validateNewMemberName",
97              "href": "/folders/commons/validations/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/@new/name?value={newname}&type={newtype}",
98              "uri": "/folders/commons/validations/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/@new/name?value={newname}&type={newtype}",
99              "type": "application/vnd.sas.validation"
100            },
101            {
102              "method": "GET",
103              "rel": "transferExport",
104              "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172",
105              "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172",
106              "responseType": "application/vnd.sas.transfer.object"
107            },
108            {
109              "method": "PUT",
110              "rel": "transferImportUpdate",
111              "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172",
112              "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172",
113              "type": "application/vnd.sas.transfer.object",
114              "responseType": "application/vnd.sas.summary"
115            },
116            {
117              "method": "POST",
118              "rel": "transferImport",
119              "href": "/folders/folders",
120              "uri": "/folders/folders",
121              "type": "application/vnd.sas.transfer.object",
122              "responseType": "application/vnd.sas.summary"
123            }
124          ]
125        },
126        {
127          "creationTimeStamp": "2022-06-17T18:33:22.626045Z",
128          "createdBy": "stpweb1",
129          "modifiedTimeStamp": "2022-06-17T18:33:22.626048Z",
130          "modifiedBy": "stpweb1",
131          "version": 1,
132          "id": "c18ba574-76d3-4104-b9b3-9332b6106453",
133          "name": "stpweb1",
134          "parentFolderUri": "/folders/folders/329d3711-3c38-4391-8920-c35478e2456b",
135          "description": "The user folder for stpweb1",
136          "type": "userFolder",
137          "memberCount": 5,
138          "properties": {
139            "allowMove": "false",
140            "hidden": "true"
141          },
142          "links": [
143            {
144              "method": "GET",
145              "rel": "self",
146              "href": "/folders/folders/c18ba574-76d3-4104-b9b3-9332b6106453",
147              "uri": "/folders/folders/c18ba574-76d3-4104-b9b3-9332b6106453",
148              "type": "application/vnd.sas.content.folder"
149            },
150            {
151              "method": "DELETE",
152              "rel": "delete",
153              "href": "/folders/folders/c18ba574-76d3-4104-b9b3-9332b6106453",
154              "uri": "/folders/folders/c18ba574-76d3-4104-b9b3-9332b6106453"
155            },
156            {
157              "method": "DELETE",
158              "rel": "deleteRecursively",
159              "href": "/folders/folders/c18ba574-76d3-4104-b9b3-9332b6106453?recursive=true",
160              "uri": "/folders/folders/c18ba574-76d3-4104-b9b3-9332b6106453?recursive=true"
161            },
162            {
163              "method": "GET",
164              "rel": "members",
165              "href": "/folders/folders/c18ba574-76d3-4104-b9b3-9332b6106453/members",
166              "uri": "/folders/folders/c18ba574-76d3-4104-b9b3-9332b6106453/members",
167              "type": "application/vnd.sas.collection",
168              "itemType": "application/vnd.sas.content.folder"
169            },
170            {
171              "method": "POST",
172              "rel": "addMember",
173              "href": "/folders/folders/c18ba574-76d3-4104-b9b3-9332b6106453/members",
174              "uri": "/folders/folders/c18ba574-76d3-4104-b9b3-9332b6106453/members",
175              "type": "application/vnd.sas.content.folder.member",
176              "responseType": "application/vnd.sas.content.folder.member"
177            },
178            {
179              "method": "GET",
180              "rel": "up",
181              "href": "/folders/folders/329d3711-3c38-4391-8920-c35478e2456b",
182              "uri": "/folders/folders/329d3711-3c38-4391-8920-c35478e2456b",
183              "type": "application/vnd.sas.content.folder"
184            },
185            {
186              "method": "GET",
187              "rel": "ancestors",
188              "href": "/folders/ancestors?childUri=/folders/folders/c18ba574-76d3-4104-b9b3-9332b6106453",
189              "uri": "/folders/ancestors?childUri=/folders/folders/c18ba574-76d3-4104-b9b3-9332b6106453",
190              "type": "application/vnd.sas.content.folder.ancestor"
191            },
192            {
193              "method": "POST",
194              "rel": "createChild",
195              "href": "/folders/folders?parentFolderUri=/folders/folders/c18ba574-76d3-4104-b9b3-9332b6106453",
196              "uri": "/folders/folders?parentFolderUri=/folders/folders/c18ba574-76d3-4104-b9b3-9332b6106453",
197              "type": "application/vnd.sas.content.folder"
198            },
199            {
200              "method": "PUT",
201              "rel": "validateNewMemberName",
202              "href": "/folders/commons/validations/folders/c18ba574-76d3-4104-b9b3-9332b6106453/members/@new/name?value={newname}&type={newtype}",
203              "uri": "/folders/commons/validations/folders/c18ba574-76d3-4104-b9b3-9332b6106453/members/@new/name?value={newname}&type={newtype}",
204              "type": "application/vnd.sas.validation"
205            },
206            {
207              "method": "GET",
208              "rel": "transferExport",
209              "href": "/folders/folders/c18ba574-76d3-4104-b9b3-9332b6106453",
210              "uri": "/folders/folders/c18ba574-76d3-4104-b9b3-9332b6106453",
211              "responseType": "application/vnd.sas.transfer.object"
212            },
213            {
214              "method": "PUT",
215              "rel": "transferImportUpdate",
216              "href": "/folders/folders/c18ba574-76d3-4104-b9b3-9332b6106453",
217              "uri": "/folders/folders/c18ba574-76d3-4104-b9b3-9332b6106453",
218              "type": "application/vnd.sas.transfer.object",
219              "responseType": "application/vnd.sas.summary"
220            },
221            {
222              "method": "POST",
223              "rel": "transferImport",
224              "href": "/folders/folders",
225              "uri": "/folders/folders",
226              "type": "application/vnd.sas.transfer.object",
227              "responseType": "application/vnd.sas.summary"
228            }
229          ]
230        },
231        {
232          "creationTimeStamp": "2022-06-17T16:33:36.212131Z",
233          "createdBy": "anonymous",
234          "modifiedTimeStamp": "2022-06-17T16:33:36.212133Z",
235          "modifiedBy": "anonymous",
236          "version": 1,
237          "id": "329d3711-3c38-4391-8920-c35478e2456b",
238          "name": "Users",
239          "description": "Base Folder for all user folders.",
240          "type": "userRoot",
241          "memberCount": 6,
242          "properties": {
243            "allowMove": "false",
244            "uuid": "e911697e-fe53-497c-a27c-909c757ba04a"
245          },
246          "links": [
247            {
248              "method": "GET",
249              "rel": "self",
250              "href": "/folders/folders/329d3711-3c38-4391-8920-c35478e2456b",
251              "uri": "/folders/folders/329d3711-3c38-4391-8920-c35478e2456b",
252              "type": "application/vnd.sas.content.folder"
253            },
254            {
255              "method": "DELETE",
256              "rel": "delete",
257              "href": "/folders/folders/329d3711-3c38-4391-8920-c35478e2456b",
258              "uri": "/folders/folders/329d3711-3c38-4391-8920-c35478e2456b"
259            },
260            {
261              "method": "DELETE",
262              "rel": "deleteRecursively",
263              "href": "/folders/folders/329d3711-3c38-4391-8920-c35478e2456b?recursive=true",
264              "uri": "/folders/folders/329d3711-3c38-4391-8920-c35478e2456b?recursive=true"
265            },
266            {
267              "method": "GET",
268              "rel": "members",
269              "href": "/folders/folders/329d3711-3c38-4391-8920-c35478e2456b/members",
270              "uri": "/folders/folders/329d3711-3c38-4391-8920-c35478e2456b/members",
271              "type": "application/vnd.sas.collection",
272              "itemType": "application/vnd.sas.content.folder"
273            },
274            {
275              "method": "POST",
276              "rel": "addMember",
277              "href": "/folders/folders/329d3711-3c38-4391-8920-c35478e2456b/members",
278              "uri": "/folders/folders/329d3711-3c38-4391-8920-c35478e2456b/members",
279              "type": "application/vnd.sas.content.folder.member",
280              "responseType": "application/vnd.sas.content.folder.member"
281            },
282            {
283              "method": "GET",
284              "rel": "ancestors",
285              "href": "/folders/ancestors?childUri=/folders/folders/329d3711-3c38-4391-8920-c35478e2456b",
286              "uri": "/folders/ancestors?childUri=/folders/folders/329d3711-3c38-4391-8920-c35478e2456b",
287              "type": "application/vnd.sas.content.folder.ancestor"
288            },
289            {
290              "method": "POST",
291              "rel": "createChild",
292              "href": "/folders/folders?parentFolderUri=/folders/folders/329d3711-3c38-4391-8920-c35478e2456b",
293              "uri": "/folders/folders?parentFolderUri=/folders/folders/329d3711-3c38-4391-8920-c35478e2456b",
294              "type": "application/vnd.sas.content.folder"
295            },
296            {
297              "method": "PUT",
298              "rel": "validateNewMemberName",
299              "href": "/folders/commons/validations/folders/329d3711-3c38-4391-8920-c35478e2456b/members/@new/name?value={newname}&type={newtype}",
300              "uri": "/folders/commons/validations/folders/329d3711-3c38-4391-8920-c35478e2456b/members/@new/name?value={newname}&type={newtype}",
301              "type": "application/vnd.sas.validation"
302            },
303            {
304              "method": "GET",
305              "rel": "transferExport",
306              "href": "/folders/folders/329d3711-3c38-4391-8920-c35478e2456b",
307              "uri": "/folders/folders/329d3711-3c38-4391-8920-c35478e2456b",
308              "responseType": "application/vnd.sas.transfer.object"
309            },
310            {
311              "method": "PUT",
312              "rel": "transferImportUpdate",
313              "href": "/folders/folders/329d3711-3c38-4391-8920-c35478e2456b",
314              "uri": "/folders/folders/329d3711-3c38-4391-8920-c35478e2456b",
315              "type": "application/vnd.sas.transfer.object",
316              "responseType": "application/vnd.sas.summary"
317            },
318            {
319              "method": "POST",
320              "rel": "transferImport",
321              "href": "/folders/folders",
322              "uri": "/folders/folders",
323              "type": "application/vnd.sas.transfer.object",
324              "responseType": "application/vnd.sas.summary"
325            }
326          ]
327        }
328      ],
329      "version": 1
330    }
331  ],
332  "links": [
333    {
334      "method": "GET",
335      "rel": "self",
336      "href": "/folders/folders?start=0&limit=10",
337      "uri": "/folders/folders?start=0&limit=10",
338      "type": "application/vnd.sas.collection",
339      "itemType": "application/vnd.sas.content.folder.ancestor"
340    },
341    {
342      "method": "POST",
343      "rel": "create",
344      "href": "/folders/folders",
345      "uri": "/folders/folders",
346      "type": "application/vnd.sas.content.folder.ancestor",
347      "responseType": "application/vnd.sas.content.folder.ancestor"
348    }
349  ]
350}

Query Parameters

Name	Type	Required	Description
allowPartialPath	boolean	false	Allow a partial path from the item if the user does not have access to all the folders in the path.

Request Body

The list of URIs for which to retrieve ancestry.

Responses

Status	Meaning	Description
200	OK	The ancestors for each URI was returned.		Schema
400	Bad Request	The request was invalid. The body was malformed or is missing.		Schema