Get Go Live Items
Get items waiting for approval. Optionally, include in-progress items. Note, there can be a significant performance cost to including in-progress items.
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/workflow/get-go-live-items.json |
Response Formats
|
JSON |
Required Role
|
N/A
|
Parameters
Name
|
Type
|
Required
|
Description
|
|---|---|---|---|
site_id
|
String
|
✓
|
Site to use
|
sort
|
String
|
✓
|
Sort results by field
|
ascending
|
Boolean
|
✓
|
Ascending order
|
includeInProgress
|
Boolean
|
✓
|
Include in progress items
|
Example
Request
GET .../api/1/services/api/1/workflow/get-go-live-items.json?site_id=mysite&sort=eventDate&ascending=false
Response
Status 200 OK
1{
2 "sortedBy":"eventDate",
3 "total":1,
4 "documents":
5 [
6 {
7 "name":"Pages",
8 "internalName":"Pages",
9 "contentType":null,
10 "uri":"/site/website",
11 "path":"/site/website",
12 "browserUri":null,
13 "navigation":false,
14 "floating":false,
15 "hideInAuthoring":false,
16 "previewable":false,
17 "lockOwner":null,
18 "user":null,
19 "userFirstName":null,
20 "userLastName":null,
21 "nodeRef":null,
22 "metaDescription":null,
23 "site":null,
24 "page":false,
25 "component":false,
26 "document":false,
27 "asset":false,
28 "isContainer":false,
29 "container":false,
30 "disabled":false,
31 "savedAsDraft":false,
32 "submitted":false,
33 "submittedForDeletion":false,
34 "scheduled":false,
35 "published":false,
36 "deleted":false,
37 "inProgress":false,
38 "live":false,
39 "inFlight":false,
40 "isDisabled":false,
41 "isSavedAsDraft":false,
42 "isInProgress":false,
43 "isLive":false,
44 "isSubmittedForDeletion":false,
45 "isScheduled":false,
46 "isPublished":false,
47 "isNavigation":false,
48 "isDeleted":false,
49 "isNew":false,
50 "isSubmitted":false,
51 "isFloating":false,
52 "isPage":false,
53 "isPreviewable":false,
54 "isComponent":false,
55 "isDocument":false,
56 "isAsset":false,
57 "isInFlight":false,
58 "eventDate":null,
59 "endpoint":null,
60 "timezone":"EST5EDT",
61 "numOfChildren":1,
62 "scheduledDate":null,
63 "publishedDate":null,
64 "mandatoryParent":null,
65 "isLevelDescriptor":false,
66 "categoryRoot":"/site/website",
67 "lastEditDate":null,
68 "form":null,
69 "formPagePath":null,
70 "renderingTemplates":[],
71 "folder":false,
72 "submissionComment":null,
73 "components":null,
74 "documents":null,
75 "levelDescriptors":null,
76 "pages":null,
77 "parentPath":null,
78 "orders":null,
79 "children":
80 [
81 {
82 "name":"index.xml",
83 "internalName":"Home",
84 "contentType":"/page/home",
85 "uri":"/site/website/index.xml",
86 "path":"/site/website",
87 "browserUri":"",
88 "navigation":false,
89 "floating":true,
90 "hideInAuthoring":false,
91 "previewable":true,
92 "lockOwner":"",
93 "user":"test",
94 "userFirstName":"test",
95 "userLastName":"",
96 "nodeRef":null,
97 "metaDescription":null,
98 "site":"mysite",
99 "page":true,
100 "component":false,
101 "document":false,
102 "asset":false,
103 "isContainer":false,
104 "container":false,
105 "disabled":false,
106 "savedAsDraft":false,
107 "submitted":true,
108 "submittedForDeletion":false,
109 "scheduled":false,
110 "published":false,
111 "deleted":false,
112 "inProgress":true,
113 "live":false,
114 "inFlight":false,
115 "isDisabled":false,
116 "isSavedAsDraft":false,
117 "isInProgress":true,
118 "isLive":false,
119 "isSubmittedForDeletion":false,
120 "isScheduled":false,
121 "isPublished":false,
122 "isNavigation":false,
123 "isDeleted":false,
124 "isNew":false,
125 "isSubmitted":true,
126 "isFloating":false,
127 "isPage":true,
128 "isPreviewable":true,
129 "isComponent":false,
130 "isDocument":false,
131 "isAsset":false,
132 "isInFlight":false,
133 "eventDate":"2017-10-09T19:30:58Z",
134 "endpoint":null,
135 "timezone":null,
136 "numOfChildren":0,
137 "scheduledDate":null,
138 "publishedDate":null,
139 "mandatoryParent":null,
140 "isLevelDescriptor":false,
141 "categoryRoot":null,
142 "lastEditDate":"2017-10-09T19:30:58Z",
143 "form":"/page/home",
144 "formPagePath":"simple",
145 "renderingTemplates":
146 [
147 {
148 "uri":"/templates/web/pages/home.ftl",
149 "name":"DEFAULT"
150 }
151 ],
152 "folder":false,
153 "submissionComment":null,
154 "components":null,
155 "documents":null,
156 "levelDescriptors":null,
157 "pages":null,
158 "parentPath":null,
159 "orders":
160 [
161 {
162 "name":null,
163 "id":"default",
164 "order":-1.0,
165 "placeInNav":null,
166 "disabled":null
167 }
168 ],
169 "children":[],
170 "size":0.0,
171 "sizeUnit":null,
172 "mimeType":"application/xml",
173 "environment":null,
174 "submittedToEnvironment":"live",
175 "new":false,
176 "levelDescriptor":false,
177 "newFile":false,
178 "reference":false
179 }
180 ],
181 "size":0.0,
182 "sizeUnit":null,
183 "mimeType":null,
184 "new":false,
185 "levelDescriptor":false,
186 "newFile":false,
187 "reference":false
188 },
189 {
190 "name":"Components",
191 "internalName":"Components",
192 "contentType":null,
193 "uri":"/site/components",
194 "path":"/site/components",
195 "browserUri":null,
196 "navigation":false,
197 "floating":false,
198 "hideInAuthoring":false,
199 "previewable":false,
200 "lockOwner":null,
201 "user":null,
202 "userFirstName":null,
203 "userLastName":null,
204 "nodeRef":null,
205 "metaDescription":null,
206 "site":null,
207 "page":false,
208 "component":false,
209 "document":false,
210 "asset":false,
211 "isContainer":false,
212 "container":false,
213 "disabled":false,
214 "savedAsDraft":false,
215 "submitted":false,
216 "submittedForDeletion":false,
217 "scheduled":false,
218 "published":false,
219 "deleted":false,
220 "inProgress":false,
221 "live":false,
222 "inFlight":false,
223 "isDisabled":false,
224 "isSavedAsDraft":false,
225 "isInProgress":false,
226 "isLive":false,
227 "isSubmittedForDeletion":false,
228 "isScheduled":false,
229 "isPublished":false,
230 "isNavigation":false,
231 "isDeleted":false,
232 "isNew":false,
233 "isSubmitted":false,
234 "isFloating":false,
235 "isPage":false,
236 "isPreviewable":false,
237 "isComponent":false,
238 "isDocument":false,
239 "isAsset":false,
240 "isInFlight":false,
241 "eventDate":null,
242 "endpoint":null,
243 "timezone":"EST5EDT",
244 "numOfChildren":0,
245 "scheduledDate":null,
246 "publishedDate":null,
247 "mandatoryParent":null,
248 "isLevelDescriptor":false,
249 "categoryRoot":"/site/components",
250 "lastEditDate":null,
251 "form":null,
252 "formPagePath":null,
253 "renderingTemplates":[],
254 "folder":false,
255 "submissionComment":null,
256 "components":null,
257 "documents":null,
258 "levelDescriptors":null,
259 "pages":null,
260 "parentPath":null,
261 "orders":null,
262 "children":[],
263 "size":0.0,
264 "sizeUnit":null,
265 "mimeType":null,
266 "new":false,
267 "levelDescriptor":false,
268 "newFile":false,
269 "reference":false
270 },
271 {
272 "name":"Assets",
273 "internalName":"Assets",
274 "contentType":null,
275 "uri":"/static-assets",
276 "path":"/static-assets",
277 "browserUri":null,
278 "navigation":false,
279 "floating":false,
280 "hideInAuthoring":false,
281 "previewable":false,
282 "lockOwner":null,
283 "user":null,
284 "userFirstName":null,
285 "userLastName":null,
286 "nodeRef":null,
287 "metaDescription":null,
288 "site":null,
289 "page":false,
290 "component":false,
291 "document":false,
292 "asset":false,
293 "isContainer":false,
294 "container":false,
295 "disabled":false,
296 "savedAsDraft":false,
297 "submitted":false,
298 "submittedForDeletion":false,
299 "scheduled":false,
300 "published":false,
301 "deleted":false,
302 "inProgress":false,
303 "live":false,
304 "inFlight":false,
305 "isDisabled":false,
306 "isSavedAsDraft":false,
307 "isInProgress":false,
308 "isLive":false,
309 "isSubmittedForDeletion":false,
310 "isScheduled":false,
311 "isPublished":false,
312 "isNavigation":false,
313 "isDeleted":false,
314 "isNew":false,
315 "isSubmitted":false,
316 "isFloating":false,
317 "isPage":false,
318 "isPreviewable":false,
319 "isComponent":false,
320 "isDocument":false,
321 "isAsset":false,
322 "isInFlight":false,
323 "eventDate":null,
324 "endpoint":null,
325 "timezone":"EST5EDT",
326 "numOfChildren":0,
327 "scheduledDate":null,
328 "publishedDate":null,
329 "mandatoryParent":null,
330 "isLevelDescriptor":false,
331 "categoryRoot":"/static-assets",
332 "lastEditDate":null,
333 "form":null,
334 "formPagePath":null,
335 "renderingTemplates":[],
336 "folder":false,
337 "submissionComment":null,
338 "components":null,
339 "documents":null,
340 "levelDescriptors":null,
341 "pages":null,
342 "parentPath":null,
343 "orders":null,
344 "children":[],
345 "size":0.0,
346 "sizeUnit":null,
347 "mimeType":null,
348 "new":false,
349 "levelDescriptor":false,
350 "newFile":false,
351 "reference":false
352 },
353 {
354 "name":"Templates",
355 "internalName":"Templates",
356 "contentType":null,
357 "uri":"/templates",
358 "path":"/templates",
359 "browserUri":null,
360 "navigation":false,
361 "floating":false,
362 "hideInAuthoring":false,
363 "previewable":false,
364 "lockOwner":null,
365 "user":null,
366 "userFirstName":null,
367 "userLastName":null,
368 "nodeRef":null,
369 "metaDescription":null,
370 "site":null,
371 "page":false,
372 "component":false,
373 "document":false,
374 "asset":false,
375 "isContainer":false,
376 "container":false,
377 "disabled":false,
378 "savedAsDraft":false,
379 "submitted":false,
380 "submittedForDeletion":false,
381 "scheduled":false,
382 "published":false,
383 "deleted":false,
384 "inProgress":false,
385 "live":false,
386 "inFlight":false,
387 "isDisabled":false,
388 "isSavedAsDraft":false,
389 "isInProgress":false,
390 "isLive":false,
391 "isSubmittedForDeletion":false,
392 "isScheduled":false,
393 "isPublished":false,
394 "isNavigation":false,
395 "isDeleted":false,
396 "isNew":false,
397 "isSubmitted":false,
398 "isFloating":false,
399 "isPage":false,
400 "isPreviewable":false,
401 "isComponent":false,
402 "isDocument":false,
403 "isAsset":false,
404 "isInFlight":false,
405 "eventDate":null,
406 "endpoint":null,
407 "timezone":"EST5EDT",
408 "numOfChildren":0,
409 "scheduledDate":null,
410 "publishedDate":null,
411 "mandatoryParent":null,
412 "isLevelDescriptor":false,
413 "categoryRoot":"/templates",
414 "lastEditDate":null,
415 "form":null,
416 "formPagePath":null,
417 "renderingTemplates":[],
418 "folder":false,
419 "submissionComment":null,
420 "components":null,
421 "documents":null,
422 "levelDescriptors":null,
423 "pages":null,
424 "parentPath":null,
425 "orders":null,
426 "children":[],
427 "size":0.0,
428 "sizeUnit":null,
429 "mimeType":null,
430 "new":false,
431 "levelDescriptor":false,
432 "newFile":false,
433 "reference":false
434 }
435 ],
436 "ascending":"false"
437}
Responses
Status
|
Location
|
Response Body
|
|---|---|---|
200
|
See example above.
|