PublishInfoResponse Data Type

Response containing information about the current or last publish process

Properties
name data type description
failed boolean Flag to mark failed publish process
progress number Progress in percent
estimatedDuration number Estimated remaining duration in seconds.
running boolean True when the publish process is currently running
totalWork number Total number of work items of the current publish process
totalWorkDone number Number of work items done
phase string Name of the current publish process phase
files ObjectCount File counts
folders ObjectCount Folder counts
pages ObjectCount Page counts
forms ObjectCount Form counts
Properties inherited from GenericResponse
messages array of Message Messages contained in the response (which should be shown to the user)
responseInfo ResponseInfo

Example

{
  "failed" : false,
  "progress" : 38,
  "estimatedDuration" : 128,
  "running" : true,
  "totalWork" : 1325,
  "totalWorkDone" : 503,
  "phase" : "...",
  "files" : {
    "toPublish" : 158,
    "delayed" : 0,
    "published" : 22,
    "remaining" : 136
  },
  "folders" : {
    "toPublish" : 158,
    "delayed" : 0,
    "published" : 22,
    "remaining" : 136
  },
  "pages" : {
    "toPublish" : 158,
    "delayed" : 0,
    "published" : 22,
    "remaining" : 136
  },
  "forms" : {
    "toPublish" : 158,
    "delayed" : 0,
    "published" : 22,
    "remaining" : 136
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}