PublishInfoResponse Data Type

Generic response containing the response code and response messages (no additional objects)

Properties
name data type constraints description
forms ObjectCount  
lastFailed boolean  
totalWork number required int
running boolean required boolean
pages ObjectCount  
estimatedDuration number required int
failed boolean required boolean
folders ObjectCount  
files ObjectCount  
progress number required int
phase string  
totalWorkDone number required int
Properties inherited from GenericResponse
messages array of Message   Messages contained in the response (which should be shown to the user)
responseInfo ResponseInfo  

Example

{
  "forms" : {
    "published" : 12345,
    "delayed" : 12345,
    "remaining" : 12345,
    "toPublish" : 12345
  },
  "lastFailed" : true,
  "totalWork" : 12345,
  "running" : true,
  "pages" : {
    "published" : 12345,
    "delayed" : 12345,
    "remaining" : 12345,
    "toPublish" : 12345
  },
  "estimatedDuration" : 12345,
  "failed" : true,
  "folders" : {
    "published" : 12345,
    "delayed" : 12345,
    "remaining" : 12345,
    "toPublish" : 12345
  },
  "files" : {
    "published" : 12345,
    "delayed" : 12345,
    "remaining" : 12345,
    "toPublish" : 12345
  },
  "progress" : 12345,
  "phase" : "...",
  "totalWorkDone" : 12345,
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}