Monitoring Bulk Tasks: GET List of Task Reports - AWS Elemental Conductor Live 3

This is version 3.19 of the AWS Elemental Conductor Live 3 documentation. This is the latest version. For prior versions, see the Previous Versions section of AWS Elemental Conductor Live 3 Documentation.

Monitoring Bulk Tasks: GET List of Task Reports

Get the list of bulk tasks. Each time one of the following commands is performed, a task_report is created:

  • POST Start Channel

  • POST Stop Channel

A task report shows information about the bulk task. The bulk task is made up of individual task items. For example, a POST Start Channel is a bulk task that is made up of one or more task, each to start a different channel.

HTTP Request and Response

Request URL

GET http://<Conductor IP address>/task_reports

Call Header

  • Accept: Set to application/xml

If you are implementing user authentication, you must also include three authorization headers; see Header Content for User Authentication.

Response

The response contains XML content consisting of one task_reports element

with the following.

  • An HREF attribute that specifies the product and version installed on the AWS Elemental Conductor Live 3 node.

  • Zero or more task_reports elements, one for each bulk task that is in progress or is completed. Each element contains several elements as listed.

Element Value Description
id Integer The unique ID for this task_report.
created_at String The time this bulk task was created (the POST Start or Stop was received by the system). Time is in ISO 8601 format, with the timezone designator indicated as an offset from UTC. For example, 2015-08-17T11:59:35-07:00 is the time in the timezone that is 7 hours behind UTC.
updated_at String The time the most recent change was made to this task report. In other words, the last time one or more of the count elements was updated.
description String “Channel Start” or “Channel Stop”.”.
complete Boolean

True means the bulk task has completed, with successes and/or failures.

False means not all the individual task items have completed yet.

task_count Integer The total number of task items in the bulk task. For example, if there are three “start channel” commands, this element specifies 3.
failed_count Integer The number of actions that have failed.
successful_count Integer The number of actions that have succeeded.
tasks Array One or more task elements. Each task represents an individual task within the bulk task. See below.

Recommended Procedure

  1. Send a GET task_reports as soon as a bulk task is POSTed.

  2. Parse the response for the desired <id> and store that ID for later use. This ID is the ID of the individual bulk task.

  3. Parse the response for the complete Boolean .

  4. Before that final resolution, you may want to check on the status of individual task items: send a GET task_reports/<task ID>, passing in the ID you saved earlier. Parse the <tasks> array of the response for tasks that are not successful or failed. If necessary for a status of a channel, check the ID within the individual <task> for the channel.