getWorkItems

Summary

Retrieves waiting items for the current user or a user specified with userName, subject to optionally supplied filters.

filter

Arrayoptional

A list of zero or more filter criteria definitions used to define objects to find.

userName

Stringoptional

Search filter user name.

Usage

Perl

$cmdr->getWorkItems(
  # optionals
);▼

ectool

ectool getWorkItems \
  # optionals▼

Examples

Filters

Use one or more filters to return specific types of waiting items. For example, below is a filter to return all manual or waiting for manual retry jobStep objects.

[
   [
      {
         "operation":"getWorkItems",
         "parameters":{
            "filter":{
               "operator":"and",
               "filter":[
                  {
                     "operator":"equals",
                     "propertyName":"waitingEntityType",
                     "operand1":"flowRuntimeState"
                  },
                  {
                     "operator":"equals",
                     "propertyName":"projectName",
                     "operand1":"Default"
                  },
                  {
                     "operator":"or",
                     "filter":[
                        {
                           "operator":"equals",
                           "propertyName":"gateType",
                           "operand1":"PRE"
                        },
                        {
                           "operator":"equals",
                           "propertyName":"gateType",
                           "operand1":"POST"
                        }
                     ]
                  }
               ]
            }
         },
         "requestId":"321"
      }
   ],
   {

   }
]▼

Perl

$cmdr->getWorkItems({userName => "admin"});▼

ectool

ectool getWorkItems --userName admin▼