Execution Step Output API

GET/qflowapi/v1/executions/{executionId}/steps/{nodeId}/output

Use this API to get the output generated by a specific step. This helps validate results and understand how data progresses through the workflow.

Required Permissions

The following permissions are needed to get the workflow execution step output.

  • LIST ALL
  • LIST WF BY TAGS
  • LIST MY

Input ParametersInput Parameters

Parameter

Mandatory/Optional

Data Type

Description

executionId

Mandatory

 String

Provide a valid execution ID. Ensure it is UUID.

For example: '0ffaf046-768b-79fc-83f6-aa25be52c2a1'.

nodeId

Mandatory

String

Provide a node ID.

For example: node-67649155-filter

Note: Ensure Node ID must not empty.

Authorization 

Mandatory

String

Authorization token to authenticate to the Qualys Cloud Platform.

Prepend token with 'Bearer' and one space.

For example - Bearer <authToken>

Sample: Get the output generated by a specific stepSample: Get the output generated by a specific step

API Request

curl -X GET
<qualys_base_url>/qflowapi/v1/executions/0e72b4a1-abea-45b2-9ae9-91cd87506404
/steps/node-e3a84822-qualysevent/output
-H "Accept: application/json"
-H "Content-Type: application/json"
-H "Authorization: Bearer <jwt token>"

Response

[
  {
    "source": "WORKFLOW_TRIGGER",
    "customerId": "54f50897-26f3-c9af-83f9-e71459be70d9",
    "workflowId": "b47f74b7-b0e8-48f8-9934-7ce1b0680f2b",
    "input": {
      "collection": [
        {
          "StoppingInstances": [
            {
              "CurrentState": {
                "Code": 80,
                "Name": "stopped"
              },
              "InstanceId": "i-0663d3f3e572608d5",
              "PreviousState": {
                "Code": 80,
                "Name": "stopped"
              }
            }
          ],
          "InstanceIds": [
            "i-0663d3f3e572608d5"
          ]
        },
        {
          "StoppingInstances": [
            {
              "CurrentState": {
                "Code": 80,
                "Name": "stopped"
              },
              "InstanceId": "i-0c6024ad8375f39ef",
              "PreviousState": {
                "Code": 80,
                "Name": "stopped"
              }
            }
          ],
          "InstanceIds": [
            "i-0c6024ad8375f39ef"
          ]
        }
      ]
    },
    "executionId": "93c29829-8efd-4dcb-bfb8-efd6bbb2b725",
    "forceRun": false,
    "overrideVariables": [
      {
        "key": "depthCount",
        "value": 2,
        "type": "user-defined"
      },
      {
        "key": "region",
        "value": [
          "us-east-1"
        ],
        "type": "system-defined"
      },
      {
        "key": "credentials",
        "value": [
          {
            "type": "role",
            "arn": "arn:aws:iam::993493008830:role/QFLOW_1",
            "externalId": "AWS",
            "account": "993493008830",
            "accountId": "993493008830",
            "portalUuid": "53bcaf5b-b207-4eeb-b672-cb83a4776f70",
            "isMigrated": true,
            "connectorId": "53bcaf5b-b207-4eeb-b672-cb83a4776f70",
            "qflowConnectorId": "aa70acae-6ea8-3acf-b504-f327855b316a"
          }
        ],
        "type": "system-defined"
      },
      {
        "type": "user-defined",
        "value": {
          "method": "stopInstances",
          "service": "EC2",
          "cloudtype": "AWS",
          "resourceType": "EC2_INSTANCE"
        },
        "key": "rawParams"
      },
      {
        "type": "user-defined",
        "value": {
          "maxAttempts": 40,
          "score": "0.8000",
          "delay": 15,
          "underlyingApi": "DescribeInstances",
          "parameterBindings": [
            {
              "sourceProperty": "input.InstanceIds",
              "sourceConfidence": 0.4166666666666667,
              "linkConfidence": 0.7692307692307693,
              "targetProperty": "InstanceIds"
            }
          ],
          "params": {
            "Filters": [
              {
                "Values": [
                  "<optional1>",
                  "<optional2>"
                ],
                "Name": "<optional>"
              }
            ],
            "NextToken": "<optional>",
            "MaxResults": "<optional>",
            "InstanceIds": [
              "obj.StoppingInstances.InstanceId"
            ]
          },
          "operation": "describeInstances",
          "acceptors": [
            {
              "argument": "Reservations[].Instances[].State.Name",
              "expected": "stopped",
              "state": "success",
              "matcher": "pathAll"
            },
            {
              "argument": "Reservations[].Instances[].State.Name",
              "expected": "pending",
              "state": "failure",
              "matcher": "pathAny"
            },
            {
              "argument": "Reservations[].Instances[].State.Name",
              "expected": "terminated",
              "state": "failure",
              "matcher": "pathAny"
            }
          ],
          "waitForState": "instanceStopped"
        },
        "key": "selectedWaiter"
      },
      {
        "type": "user-defined",
        "value": {
          "InstanceStopped": {
            "maxAttempts": 40,
            "score": "0.8000",
            "delay": 15,
            "underlyingApi": "DescribeInstances",
            "parameterBindings": [
              {
                "sourceProperty": "input.InstanceIds",
                "sourceConfidence": 0.4166666666666667,
                "linkConfidence": 0.7692307692307693,
                "targetProperty": "InstanceIds"
              }
            ],
            "params": {
              "Filters": [
                {
                  "Values": [
                    "<optional1>",
                    "<optional2>"
                  ],
                  "Name": "<optional>"
                }
              ],
              "NextToken": "<optional>",
              "MaxResults": "<optional>",
              "InstanceIds": [
                "obj.StoppingInstances.InstanceId"
              ]
            },
            "operation": "describeInstances",
            "acceptors": [
              {
                "argument": "Reservations[].Instances[].State.Name",
                "expected": "stopped",
                "state": "success",
                "matcher": "pathAll"
              },
              {
                "argument": "Reservations[].Instances[].State.Name",
                "expected": "pending",
                "state": "failure",
                "matcher": "pathAny"
              },
              {
                "argument": "Reservations[].Instances[].State.Name",
                "expected": "terminated",
                "state": "failure",
                "matcher": "pathAny"
              }
            ],
            "waitForState": "instanceStopped"
          }
        },
        "key": "waiters"
      }
    ]
  }
]