• 25 May 2021
  • 1 Minute to read
  • Contributors
  • Dark
  • PDF


  • Dark
  • PDF

Article Summary


Gets the status of a combined collection. This status helps the user understand when they can rebuild the combined collection and what has to happen before they rebuild it.

URL parameters

CollectionIDTruenumericUnique identifier of the combined collection.


ResultstringSuccess if the operation was successful.
ErrorMessagestringReturns a description of what the error is when the combined collection errors.
ErrorDetailstringReturns details on the error when the combined collection errors.
ErrorCodestringReturns a shorter version description of what the error is when the combined collection errors.
ActiveJobsCountnumericNumber of active jobs for agents that source the combined collection.
ActiveJobActiveJobSource agent job currently running for the combined collection . Not returned if no source agents have active jobs.
CollectionIsUnderMaintenancebooleanYes, No, True, False. Yes/True if there is an active CollectionCombinedRebuild job for collection.
RebuildJobRebuildJobActive Rebuild job for collection. Will only be returned if CollectionIsUnderMaintenace is true.
StatusstringThe status of the combined collection. It can be the following values: Ready, Canceling, RefreshingData (when there are active source agent jobs), Rebuilding (when collection is under maintenance).

Sample request

curl -X GET ""

Sample responses


<?xml version="1.0" encoding="utf-8"?>
<ApiResponse xmlns:xsi="" xmlns:xsd="">

JSON (add &ResponseFormat=JSON)

  "CollectionID": 22308,
  "ErrorMessage": "",
  "ErrorDetail": "",
  "ErrorCode": "",
  "ActiveJobsCount": 2,
  "ActiveJob": [
      "JobID": 114758395,
      "Status": "Running",
      "JobType": "WebPageHarvest",
      "AgentID": 11620
      "JobID": 114758396,
      "Status": "",
      "JobType": "ReportRefreshData",
      "CollectionID": 11777
  "CollectionIsUnderMaintenance": false,
  "Status": "RefreshingData",
  "JsonResult": {
    "Command": "Collection.GetStatus",
    "AutoLoggedIn": false,
    "WebConsoleKey": "",
    "Result": "Success",
    "ErrorCode": "",
    "ErrorDescription": "",
    "ErrorList": [],
    "ExecutionTime": {
      "Ticks": 0,
      "Days": 0,
      "Hours": 0,
      "Milliseconds": 0,
      "Minutes": 0,
      "Seconds": 0,
      "TotalDays": 0,
      "TotalHours": 0,
      "TotalMilliseconds": 0,
      "TotalMinutes": 0,
      "TotalSeconds": 0

Was this article helpful?