Get Simple Dependencies
Get simple dependencies
Resource Information
This service uses the tomcat application on port 8080 by default. To see a list of default ports click here
The context for this API is /studio
, please prefix the API URLs with this context.
HTTP Verb
|
POST
|
URL
|
/api/1/services/api/1/dependency/get-simple-dependencies.json |
Response Formats
|
JSON |
Required Role
|
N/A
|
Parameters
Name
|
Type
|
Required
|
Description
|
---|---|---|---|
site_id
|
String
|
✓
|
Site to use
|
path
|
String
|
✓
|
Path of the content
|
Example
POST ../api/1/services/api/1/dependency/get-simple-dependencies.json?site_id=mysite&path=/site/website/index.xml
Response
1[
2 {
3 "name" : "sapien-veroeros.xml",
4 "internalName" : "Three",
5 "contentType" : "/component/feature",
6 "uri" : "/site/components/features/sapien-veroeros.xml",
7 "path" : "/site/components/features",
8 "browserUri" : "/site/components/features/sapien-veroeros.xml",
9 "navigation" : false,
10 "floating" : true,
11 "hideInAuthoring" : false,
12 "previewable" : false,
13 "lockOwner" : "",
14 "user" : "",
15 "userFirstName":"",
16 "userLastName" : "",
17 "nodeRef" : null,
18 "metaDescription" : null,
19 "site" : "mysite",
20 "page" : false,
21 "component" : true,
22 "document" : false,
23 "asset" : false,
24 "isContainer" : false,
25 "container" : false,
26 "disabled" : false,
27 "savedAsDraft" : false,
28 "submitted" : false,
29 "submittedForDeletion" : false,
30 "scheduled" : false,
31 "published" : false,
32 "deleted" : false,
33 "inProgress" : false,
34 "live" : true,
35 "inFlight" : false,
36 "isDisabled" : false,
37 "isSavedAsDraft" : false,
38 "isInProgress" : false,
39 "isLive" : true,
40 "isSubmittedForDeletion" : false,
41 "isScheduled" : false,
42 "isPublished" : false,
43 "isNavigation" : false,
44 "isDeleted" : false,
45 "isNew" : false,
46 "isSubmitted" : false,
47 "isFloating" : false,
48 "isPage" : false,
49 "isPreviewable" : false,
50 "isComponent" : true,
51 "isDocument" : false,
52 "isAsset" : false,
53 "isInFlight" : false,
54 "eventDate" : null,
55 "endpoint" : null,
56 "timezone" : null,
57 "numOfChildren" : 0,
58 "scheduledDate" : null,
59 "publishedDate" : null,
60 "mandatoryParent" : null,
61 "isLevelDescriptor" : false,
62 "categoryRoot" : null,
63 "lastEditDate" : null,
64 "form" : "/component/feature",
65 "formPagePath" : "simple",
66 "renderingTemplates" : [
67 {
68 "uri" : "/templates/web/components/feature.ftl",
69 "name" : "DEFAULT"
70 }
71 ],
72 "folder" : false,
73 "submissionComment" : null,
74 "components" : null,
75 "documents" : null,
76 "levelDescriptors" : null,
77 "pages" : null,
78 "parentPath" : null,
79 "orders" : [],
80 "children" : [],
81 "size" : 0.0,
82 "sizeUnit" : null,
83 "mimeType" : "application/xml",
84 "reference" : false,
85 "new" : false,
86 "levelDescriptor" : false,
87 "newFile":false
88 },
89 {
90 "name" : "left-rail-with-latest-articles.xml",
91 "internalName" : "Left Rail with Latest Articles",
92 "contentType" : "/component/left-rail",
93 "uri" : "/site/components/left-rails/left-rail-with-latest-articles.xml",
94 "path" : "/site/components/left-rails",
95 "browserUri" : "/site/components/left-rails/left-rail-with-latest-articles.xml",
96 "navigation" : false,
97 "floating" : true,
98 "hideInAuthoring" : false,
99 "previewable" : false,
100 "lockOwner" : "",
101 "user" : "",
102 "userFirstName" : "",
103 "userLastName" : "",
104 "nodeRef" : null,
105 "metaDescription" : null,
106 "site" : "mysite",
107 "page" : false,
108 "component" : true,
109 "document" : false,
110 "asset" : false,
111 "isContainer" : false,
112 "container" : false,
113 "disabled" : false,
114 "savedAsDraft" : false,
115 "submitted" : false,
116 "submittedForDeletion" : false,
117 "scheduled" : false,
118 "published" : false,
119 "deleted" : false,
120 "inProgress" : false,
121 "live" : true,
122 "inFlight" : false,
123 "isDisabled" : false,
124 "isSavedAsDraft" : false,
125 "isInProgress" : false,
126 "isLive" : true,
127 "isSubmittedForDeletion" : false,
128 "isScheduled" : false,
129 "isPublished" : false,
130 "isNavigation" : false,
131 "isDeleted" : false,
132 "isNew" : false,
133 "isSubmitted" : false,
134 "isFloating" : false,
135 "isPage" : false,
136 "isPreviewable" : false,
137 "isComponent" : true,
138 "isDocument" : false,
139 "isAsset" : false,
140 "isInFlight" : false,
141 "eventDate" : null,
142 "endpoint" : null,
143 "timezone" : null,
144 "numOfChildren" : 0,
145 "scheduledDate" : null,
146 "publishedDate" : null,
147 "mandatoryParent" : null,
148 "isLevelDescriptor" : false,
149 "categoryRoot" : null,
150 "lastEditDate" : null,
151 "form" : "/component/left-rail",
152 "formPagePath" : "simple",
153 "renderingTemplates" : [
154 {
155 "uri" : "/templates/web/components/left-rail.ftl",
156 "name" : "DEFAULT"
157 }
158 ],
159 "folder" : false,
160 "submissionComment" : null,
161 "components" : null,
162 "documents" : null,
163 "levelDescriptors" : null,
164 "pages" : null,
165 "parentPath" : null,
166 "orders" : [],
167 "children" : [],
168 "size" : 0.0,
169 "sizeUnit" : null,
170 "mimeType" : "application/xml",
171 "reference" : false,
172 "new" : false,
173 "levelDescriptor" : false,
174 "newFile" : false
175 },
176 {
177 "name" : "strawberries.jpg",
178 "internalName" : "strawberries.jpg",
179 "contentType" : "asset",
180 "uri" : "/static-assets/images/strawberries.jpg",
181 "path" : "/static-assets/images",
182 "browserUri" : "/static-assets/images/strawberries.jpg",
183 "navigation" : false,
184 "floating" : false,
185 "hideInAuthoring" : false,
186 "previewable" : true,
187 "lockOwner" : "",
188 "user" : "",
189 "userFirstName" : "",
190 "userLastName" : "",
191 "nodeRef" : null,
192 "metaDescription" : null,
193 "site" : "mysite",
194 "page" : false,
195 "component" : true,
196 "document" : false,
197 "asset" : true,
198 "isContainer" : false,
199 "container" : false,
200 "disabled" : false,
201 "savedAsDraft" : false,
202 "submitted" : false,
203 "submittedForDeletion" : false,
204 "scheduled" : false,
205 "published" : false,
206 "deleted" : false,
207 "inProgress" : false,
208 "live" : true,
209 "inFlight" : false,
210 "isDisabled" : false,
211 "isSavedAsDraft" : false,
212 "isInProgress" : false,
213 "isLive" : true,
214 "isSubmittedForDeletion" : false,
215 "isScheduled" : false,
216 "isPublished" : false,
217 "isNavigation" : false,
218 "isDeleted" : false,
219 "isNew" : false,
220 "isSubmitted" : false,
221 "isFloating" : false,
222 "isPage" : false,
223 "isPreviewable" : true,
224 "isComponent" : true,
225 "isDocument" : false,
226 "isAsset" : true,
227 "isInFlight" : false,
228 "eventDate" : null,
229 "endpoint" : null,
230 "timezone" : null,
231 "numOfChildren" : 0,
232 "scheduledDate" : null,
233 "publishedDate" : null,
234 "mandatoryParent" : null,
235 "isLevelDescriptor" : false,
236 "categoryRoot" : null,
237 "lastEditDate" : null,
238 "form" : null,
239 "formPagePath" : null,
240 "renderingTemplates" : [],
241 "folder" : false,
242 "submissionComment" : null,
243 "components" : null,
244 "documents" : null,
245 "levelDescriptors" : null,
246 "pages" : null,
247 "parentPath" : null,
248 "orders" : null,
249 "children" : [],
250 "size" : 0.0,
251 "sizeUnit" : null,
252 "mimeType" : "image/jpeg",
253 "reference" : false,
254 "new" : false,
255 "levelDescriptor" : false,
256 "newFile" : false
257 },
258 {
259 "name" : "home.ftl",
260 "internalName" : "home.ftl",
261 "contentType" : "renderingTemplate",
262 "uri" : "/templates/web/pages/home.ftl",
263 "path" : "/templates/web/pages",
264 "browserUri" : "/templates/web/pages/home.ftl",
265 "navigation" : false,
266 "floating" : false,
267 "hideInAuthoring" : false,
268 "previewable" : false,
269 "lockOwner" : "",
270 "user" : "admin",
271 "userFirstName" : "admin",
272 "userLastName" : "",
273 "nodeRef" : null,
274 "metaDescription" : null,
275 "site" : "mysite",
276 "page" : false,
277 "component" : true,
278 "document" : false,
279 "asset" : true,
280 "isContainer" : false,
281 "container" : false,
282 "disabled" : false,
283 "savedAsDraft" : false,
284 "submitted" : false,
285 "submittedForDeletion" : false,
286 "scheduled" : false,
287 "published" : false,
288 "deleted" : false,
289 "inProgress" : true,
290 "live" : false,
291 "inFlight" : false,
292 "isDisabled" : false,
293 "isSavedAsDraft" : false,
294 "isInProgress" : true,
295 "isLive" : false,
296 "isSubmittedForDeletion" : false,
297 "isScheduled" : false,
298 "isPublished" : false,
299 "isNavigation" : false,
300 "isDeleted" : false,
301 "isNew" : false,
302 "isSubmitted" : false,
303 "isFloating" : false,
304 "isPage" : false,
305 "isPreviewable" : false,
306 "isComponent" : true,
307 "isDocument" : false,
308 "isAsset" : true,
309 "isInFlight" : false,
310 "eventDate" : "2017-12-22T22:45:19Z",
311 "endpoint" : null,
312 "timezone" : null,
313 "numOfChildren" : 0,
314 "scheduledDate" : null,
315 "publishedDate" : null,
316 "mandatoryParent" : null,
317 "isLevelDescriptor" : false,
318 "categoryRoot" : null,
319 "lastEditDate" : "2017-12-22T22:45:19Z",
320 "form" : null,
321 "formPagePath" : null,
322 "renderingTemplates" : [],
323 "folder" : false,
324 "submissionComment" : null,
325 "components" : null,
326 "documents" : null,
327 "levelDescriptors" : null,
328 "pages" : null,
329 "parentPath" : null,
330 "orders" : null,
331 "children" : [],
332 "size" : 0.0,
333 "sizeUnit" : null,
334 "mimeType" : "text/x-freemarker",
335 "reference" : false,
336 "new" : false,
337 "levelDescriptor" : false,
338 "newFile" : false
339 },
340 {
341 "name" : "quam-lorem-ipsum.xml",
342 "internalName" : "Two",
343 "contentType" : "/component/feature",
344 "uri" : "/site/components/features/quam-lorem-ipsum.xml",
345 "path" : "/site/components/features",
346 "browserUri" : "/site/components/features/quam-lorem-ipsum.xml",
347 "navigation" : false,
348 "floating" : true,
349 "hideInAuthoring" : false,
350 "previewable" : false,
351 "lockOwner" : "",
352 "user" : "",
353 "userFirstName" : "",
354 "userLastName" : "",
355 "nodeRef" : null,
356 "metaDescription" : null,
357 "site" : "mysite",
358 "page" : false,
359 "component" : true,
360 "document" : false,
361 "asset" : false,
362 "isContainer" : false,
363 "container" : false,
364 "disabled" : false,
365 "savedAsDraft" : false,
366 "submitted" : false,
367 "submittedForDeletion" : false,
368 "scheduled" : false,
369 "published" : false,
370 "deleted" : false,
371 "inProgress" : false,
372 "live" : true,
373 "inFlight" : false,
374 "isDisabled" : false,
375 "isSavedAsDraft" : false,
376 "isInProgress" : false,
377 "isLive" : true,
378 "isSubmittedForDeletion" : false,
379 "isScheduled" : false,
380 "isPublished" : false,
381 "isNavigation" : false,
382 "isDeleted" : false,
383 "isNew" : false,
384 "isSubmitted" : false,
385 "isFloating" : false,
386 "isPage" : false,
387 "isPreviewable" : false,
388 "isComponent" : true,
389 "isDocument" : false,
390 "isAsset" : false,
391 "isInFlight" : false,
392 "eventDate" : null,
393 "endpoint" : null,
394 "timezone" : null,
395 "numOfChildren" : 0,
396 "scheduledDate" : null,
397 "publishedDate" : null,
398 "mandatoryParent" : null,
399 "isLevelDescriptor" : false,
400 "categoryRoot" : null,
401 "lastEditDate" : null,
402 "form" : "/component/feature",
403 "formPagePath" : "simple",
404 "renderingTemplates" : [
405 {
406 "uri" : "/templates/web/components/feature.ftl",
407 "name" : "DEFAULT"
408 }
409 ],
410 "folder" : false,
411 "submissionComment" : null,
412 "components" : null,
413 "documents" : null,
414 "levelDescriptors" : null,
415 "pages" : null,
416 "parentPath" : null,
417 "orders" : [],
418 "children" : [],
419 "size" : 0.0,
420 "sizeUnit" : null,
421 "mimeType" : "application/xml",
422 "reference" : false,
423 "new" : false,
424 "levelDescriptor" : false,
425 "newFile" : false
426 },
427 {
428 "name" : "home.groovy",
429 "internalName" : "home.groovy",
430 "contentType" : "unknown",
431 "uri" : "/scripts/pages/home.groovy",
432 "path" : "/scripts/pages",
433 "browserUri" : "/scripts/pages/home.groovy",
434 "navigation" : false,
435 "floating" : false,
436 "hideInAuthoring" : false,
437 "previewable" : false,
438 "lockOwner" : "",
439 "user" : "",
440 "userFirstName" : "",
441 "userLastName" : "",
442 "nodeRef" : null,
443 "metaDescription" : null,
444 "site" : "mysite",
445 "page" : false,
446 "component" : true,
447 "document" : false,
448 "asset" : true,
449 "isContainer" : false,
450 "container" : false,
451 "disabled" : false,
452 "savedAsDraft" : false,
453 "submitted" : false,
454 "submittedForDeletion" : false,
455 "scheduled" : false,
456 "published" : false,
457 "deleted" : false,
458 "inProgress" : false,
459 "live" : true,
460 "inFlight" : false,
461 "isDisabled" : false,
462 "isSavedAsDraft" : false,
463 "isInProgress" : false,
464 "isLive" : true,
465 "isSubmittedForDeletion" : false,
466 "isScheduled" : false,
467 "isPublished" : false,
468 "isNavigation" : false,
469 "isDeleted" : false,
470 "isNew" : false,
471 "isSubmitted" : false,
472 "isFloating" : false,
473 "isPage" : false,
474 "isPreviewable" : false,
475 "isComponent" : true,
476 "isDocument" : false,
477 "isAsset" : true,
478 "isInFlight" : false,
479 "eventDate" : null,
480 "endpoint" : null,
481 "timezone" : null,
482 "numOfChildren" : 0,
483 "scheduledDate" : null,
484 "publishedDate" : null,
485 "mandatoryParent" : null,
486 "isLevelDescriptor" : false,
487 "categoryRoot" : null,
488 "lastEditDate" : null,
489 "form" : null,
490 "formPagePath" : null,
491 "renderingTemplates" : [],
492 "folder" : false,
493 "submissionComment" : null,
494 "components" : null,
495 "documents" : null,
496 "levelDescriptors" : null,
497 "pages" : null,
498 "parentPath" : null,
499 "orders" : null,
500 "children" : [],
501 "size" : 0.0,
502 "sizeUnit" : null,
503 "mimeType" : "text/x-groovy",
504 "reference" : false,
505 "new" : false,
506 "levelDescriptor" : false,
507 "newFile" : false
508 }
509]
Status
|
Location
|
Response Body
|
---|---|---|
200
|
See example above.
|