• Document Up to Date

Get Deployment History

Get deployment history.

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-deployment-history.json
Response Formats
JSON
Required Role
N/A

Parameters

Name
Type
Required
Description
site_id
String
Site to use
days
String
Number of days for history
num
String
Number of items to display
filterType
String
Filter result set by filter type

Example

Request

GET .../api/1/services/api/1/deployment/get-deployment-history.json?site_id=mysite&days=30&num=10&filterType=all

Response

Status 200 OK

  1{
  2    "total":1,
  3    "documents":
  4        [
  5            {
  6                "internalName":"07/17",
  7                "numOfChildren":1,
  8                "children":
  9                    [
 10                        {
 11                            "name":"index.xml",
 12                            "internalName":"Style",
 13                            "contentType":"/page/category-landing",
 14                            "uri":"/site/website/style/index.xml",
 15                            "path":"/site/website/style",
 16                            "browserUri":"/style",
 17                            "navigation":true,
 18                            "floating":false,
 19                            "hideInAuthoring":false,
 20                            "previewable":true,
 21                            "lockOwner":"",
 22                            "user":"admin",
 23                            "userFirstName":"admin",
 24                            "userLastName":"",
 25                            "nodeRef":null,
 26                            "metaDescription":null,
 27                            "site":"mysite",
 28                            "page":true,
 29                            "component":false,
 30                            "document":false,
 31                            "asset":false,
 32                            "isContainer":false,
 33                            "container":false,
 34                            "disabled":false,
 35                            "savedAsDraft":false,
 36                            "submitted":false,
 37                            "submittedForDeletion":false,
 38                            "scheduled":false,
 39                            "published":false,
 40                            "deleted":false,
 41                            "inProgress":false,
 42                            "live":true,
 43                            "inFlight":false,
 44                            "isDisabled":false,
 45                            "isSavedAsDraft":false,
 46                            "isInProgress":false,
 47                            "isLive":true,
 48                            "isSubmittedForDeletion":false,
 49                            "isScheduled":false,
 50                            "isPublished":false,
 51                            "isNavigation":false,
 52                            "isDeleted":false,
 53                            "isNew":false,
 54                            "isSubmitted":false,
 55                            "isFloating":false,
 56                            "isPage":true,
 57                            "isPreviewable":true,
 58                            "isComponent":false,
 59                            "isDocument":false,
 60                            "isAsset":false,
 61                            "isInFlight":false,
 62                            "eventDate":"2017-07-17T19:57:26+02:00",
 63                            "endpoint":null,
 64                            "timezone":null,
 65                            "numOfChildren":0,
 66                            "scheduledDate":null,
 67                            "publishedDate":null,
 68                            "mandatoryParent":null,
 69                            "isLevelDescriptor":false,
 70                            "categoryRoot":null,
 71                            "lastEditDate":"2017-07-14T20:53:31+02:00",
 72                            "form":"/page/category-landing",
 73                            "formPagePath":"simple",
 74                            "renderingTemplates":
 75                                [
 76                                    {
 77                                        "uri":"/templates/web/pages/category-landing.ftl",
 78                                        "name":"DEFAULT"
 79                                    }
 80                                ],
 81                            "folder":false,
 82                            "submissionComment":null,
 83                            "components":null,
 84                            "documents":null,
 85                            "levelDescriptors":null,
 86                            "pages":null,
 87                            "parentPath":null,
 88                            "orders":
 89                                [
 90                                    {
 91                                        "name":null,
 92                                        "id":"default",
 93                                        "placeInNav":null,
 94                                        "disabled":null,
 95                                        "order":8000.0
 96                                    }
 97                                ],
 98                            "children":[ ],
 99                            "size":0.0,
100                            "sizeUnit":null,
101                            "mimeType":"application/xml",
102                            "levelDescriptor":false,
103                            "newFile":false,
104                            "new":false,
105                            "reference":false
106                        }
107                    ],
108                "endpoint":null
109            }
110        ]
111}

Responses

Status
Location
Response Body
200

See example above.