Operation

Overview

An Operation tracks a group of long-running, asynchronous jobs. Each individual task may succeed or fail over time. Equally, the entire Operation might succeed or fail.

There are multiple objects for tracking jobs, depending on the level of granularity:

ObjectWhereLevel
Operation/operation endpointFleet / Company: across multiple Devices or Objects
StepList/step endpointA single Device or object
StepStepList.stepsA single job being performed to a Device or Object

The two main uses for the Operation objects are to:

  • provide an ID with which to query StepLists, to get more information about a particular device or object being worked on.
  • know when all work is complete.

To determine the details and state of each individual device or object, invoke GET on the /step endpoint.