PublishInfoResponse Data Type

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

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

Example

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