PublishQueueResponse Data Type

Response containing the publish queue counts for nodes

Properties
name data type constraints description
nodes map of PublishQueueCounts   Map of node IDs to publish counts
messages array of Message   Messages contained in the response (which should be shown to the user)
responseInfo ResponseInfo  
inBackground boolean required boolean Whether the job was pushed into the background.

Example

{
  "nodes" : {
    "property1" : {
      "files" : {
        "toPublish" : 158,
        "delayed" : 0,
        "published" : 22,
        "remaining" : 136
      },
      "folders" : {
        "toPublish" : 158,
        "delayed" : 0,
        "published" : 22,
        "remaining" : 136
      },
      "forms" : {
        "toPublish" : 158,
        "delayed" : 0,
        "published" : 22,
        "remaining" : 136
      },
      "pages" : {
        "toPublish" : 158,
        "delayed" : 0,
        "published" : 22,
        "remaining" : 136
      }
    },
    "property2" : {
      "files" : {
        "toPublish" : 158,
        "delayed" : 0,
        "published" : 22,
        "remaining" : 136
      },
      "folders" : {
        "toPublish" : 158,
        "delayed" : 0,
        "published" : 22,
        "remaining" : 136
      },
      "forms" : {
        "toPublish" : 158,
        "delayed" : 0,
        "published" : 22,
        "remaining" : 136
      },
      "pages" : {
        "toPublish" : 158,
        "delayed" : 0,
        "published" : 22,
        "remaining" : 136
      }
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  },
  "inBackground" : true
}