Collection.Rebuild

Updated on 25 May 2021
1 Minute to read
Contributors

Print
Share
Dark

Light
PDF

Description

This call rebuilds a combined collection. A combined collection can be rebuilt if all source agents are "at rest", that is, if all jobs running in source agents have a status of Done, Canceled, Paused, or Error.

Combined collections rebuild automatically when the last source agent job finishes or is canceled.

URL parameters

URL parameter ordering

The URL parameters below are listed in the order they should be entered in the API URL.

Name	Required	Type	Description
`CollectionID`	True	numeric	Unique identifier of the combined collection.
`Job.Status.Url`	False	string	A URL that Mozenda will request when the `CombinedCollectionRebuild` job finishes processing. This follows the same paradigm as Agent.Run's `Job.StatusURL`
`StatusTimeout`	False	string	Timeout for push notifications.

Responses

Name	Type	Description
`Result`	string	`Success` if the operation was successful.
`JobID`	string	Unique identifier for the `CombinedCollectionRebuild` job.
`CollectionID`	numeric	Unique identifier of the combined collection.

Sample request

curl -X GET "https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=Collection.Rebuild&CollectionID=1089"

Sample responses

XML

<?xml version="1.0" encoding="utf-8"?>
<RebuildResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Result>Success</Result>
  <JobID>32834</JobID>
  <CollectionID>1089</CollectionID>
</RebuildResponse>

JSON (add `&ResponseFormat=JSON`)

{
   "JobID": 32860,
   "CollectionID": 1089,
   "JsonResult": {
      "Command": "Collection.Rebuild",
      "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?

What's Next

Collection.GetSources