• Document Up to Date

Get Scheduled Items

Get scheduled items for deployment.

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/deployment/get-scheduled-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
String
Ascending or descending order
filterType
String
Filter result set by filter type

Example

Request

GET .../api/1/services/api/1/deployment/get-scheduled-items.json?site_id=mysite&sort=eventDate&ascending=false&filterType=all

Response

Status 200 OK

  1{
  2    "total":1,
  3    "sortedBy":"eventDate",
  4    "ascending":false,
  5    "documents":
  6        [
  7            {
  8                "name":"07/20 10:21PM",
  9                "internalName":"07/20 10:21PM",
 10                "contentType":null,
 11                "uri":null,
 12                "path":null,
 13                "browserUri":null,
 14                "navigation":false,
 15                "floating":false,
 16                "hideInAuthoring":false,
 17                "previewable":false,
 18                "lockOwner":null,
 19                "user":null,
 20                "userFirstName":null,
 21                "userLastName":null,
 22                "nodeRef":null,
 23                "metaDescription":null,
 24                "site":null,
 25                "page":false,
 26                "component":false,
 27                "document":false,
 28                "asset":false,
 29                "isContainer":false,
 30                "container":false,
 31                "disabled":false,
 32                "savedAsDraft":false,
 33                "submitted":false,
 34                "submittedForDeletion":false,
 35                "scheduled":false,
 36                "published":false,
 37                "deleted":false,
 38                "inProgress":false,
 39                "live":false,
 40                "inFlight":false,
 41                "isDisabled":false,
 42                "isSavedAsDraft":false,
 43                "isInProgress":false,
 44                "isLive":false,
 45                "isSubmittedForDeletion":false,
 46                "isScheduled":false,
 47                "isPublished":false,
 48                "isNavigation":false,
 49                "isDeleted":false,
 50                "isNew":false,
 51                "isSubmitted":false,
 52                "isFloating":false,
 53                "isPage":false,
 54                "isPreviewable":false,
 55                "isComponent":false,
 56                "isDocument":false,
 57                "isAsset":false,
 58                "isInFlight":false,
 59                "eventDate":"2017-07-21T04:21:00+02:00",
 60                "endpoint":null,
 61                "timezone":"EST5EDT",
 62                "numOfChildren":1,
 63                "scheduledDate":"2017-07-21T04:21:00+02:00",
 64                "publishedDate":null,
 65                "mandatoryParent":null,
 66                "isLevelDescriptor":false,
 67                "categoryRoot":null,
 68                "lastEditDate":null,
 69                "form":null,
 70                "formPagePath":null,
 71                "renderingTemplates":[ ],
 72                "folder":false,
 73                "submissionComment":null,
 74                "components":null,
 75                "documents":null,
 76                "levelDescriptors":null,
 77                "pages":null,
 78                "parentPath":null,
 79                "orders":null,
 80                "children":
 81                    [
 82                        {
 83                            "name":"index.xml",
 84                            "internalName":"Style",
 85                            "contentType":"/page/category-landing",
 86                            "uri":"/site/website/style/index.xml",
 87                            "path":"/site/website/style",
 88                            "browserUri":"/style",
 89                            "navigation":true,
 90                            "floating":false,
 91                            "hideInAuthoring":false,
 92                            "previewable":true,
 93                            "lockOwner":"",
 94                            "user":"admin",
 95                            "userFirstName":"admin",
 96                            "userLastName":"",
 97                            "nodeRef":null,
 98                            "metaDescription":null,
 99                            "site":"mysite",
100                            "page":true,
101                            "component":false,
102                            "document":false,
103                            "asset":false,
104                            "isContainer":false,
105                            "container":false,
106                            "disabled":false,
107                            "savedAsDraft":false,
108                            "submitted":false,
109                            "submittedForDeletion":false,
110                            "scheduled":true,
111                            "published":false,
112                            "deleted":false,
113                            "inProgress":true,
114                            "live":false,
115                            "inFlight":false,
116                            "isDisabled":false,
117                            "isSavedAsDraft":false,
118                            "isInProgress":true,
119                            "isLive":false,
120                            "isSubmittedForDeletion":false,
121                            "isScheduled":true,
122                            "isPublished":false,
123                            "isNavigation":false,
124                            "isDeleted":false,
125                            "isNew":false,
126                            "isSubmitted":false,
127                            "isFloating":false,
128                            "isPage":true,
129                            "isPreviewable":true,
130                            "isComponent":false,
131                            "isDocument":false,
132                            "isAsset":false,
133                            "isInFlight":false,
134                            "eventDate":"2017-07-17T22:21:44+02:00",
135                            "endpoint":null,
136                            "timezone":null,
137                            "numOfChildren":0,
138                            "scheduledDate":"2017-07-21T04:21:00+02:00",
139                            "publishedDate":null,
140                            "mandatoryParent":null,
141                            "isLevelDescriptor":false,
142                            "categoryRoot":null,
143                            "lastEditDate":"2017-07-17T22:21:44+02:00",
144                            "form":"/page/category-landing",
145                            "formPagePath":"simple",
146                            "renderingTemplates":
147                                [
148                                    {
149                                        "uri":"/templates/web/pages/category-landing.ftl",
150                                        "name":"DEFAULT"
151                                    }
152                                ],
153                            "folder":false,
154                            "submissionComment":null,
155                            "components":null,
156                            "documents":null,
157                            "levelDescriptors":null,
158                            "pages":null,
159                            "parentPath":null,
160                            "orders":
161                                [
162                                    {
163                                        "name":null,
164                                        "id":"default",
165                                        "placeInNav":null,
166                                        "disabled":null,
167                                        "order":8000.0
168                                    }
169                                ],
170                            "children":[ ],
171                            "size":0.0,
172                            "sizeUnit":null,
173                            "mimeType":"application/xml",
174                            "environment":"live",
175                            "levelDescriptor":false,
176                            "newFile":false,
177                            "new":false,
178                            "reference":false
179                        }
180                    ],
181                "size":0.0,
182                "sizeUnit":null,
183                "mimeType":null,
184                "environment":null,
185                "levelDescriptor":false,
186                "newFile":false,
187                "new":false,
188                "reference":false
189            }
190        ]
191}

Responses

Status
Location
Response Body
200

See example above.