Workflow API Object

The object that gets returned when you retrieve a workflow.

    {
      "createdBy": "[email protected]",
      "description": "Enrich a metric from the Services Catalog",
      "id": "5f4d13b90995772bb5414dc1",
      "lastUpdated": 1598888422848,
      "metrics": {
        "actionMetricsMap": {
          "QueryCatalogAction": {
            "actionName": "QueryCatalogAction",
            "averageProcessingDurationMillis": 0,
            "discarded": null,
            "errors": 0,
            "highWatermarkProcessingDurationMillis": 2202,
            "lowWatermarkProcessingDurationMillis": 0,
            "processed": 133970,
            "skipped": null
          }
        },
        "averageProcessingDurationMillis": 0,
        "errors": 1,
        "highWatermarkProcessingDurationMillis": 6003,
        "lastException": "XXXXXXXXXXX",
        "lastExceptionMillis": 1599062483279,
        "lowWatermarkProcessingDurationMillis": 0,
        "processed": 133971
      },
      "name": "Enrich from Services Catalog",
      "priority": 1,
      "status": "NOT_RUNNING",
      "steps": [
        {
          "actionName": "QueryCatalogAction",
          "configuration": {
            "applyMapping": {
              "critical": {
                "outputFieldName": "tags.CriticalService"
              },
              "service": {
                "outputFieldName": "service"
              }
            },
            "catalogName": "Services",
            "lookupMapping": {
              "source": "source"
            }
          },
          "description": "This action queries a data catalog and maps the matching data to the specified fields."
        }
      ],
      "test": {
      },
      "trigger": {
        "type": "EVENT_CREATED"
      },
      "type": "EVENT"
    }

createdBy

string

Email of the user that created the workflow.

description

string

User-defined description of the workflow.

id

string

Auto-generated ID of the workflow.

lastUpdated

UTC timestamp

Time when the workflow was last updated.

metrics

JSON object

Performance metrics for the workflow. See [Workflow Metrics Object(https://api.docs.moogsoft.com/reference/workflow-metrics-object).

name

string

The workflow name.

status

enumerated string

Can be "RUNNING" or "NOT_RUNNING"

steps

list

The sequence of actions in the workflow and the configuration settings for each action.

test

JSON object

trigger

string

The filter that defines the objects that the workflow will process.

type

enumerated string

The object type that the workflow will process, such as "EVENT".