PublishInfoResponse Data Type

Response containing information about the current or last publish process

Properties
name data type constraints description
failed boolean required boolean Flag to mark failed publish process
lastFailed boolean   Flag to mark if the previous publish process failed.
progress number required int Progress in percent
estimatedDuration number required int Estimated remaining duration in seconds.
running boolean required boolean True when the publish process is currently running
totalWork number required int Total number of work items of the current publish process
totalWorkDone number required int 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,
  "lastFailed" : 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" : "..."
  }
}