Get Pages
Get pages. Gets tree of content items for given path.
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
|
GET
|
URL
|
/api/1/services/api/1/content/get-pages.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
|
depth
|
Integer
|
✓
|
Depth of the tree to display
|
order
|
String
|
✓
|
Order of content items
|
Example
Request
GET .../api/1/services/api/1/content/get-pages.json?site_id=mysite&path=/site/website/index.xml&depth=1&order=default
Response
Status 200 OK
1{
2 "item":
3 {
4 "name": "index.xml",
5 "internalName": "Home",
6 "contentType": "/page/home",
7 "uri": "/site/website/index.xml",
8 "path": "/site/website",
9 "browserUri": "",
10 "navigation": false,
11 "floating": true,
12 "hideInAuthoring": false,
13 "previewable": true,
14 "lockOwner": "",
15 "user": "admin",
16 "userFirstName": "admin",
17 "userLastName": "",
18 "nodeRef": null,
19 "metaDescription": null,
20 "site": "documentation",
21 "page": true,
22 "component": false,
23 "document": false,
24 "asset": false,
25 "isContainer": true,
26 "container": true,
27 "disabled": false,
28 "savedAsDraft": false,
29 "submitted": false,
30 "submittedForDeletion": false,
31 "scheduled": false,
32 "published": false,
33 "deleted": false,
34 "inProgress": true,
35 "live": false,
36 "inFlight": false,
37 "isDisabled": false,
38 "isSavedAsDraft": false,
39 "isInProgress": true,
40 "isLive": false,
41 "isSubmittedForDeletion": false,
42 "isScheduled": false,
43 "isPublished": false,
44 "isNavigation": false,
45 "isDeleted": false,
46 "isNew": false,
47 "isSubmitted": false,
48 "isFloating": false,
49 "isPage": true,
50 "isPreviewable": true,
51 "isComponent": false,
52 "isDocument": false,
53 "isAsset": false,
54 "isInFlight": false,
55 "eventDate": "2017-07-05T21:32:02+02:00",
56 "endpoint": null,
57 "timezone": null,
58 "numOfChildren": 8,
59 "scheduledDate": null,
60 "publishedDate": null,
61 "mandatoryParent": null,
62 "isLevelDescriptor": false,
63 "categoryRoot": null,
64 "lastEditDate": "2017-07-05T21:32:02+02:00",
65 "form": "/page/home",
66 "formPagePath": "simple",
67 "renderingTemplates":
68 [
69 {
70 "uri": "/templates/web/pages/home.ftl",
71 "name": "DEFAULT"
72 }
73 ],
74 "folder": false,
75 "submissionComment": null,
76 "components": null,
77 "documents": null,
78 "levelDescriptors": null,
79 "pages": null,
80 "parentPath": null,
81 "orders":
82 [
83 {
84 "name": null,
85 "id": "default",
86 "disabled": null,
87 "placeInNav": null,
88 "order": -1
89 }
90 ],
91 "children":
92 [
93 {
94 "name": "crafter-level-descriptor.level.xml",
95 "internalName": "",
96 "contentType": "/component/level-descriptor",
97 "uri": "/site/website/crafter-level-descriptor.level.xml",
98 "path": "/site/website",
99 "browserUri": "/crafter-level-descriptor.level.xml",
100 "navigation": false,
101 "floating": true,
102 "hideInAuthoring": false,
103 "previewable": false,
104 "lockOwner": "",
105 "user": "",
106 "userFirstName": "",
107 "userLastName": "",
108 "nodeRef": null,
109 "metaDescription": null,
110 "site": "documentation",
111 "page": true,
112 "component": true,
113 "document": false,
114 "asset": false,
115 "isContainer": false,
116 "container": false,
117 "disabled": false,
118 "savedAsDraft": false,
119 "submitted": false,
120 "submittedForDeletion": false,
121 "scheduled": false,
122 "published": false,
123 "deleted": false,
124 "inProgress": false,
125 "live": true,
126 "inFlight": false,
127 "isDisabled": false,
128 "isSavedAsDraft": false,
129 "isInProgress": false,
130 "isLive": true,
131 "isSubmittedForDeletion": false,
132 "isScheduled": false,
133 "isPublished": false,
134 "isNavigation": false,
135 "isDeleted": false,
136 "isNew": false,
137 "isSubmitted": false,
138 "isFloating": false,
139 "isPage": true,
140 "isPreviewable": false,
141 "isComponent": true,
142 "isDocument": false,
143 "isAsset": false,
144 "isInFlight": false,
145 "eventDate": null,
146 "endpoint": null,
147 "timezone": null,
148 "numOfChildren": 0,
149 "scheduledDate": null,
150 "publishedDate": null,
151 "mandatoryParent": null,
152 "isLevelDescriptor": true,
153 "categoryRoot": null,
154 "lastEditDate": null,
155 "form": "/component/level-descriptor",
156 "formPagePath": "simple",
157 "renderingTemplates":
158 [
159 {
160 "uri": "",
161 "name": "DEFAULT"
162 }
163 ],
164 "folder": false,
165 "submissionComment": null,
166 "components": null,
167 "documents": null,
168 "levelDescriptors": null,
169 "pages": null,
170 "parentPath": null,
171 "orders": [ ],
172 "children": [ ],
173 "size": 0,
174 "sizeUnit": null,
175 "mimeType": "application/xml",
176 "levelDescriptor": true,
177 "newFile": false,
178 "reference": false,
179 "new": false
180 },
181 {
182 "name": "index.xml",
183 "internalName": "Style",
184 "contentType": "/page/category-landing",
185 "uri": "/site/website/style/index.xml",
186 "path": "/site/website/style",
187 "browserUri": "/style",
188 "navigation": true,
189 "floating": false,
190 "hideInAuthoring": false,
191 "previewable": true,
192 "lockOwner": "",
193 "user": "",
194 "userFirstName": "",
195 "userLastName": "",
196 "nodeRef": null,
197 "metaDescription": null,
198 "site": "documentation",
199 "page": true,
200 "component": false,
201 "document": false,
202 "asset": false,
203 "isContainer": true,
204 "container": true,
205 "disabled": false,
206 "savedAsDraft": false,
207 "submitted": false,
208 "submittedForDeletion": false,
209 "scheduled": false,
210 "published": false,
211 "deleted": false,
212 "inProgress": false,
213 "live": true,
214 "inFlight": false,
215 "isDisabled": false,
216 "isSavedAsDraft": false,
217 "isInProgress": false,
218 "isLive": true,
219 "isSubmittedForDeletion": false,
220 "isScheduled": false,
221 "isPublished": false,
222 "isNavigation": false,
223 "isDeleted": false,
224 "isNew": false,
225 "isSubmitted": false,
226 "isFloating": false,
227 "isPage": true,
228 "isPreviewable": true,
229 "isComponent": false,
230 "isDocument": false,
231 "isAsset": false,
232 "isInFlight": false,
233 "eventDate": null,
234 "endpoint": null,
235 "timezone": null,
236 "numOfChildren": 0,
237 "scheduledDate": null,
238 "publishedDate": null,
239 "mandatoryParent": null,
240 "isLevelDescriptor": false,
241 "categoryRoot": null,
242 "lastEditDate": null,
243 "form": "/page/category-landing",
244 "formPagePath": "simple",
245 "renderingTemplates":
246 [
247 {
248 "uri": "/templates/web/pages/category-landing.ftl",
249 "name": "DEFAULT"
250 }
251 ],
252 "folder": false,
253 "submissionComment": null,
254 "components": null,
255 "documents": null,
256 "levelDescriptors": null,
257 "pages": null,
258 "parentPath": null,
259 "orders":
260 [
261 {
262 "name": null,
263 "id": "default",
264 "disabled": null,
265 "placeInNav": null,
266 "order": 8000
267 }
268 ],
269 "children": [ ],
270 "size": 0,
271 "sizeUnit": null,
272 "mimeType": "application/xml",
273 "levelDescriptor": false,
274 "newFile": false,
275 "reference": false,
276 "new": false
277 },
278 {
279 "name": "index.xml",
280 "internalName": "Health",
281 "contentType": "/page/category-landing",
282 "uri": "/site/website/health/index.xml",
283 "path": "/site/website/health",
284 "browserUri": "/health",
285 "navigation": true,
286 "floating": false,
287 "hideInAuthoring": false,
288 "previewable": true,
289 "lockOwner": "",
290 "user": "",
291 "userFirstName": "",
292 "userLastName": "",
293 "nodeRef": null,
294 "metaDescription": null,
295 "site": "documentation",
296 "page": true,
297 "component": false,
298 "document": false,
299 "asset": false,
300 "isContainer": true,
301 "container": true,
302 "disabled": false,
303 "savedAsDraft": false,
304 "submitted": false,
305 "submittedForDeletion": false,
306 "scheduled": false,
307 "published": false,
308 "deleted": false,
309 "inProgress": false,
310 "live": true,
311 "inFlight": false,
312 "isDisabled": false,
313 "isSavedAsDraft": false,
314 "isInProgress": false,
315 "isLive": true,
316 "isSubmittedForDeletion": false,
317 "isScheduled": false,
318 "isPublished": false,
319 "isNavigation": false,
320 "isDeleted": false,
321 "isNew": false,
322 "isSubmitted": false,
323 "isFloating": false,
324 "isPage": true,
325 "isPreviewable": true,
326 "isComponent": false,
327 "isDocument": false,
328 "isAsset": false,
329 "isInFlight": false,
330 "eventDate": null,
331 "endpoint": null,
332 "timezone": null,
333 "numOfChildren": 0,
334 "scheduledDate": null,
335 "publishedDate": null,
336 "mandatoryParent": null,
337 "isLevelDescriptor": false,
338 "categoryRoot": null,
339 "lastEditDate": null,
340 "form": "/page/category-landing",
341 "formPagePath": "simple",
342 "renderingTemplates":
343 [
344 {
345 "uri": "/templates/web/pages/category-landing.ftl",
346 "name": "DEFAULT"
347 }
348 ],
349 "folder": false,
350 "submissionComment": null,
351 "components": null,
352 "documents": null,
353 "levelDescriptors": null,
354 "pages": null,
355 "parentPath": null,
356 "orders":
357 [
358 {
359 "name": null,
360 "id": "default",
361 "disabled": null,
362 "placeInNav": null,
363 "order": 9000
364 }
365 ],
366 "children": [ ],
367 "size": 0,
368 "sizeUnit": null,
369 "mimeType": "application/xml",
370 "levelDescriptor": false,
371 "newFile": false,
372 "reference": false,
373 "new": false
374 },
375 {
376 "name": "index.xml",
377 "internalName": "Entertainment",
378 "contentType": "/page/category-landing",
379 "uri": "/site/website/entertainment/index.xml",
380 "path": "/site/website/entertainment",
381 "browserUri": "/entertainment",
382 "navigation": true,
383 "floating": false,
384 "hideInAuthoring": false,
385 "previewable": true,
386 "lockOwner": "",
387 "user": "",
388 "userFirstName": "",
389 "userLastName": "",
390 "nodeRef": null,
391 "metaDescription": null,
392 "site": "documentation",
393 "page": true,
394 "component": false,
395 "document": false,
396 "asset": false,
397 "isContainer": true,
398 "container": true,
399 "disabled": false,
400 "savedAsDraft": false,
401 "submitted": false,
402 "submittedForDeletion": false,
403 "scheduled": false,
404 "published": false,
405 "deleted": false,
406 "inProgress": false,
407 "live": true,
408 "inFlight": false,
409 "isDisabled": false,
410 "isSavedAsDraft": false,
411 "isInProgress": false,
412 "isLive": true,
413 "isSubmittedForDeletion": false,
414 "isScheduled": false,
415 "isPublished": false,
416 "isNavigation": false,
417 "isDeleted": false,
418 "isNew": false,
419 "isSubmitted": false,
420 "isFloating": false,
421 "isPage": true,
422 "isPreviewable": true,
423 "isComponent": false,
424 "isDocument": false,
425 "isAsset": false,
426 "isInFlight": false,
427 "eventDate": null,
428 "endpoint": null,
429 "timezone": null,
430 "numOfChildren": 0,
431 "scheduledDate": null,
432 "publishedDate": null,
433 "mandatoryParent": null,
434 "isLevelDescriptor": false,
435 "categoryRoot": null,
436 "lastEditDate": null,
437 "form": "/page/category-landing",
438 "formPagePath": "simple",
439 "renderingTemplates":
440 [
441 {
442 "uri": "/templates/web/pages/category-landing.ftl",
443 "name": "DEFAULT"
444 }
445 ],
446 "folder": false,
447 "submissionComment": null,
448 "components": null,
449 "documents": null,
450 "levelDescriptors": null,
451 "pages": null,
452 "parentPath": null,
453 "orders":
454 [
455 {
456 "name": null,
457 "id": "default",
458 "disabled": null,
459 "placeInNav": null,
460 "order": 10000
461 }
462 ],
463 "children": [ ],
464 "size": 0,
465 "sizeUnit": null,
466 "mimeType": "application/xml",
467 "levelDescriptor": false,
468 "newFile": false,
469 "reference": false,
470 "new": false
471 },
472 {
473 "name": "index.xml",
474 "internalName": "Technology",
475 "contentType": "/page/category-landing",
476 "uri": "/site/website/technology/index.xml",
477 "path": "/site/website/technology",
478 "browserUri": "/technology",
479 "navigation": true,
480 "floating": false,
481 "hideInAuthoring": false,
482 "previewable": true,
483 "lockOwner": "",
484 "user": "",
485 "userFirstName": "",
486 "userLastName": "",
487 "nodeRef": null,
488 "metaDescription": null,
489 "site": "documentation",
490 "page": true,
491 "component": false,
492 "document": false,
493 "asset": false,
494 "isContainer": true,
495 "container": true,
496 "disabled": false,
497 "savedAsDraft": false,
498 "submitted": false,
499 "submittedForDeletion": false,
500 "scheduled": false,
501 "published": false,
502 "deleted": false,
503 "inProgress": false,
504 "live": true,
505 "inFlight": false,
506 "isDisabled": false,
507 "isSavedAsDraft": false,
508 "isInProgress": false,
509 "isLive": true,
510 "isSubmittedForDeletion": false,
511 "isScheduled": false,
512 "isPublished": false,
513 "isNavigation": false,
514 "isDeleted": false,
515 "isNew": false,
516 "isSubmitted": false,
517 "isFloating": false,
518 "isPage": true,
519 "isPreviewable": true,
520 "isComponent": false,
521 "isDocument": false,
522 "isAsset": false,
523 "isInFlight": false,
524 "eventDate": null,
525 "endpoint": null,
526 "timezone": null,
527 "numOfChildren": 0,
528 "scheduledDate": null,
529 "publishedDate": null,
530 "mandatoryParent": null,
531 "isLevelDescriptor": false,
532 "categoryRoot": null,
533 "lastEditDate": null,
534 "form": "/page/category-landing",
535 "formPagePath": "simple",
536 "renderingTemplates":
537 [
538 {
539 "uri": "/templates/web/pages/category-landing.ftl",
540 "name": "DEFAULT"
541 }
542 ],
543 "folder": false,
544 "submissionComment": null,
545 "components": null,
546 "documents": null,
547 "levelDescriptors": null,
548 "pages": null,
549 "parentPath": null,
550 "orders":
551 [
552 {
553 "name": null,
554 "id": "default",
555 "disabled": null,
556 "placeInNav": null,
557 "order": 11000
558 }
559 ],
560 "children": [ ],
561 "size": 0,
562 "sizeUnit": null,
563 "mimeType": "application/xml",
564 "levelDescriptor": false,
565 "newFile": false,
566 "reference": false,
567 "new": false
568 },
569 {
570 "name": "crafter-component.xml",
571 "internalName": "",
572 "contentType": "",
573 "uri": "/site/website/crafter-component.xml",
574 "path": "/site/website",
575 "browserUri": "/crafter-component.xml",
576 "navigation": false,
577 "floating": true,
578 "hideInAuthoring": true,
579 "previewable": true,
580 "lockOwner": "",
581 "user": "",
582 "userFirstName": "",
583 "userLastName": "",
584 "nodeRef": null,
585 "metaDescription": null,
586 "site": "documentation",
587 "page": true,
588 "component": false,
589 "document": false,
590 "asset": false,
591 "isContainer": false,
592 "container": false,
593 "disabled": false,
594 "savedAsDraft": false,
595 "submitted": false,
596 "submittedForDeletion": false,
597 "scheduled": false,
598 "published": false,
599 "deleted": false,
600 "inProgress": false,
601 "live": true,
602 "inFlight": false,
603 "isDisabled": false,
604 "isSavedAsDraft": false,
605 "isInProgress": false,
606 "isLive": true,
607 "isSubmittedForDeletion": false,
608 "isScheduled": false,
609 "isPublished": false,
610 "isNavigation": false,
611 "isDeleted": false,
612 "isNew": false,
613 "isSubmitted": false,
614 "isFloating": false,
615 "isPage": true,
616 "isPreviewable": true,
617 "isComponent": false,
618 "isDocument": false,
619 "isAsset": false,
620 "isInFlight": false,
621 "eventDate": null,
622 "endpoint": null,
623 "timezone": null,
624 "numOfChildren": 0,
625 "scheduledDate": null,
626 "publishedDate": null,
627 "mandatoryParent": null,
628 "isLevelDescriptor": false,
629 "categoryRoot": null,
630 "lastEditDate": null,
631 "form": null,
632 "formPagePath": null,
633 "renderingTemplates":
634 [
635 {
636 "uri": "/templates/system/common/component.ftl",
637 "name": "DEFAULT"
638 }
639 ],
640 "folder": false,
641 "submissionComment": null,
642 "components": null,
643 "documents": null,
644 "levelDescriptors": null,
645 "pages": null,
646 "parentPath": null,
647 "orders": [ ],
648 "children": [ ],
649 "size": 0,
650 "sizeUnit": null,
651 "mimeType": "application/xml",
652 "levelDescriptor": false,
653 "newFile": false,
654 "reference": false,
655 "new": false
656 },
657 {
658 "name": "index.xml",
659 "internalName": "Search Results",
660 "contentType": "/page/search-results",
661 "uri": "/site/website/search-results/index.xml",
662 "path": "/site/website/search-results",
663 "browserUri": "/search-results",
664 "navigation": false,
665 "floating": true,
666 "hideInAuthoring": false,
667 "previewable": true,
668 "lockOwner": "",
669 "user": "",
670 "userFirstName": "",
671 "userLastName": "",
672 "nodeRef": null,
673 "metaDescription": null,
674 "site": "documentation",
675 "page": true,
676 "component": false,
677 "document": false,
678 "asset": false,
679 "isContainer": true,
680 "container": true,
681 "disabled": false,
682 "savedAsDraft": false,
683 "submitted": false,
684 "submittedForDeletion": false,
685 "scheduled": false,
686 "published": false,
687 "deleted": false,
688 "inProgress": false,
689 "live": true,
690 "inFlight": false,
691 "isDisabled": false,
692 "isSavedAsDraft": false,
693 "isInProgress": false,
694 "isLive": true,
695 "isSubmittedForDeletion": false,
696 "isScheduled": false,
697 "isPublished": false,
698 "isNavigation": false,
699 "isDeleted": false,
700 "isNew": false,
701 "isSubmitted": false,
702 "isFloating": false,
703 "isPage": true,
704 "isPreviewable": true,
705 "isComponent": false,
706 "isDocument": false,
707 "isAsset": false,
708 "isInFlight": false,
709 "eventDate": null,
710 "endpoint": null,
711 "timezone": null,
712 "numOfChildren": 0,
713 "scheduledDate": null,
714 "publishedDate": null,
715 "mandatoryParent": null,
716 "isLevelDescriptor": false,
717 "categoryRoot": null,
718 "lastEditDate": null,
719 "form": "/page/search-results",
720 "formPagePath": "simple",
721 "renderingTemplates":
722 [
723 {
724 "uri": "/templates/web/pages/search-results.ftl",
725 "name": "DEFAULT"
726 }
727 ],
728 "folder": false,
729 "submissionComment": null,
730 "components": null,
731 "documents": null,
732 "levelDescriptors": null,
733 "pages": null,
734 "parentPath": null,
735 "orders": [],
736 "children": [],
737 "size": 0,
738 "sizeUnit": null,
739 "mimeType": "application/xml",
740 "levelDescriptor": false,
741 "newFile": false,
742 "reference": false,
743 "new": false
744 },
745 {
746 "name": "articles",
747 "internalName": "articles",
748 "contentType": "folder",
749 "uri": "/site/website/articles",
750 "path": "/site/website/articles",
751 "browserUri": "/site/website/articles",
752 "navigation": false,
753 "floating": false,
754 "hideInAuthoring": false,
755 "previewable": false,
756 "lockOwner": "",
757 "user": null,
758 "userFirstName": null,
759 "userLastName": null,
760 "nodeRef": null,
761 "metaDescription": null,
762 "site": "documentation",
763 "page": false,
764 "component": false,
765 "document": false,
766 "asset": false,
767 "isContainer": true,
768 "container": true,
769 "disabled": false,
770 "savedAsDraft": false,
771 "submitted": false,
772 "submittedForDeletion": false,
773 "scheduled": false,
774 "published": false,
775 "deleted": false,
776 "inProgress": true,
777 "live": true,
778 "inFlight": false,
779 "isDisabled": false,
780 "isSavedAsDraft": false,
781 "isInProgress": false,
782 "isLive": true,
783 "isSubmittedForDeletion": false,
784 "isScheduled": false,
785 "isPublished": false,
786 "isNavigation": false,
787 "isDeleted": false,
788 "isNew": false,
789 "isSubmitted": false,
790 "isFloating": false,
791 "isPage": false,
792 "isPreviewable": false,
793 "isComponent": false,
794 "isDocument": false,
795 "isAsset": false,
796 "isInFlight": false,
797 "eventDate": null,
798 "endpoint": null,
799 "timezone": null,
800 "numOfChildren": 3,
801 "scheduledDate": null,
802 "publishedDate": null,
803 "mandatoryParent": null,
804 "isLevelDescriptor": false,
805 "categoryRoot": null,
806 "lastEditDate": null,
807 "form": null,
808 "formPagePath": null,
809 "renderingTemplates": [ ],
810 "folder": true,
811 "submissionComment": null,
812 "components": null,
813 "documents": null,
814 "levelDescriptors": null,
815 "pages": null,
816 "parentPath": null,
817 "orders": null,
818 "children": [ ],
819 "size": 0,
820 "sizeUnit": null,
821 "mimeType": "application/octet-stream",
822 "levelDescriptor": false,
823 "newFile": false,
824 "reference": false,
825 "new": false
826 }
827 ],
828 "size": 0,
829 "sizeUnit": null,
830 "mimeType": "application/xml",
831 "levelDescriptor": false,
832 "newFile": false,
833 "reference": false,
834 "new": false
835 }
836}
Responses
Status
|
Location
|
Response Body
|
|---|---|---|
200
|
See example above.
|