Get Children
Get the list of Items directly under a folder in the content store.
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 /.
HTTP Verb
|
GET
|
URL
|
/api/1/content_store/children |
Response Formats
|
JSON, XML |
Parameters
Name
|
Type
|
Required
|
Description
|
|---|---|---|---|
contextId
|
String
|
✓
|
The context id
|
url
|
String
|
✓
|
The folder’s url (e.g. /site/website)
|
Example
Request
GET .../api/1/content_store/children.json?contextId=405ffc233d075b010536bd2eb786b86c&url=/site/website
Response
Status 200 OK
1[
2 {
3 "name": "articles",
4 "url": "/site/website/articles",
5 "descriptorUrl": "/site/website/articles.meta.xml",
6 "descriptorDom": null,
7 "properties": null,
8 "folder": true
9 },
10 {
11 "name": "crafter-component.xml",
12 "url": "/site/website/crafter-component.xml",
13 "descriptorUrl": "/site/website/crafter-component.xml",
14 "descriptorDom": {
15 "page": {
16 "display-template": {
17 "nil": "false",
18 "text": "/templates/system/common/component.ftl"
19 },
20 "merge-strategy": "inherit-levels",
21 "content-type": "/component/level-descriptor",
22 "placeInNav": "false",
23 "file-name": "crafter-level-descriptor.level.xml",
24 "objectGroupId": "0a68",
25 "objectId": "0a68e8ad-77d8-0a58-e7bf-09a71fb3077b",
26 "folder-name": null,
27 "header": {
28 "item": {
29 "key": "/site/components/headers/header.xml",
30 "value": "Header",
31 "include": "/site/components/headers/header.xml",
32 "disableFlattening": "false"
33 }
34 },
35 "createdDate": "3/13/2017 20:26:50",
36 "createdDate_dt": "3/13/2017 20:26:50",
37 "lastModifiedDate": "5/18/2017 15:38:58",
38 "lastModifiedDate_dt": "5/18/2017 15:38:58",
39 "left-rail": {
40 "item": {
41 "key": "/site/components/left-rails/left-rail-with-no-articles.xml",
42 "value": "Left Rail with No Articles",
43 "include": "/site/components/left-rails/left-rail-with-no-articles.xml",
44 "disableFlattening": "false"
45 }
46 },
47 "hideInAuthoring": "true"
48 }
49 },
50 "properties": null,
51 "folder": false
52 },
53 {
54 "name": "crafter-level-descriptor.level.xml",
55 "url": "/site/website/crafter-level-descriptor.level.xml",
56 "descriptorUrl": "/site/website/crafter-level-descriptor.level.xml",
57 "descriptorDom": {
58 "component": {
59 "content-type": "/component/level-descriptor",
60 "display-template": null,
61 "merge-strategy": "inherit-levels",
62 "placeInNav": "false",
63 "file-name": "crafter-level-descriptor.level.xml",
64 "objectGroupId": "0a68",
65 "objectId": "0a68e8ad-77d8-0a58-e7bf-09a71fb3077b",
66 "folder-name": null,
67 "header": {
68 "item": {
69 "key": "/site/components/headers/header.xml",
70 "value": "Header",
71 "include": "/site/components/headers/header.xml",
72 "disableFlattening": "false"
73 }
74 },
75 "createdDate": "3/13/2017 20:26:50",
76 "createdDate_dt": "3/13/2017 20:26:50",
77 "lastModifiedDate": "5/18/2017 15:38:58",
78 "lastModifiedDate_dt": "5/18/2017 15:38:58",
79 "left-rail": {
80 "item": {
81 "key": "/site/components/left-rails/left-rail-with-no-articles.xml",
82 "value": "Left Rail with No Articles",
83 "include": "/site/components/left-rails/left-rail-with-no-articles.xml",
84 "disableFlattening": "false"
85 }
86 }
87 }
88 },
89 "properties": null,
90 "folder": false
91 },
92 {
93 "name": "entertainment",
94 "url": "/site/website/entertainment",
95 "descriptorUrl": "/site/website/entertainment.meta.xml",
96 "descriptorDom": null,
97 "properties": null,
98 "folder": true
99 },
100 {
101 "name": "health",
102 "url": "/site/website/health",
103 "descriptorUrl": "/site/website/health.meta.xml",
104 "descriptorDom": null,
105 "properties": null,
106 "folder": true
107 },
108 {
109 "name": "index.xml",
110 "url": "/site/website/index.xml",
111 "descriptorUrl": "/site/website/index.xml",
112 "descriptorDom": {
113 "page": {
114 "content-type": "/page/home",
115 "display-template": "/templates/web/pages/home.ftl",
116 "merge-strategy": "inherit-levels",
117 "placeInNav": "false",
118 "file-name": "index.xml",
119 "objectGroupId": "8d7f",
120 "objectId": "8d7f21fa-5e09-00aa-8340-853b7db302da",
121 "folder-name": null,
122 "header": {
123 "item": {
124 "key": "/site/components/headers/header.xml",
125 "value": "Header",
126 "include": "/site/components/headers/header.xml",
127 "disableFlattening": "false"
128 }
129 },
130 "createdDate": "1/31/2017 16:18:14",
131 "createdDate_dt": "1/31/2017 16:18:14",
132 "lastModifiedDate": "5/18/2017 15:52:21",
133 "lastModifiedDate_dt": "5/18/2017 15:52:21",
134 "left-rail": {
135 "item": {
136 "key": "/site/components/left-rails/left-rail-with-latest-articles.xml",
137 "value": "Left Rail with Latest Articles",
138 "include": "/site/components/left-rails/left-rail-with-latest-articles.xml",
139 "disableFlattening": "false"
140 }
141 },
142 "internal-name": "Home",
143 "orderDefault_f": "-1",
144 "title": "Editorial",
145 "hero_text": "<p>Aenean ornare velit lacus, ac varius enim ullamcorper eu. Proin aliquam facilisis ante interdum congue. Integer mollis, nisl amet convallis, porttitor magna ullamcorper, amet egestas mauris. Ut magna finibus nisi nec lacinia. Nam maximus erat id euismod egestas. Pellentesque sapien ac quam. Lorem ipsum dolor sit nullam.</p>",
146 "hero_title": "<h1><span>Hi, I’m Editorial</span></h1>\n<h3><span style=\"font-size: 1.5em;\">by HTML5 UP</span></h3>",
147 "features": {
148 "item": [
149 {
150 "value": "Quam lorem ipsum",
151 "key": "/site/components/features/quam-lorem-ipsum.xml",
152 "include": "/site/components/features/quam-lorem-ipsum.xml",
153 "disableFlattening": "false"
154 },
155 {
156 "key": "/site/components/features/sapien-veroeros.xml",
157 "value": "Sapien Veroeros",
158 "include": "/site/components/features/sapien-veroeros.xml",
159 "disableFlattening": "false"
160 }
161 ]
162 },
163 "hero_image": "/static-assets/images/strawberries.jpg",
164 "features_title": "Erat lacinia"
165 }
166 },
167 "properties": null,
168 "folder": false
169 },
170 {
171 "name": "search-results",
172 "url": "/site/website/search-results",
173 "descriptorUrl": "/site/website/search-results.meta.xml",
174 "descriptorDom": null,
175 "properties": null,
176 "folder": true
177 },
178 {
179 "name": "style",
180 "url": "/site/website/style",
181 "descriptorUrl": "/site/website/style.meta.xml",
182 "descriptorDom": null,
183 "properties": null,
184 "folder": true
185 },
186 {
187 "name": "technology",
188 "url": "/site/website/technology",
189 "descriptorUrl": "/site/website/technology.meta.xml",
190 "descriptorDom": null,
191 "properties": null,
192 "folder": true
193 }
194]
Responses
Status
|
Location
|
Response Body
|
|---|---|---|
200
|
See example above.
|
|
404
|
"No folder found at /site/website" |
|
500
|
"Internal server error" |