Flows

Search for flows

Changed on
get/api/v1/{tenant}/flows/search

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/{tenant}/flows/search
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Path parameters

tenantstring required

Query parameters

pageinteger required

The current page

sizeinteger required

The current page size

sortstring[] nullable

The sort of current page

field'QUERY' | 'SCOPE' | 'NAMESPACE' | 'KIND' | 'LABELS' | 'METADATA' | 'FLOW_ID' | 'FLOW_REVISION' | 'ID' | 'ASSET_ID' | 'TYPE' | 'CREATED' | 'UPDATED' | 'START_DATE' | 'END_DATE' | 'EXPIRATION_DATE' | 'STATE' | 'TIME_RANGE' | 'TRIGGER_EXECUTION_ID' | 'TRIGGER_ID' | 'TRIGGER_STATE' | 'EXECUTION_ID' | 'TASK_ID' | 'TASK_RUN_ID' | 'CHILD_FILTER' | 'WORKER_ID' | 'EXISTING_ONLY' | 'MIN_LEVEL' | 'PATH' | 'PARENT_PATH' | 'VERSION' | 'USERNAME'
operation'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'LESS_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN_OR_EQUAL_TO' | 'IN' | 'NOT_IN' | 'STARTS_WITH' | 'ENDS_WITH' | 'CONTAINS' | 'REGEX' | 'PREFIX'
valueobject

Filters

Response

searchFlows 200 response

totalinteger required

Example response

{
  "total": 1,
  "results": [
    {
      "outputs": [
        {
          "displayName": "displayName",
          "description": "description",
          "id": "id",
          "type": "STRING",
          "value": "{}",
          "required": true
        },
        {
          "displayName": "displayName",
          "description": "description",
          "id": "id",
          "type": "STRING",
          "value": "{}",
          "required": true
        }
      ],
      "variables": null,
      "inputs": [
        {
          "dependsOn": "",
          "defaults": "",
          "displayName": "displayName",
          "prefill": "",
          "description": "description",
          "id": "id",
          "type": "",
          "required": true
        },
        {
          "dependsOn": "",
          "defaults": "",
          "displayName": "displayName",
          "prefill": "",
          "description": "description",
          "id": "id",
          "type": "",
          "required": true
        }
      ],
      "finally": [
        {
          "taskCache": {
            "ttl": "ttl",
            "enabled": true
          },
          "description": "description",
          "type": "type",
          "logToFile": true,
          "version": "version",
          "timeout": {
            "expression": "expression",
            "value": "value"
          },
          "allowWarning": true,
          "allowFailure": true,
          "assets": "",
          "logLevel": "ERROR",
          "runIf": "runIf",
          "disabled": true,
          "id": "id",
          "workerGroup": {
            "fallback": "FAIL",
            "key": "key"
          },
          "retry": "{}"
        },
        {
          "taskCache": {
            "ttl": "ttl",
            "enabled": true
          },
          "description": "description",
          "type": "type",
          "logToFile": true,
          "version": "version",
          "timeout": {
            "expression": "expression",
            "value": "value"
          },
          "allowWarning": true,
          "allowFailure": true,
          "assets": "",
          "logLevel": "ERROR",
          "runIf": "runIf",
          "disabled": true,
          "id": "id",
          "workerGroup": {
            "fallback": "FAIL",
            "key": "key"
          },
          "retry": "{}"
        }
      ],
      "description": "description",
      "sla": [
        {
          "id": "id",
          "type": "MAX_DURATION",
          "behavior": "FAIL",
          "labels": [
            "SLA_labels",
            "SLA_labels"
          ]
        },
        {
          "id": "id",
          "type": "MAX_DURATION",
          "behavior": "FAIL",
          "labels": [
            "SLA_labels",
            "SLA_labels"
          ]
        }
      ],
      "afterExecution": [
        {
          "taskCache": {
            "ttl": "ttl",
            "enabled": true
          },
          "description": "description",
          "type": "type",
          "logToFile": true,
          "version": "version",
          "timeout": {
            "expression": "expression",
            "value": "value"
          },
          "allowWarning": true,
          "allowFailure": true,
          "assets": "",
          "logLevel": "ERROR",
          "runIf": "runIf",
          "disabled": true,
          "id": "id",
          "workerGroup": {
            "fallback": "FAIL",
            "key": "key"
          },
          "retry": "{}"
        },
        {
          "taskCache": {
            "ttl": "ttl",
            "enabled": true
          },
          "description": "description",
          "type": "type",
          "logToFile": true,
          "version": "version",
          "timeout": {
            "expression": "expression",
            "value": "value"
          },
          "allowWarning": true,
          "allowFailure": true,
          "assets": "",
          "logLevel": "ERROR",
          "runIf": "runIf",
          "disabled": true,
          "id": "id",
          "workerGroup": {
            "fallback": "FAIL",
            "key": "key"
          },
          "retry": "{}"
        }
      ],
      "triggers": [
        {
          "allowConcurrent": true,
          "stopAfter": [
            "CREATED",
            "CREATED"
          ],
          "description": "description",
          "type": "type",
          "logToFile": true,
          "version": "version",
          "labels": [
            "The_labels_to_pass_to_the_execution_created_",
            "The_labels_to_pass_to_the_execution_created_"
          ],
          "failOnTriggerError": true,
          "assets": {
            "outputs": {
              "expression": "expression",
              "value": [
                {
                  "metadata": {
                    "key": "{}"
                  },
                  "displayName": "displayName",
                  "namespace": "namespace",
                  "description": "description",
                  "id": "id",
                  "type": "type"
                },
                {
                  "metadata": {
                    "key": "{}"
                  },
                  "displayName": "displayName",
                  "namespace": "namespace",
                  "description": "description",
                  "id": "id",
                  "type": "type"
                }
              ]
            },
            "inputs": {
              "expression": "expression",
              "value": [
                {
                  "id": "id",
                  "type": "type"
                },
                {
                  "id": "id",
                  "type": "type"
                }
              ]
            },
            "enableAuto": {
              "expression": "expression",
              "value": true
            }
          },
          "logLevel": null,
          "disabled": false,
          "id": "id",
          "workerGroup": {
            "fallback": "FAIL",
            "key": "key"
          },
          "conditions": [
            {
              "type": "type"
            },
            {
              "type": "type"
            }
          ]
        },
        {
          "allowConcurrent": true,
          "stopAfter": [
            "CREATED",
            "CREATED"
          ],
          "description": "description",
          "type": "type",
          "logToFile": true,
          "version": "version",
          "labels": [
            "The_labels_to_pass_to_the_execution_created_",
            "The_labels_to_pass_to_the_execution_created_"
          ],
          "failOnTriggerError": true,
          "assets": {
            "outputs": {
              "expression": "expression",
              "value": [
                {
                  "metadata": {
                    "key": "{}"
                  },
                  "displayName": "displayName",
                  "namespace": "namespace",
                  "description": "description",
                  "id": "id",
                  "type": "type"
                },
                {
                  "metadata": {
                    "key": "{}"
                  },
                  "displayName": "displayName",
                  "namespace": "namespace",
                  "description": "description",
                  "id": "id",
                  "type": "type"
                }
              ]
            },
            "inputs": {
              "expression": "expression",
              "value": [
                {
                  "id": "id",
                  "type": "type"
                },
                {
                  "id": "id",
                  "type": "type"
                }
              ]
            },
            "enableAuto": {
              "expression": "expression",
              "value": true
            }
          },
          "logLevel": null,
          "disabled": false,
          "id": "id",
          "workerGroup": {
            "fallback": "FAIL",
            "key": "key"
          },
          "conditions": [
            {
              "type": "type"
            },
            {
              "type": "type"
            }
          ]
        }
      ],
      "pluginDefaults": [
        {
          "forced": true,
          "values": "{}",
          "type": "type"
        },
        {
          "forced": true,
          "values": "{}",
          "type": "type"
        }
      ],
      "revision": 1,
      "labels": [
        {
          "value": "value",
          "key": "key"
        },
        {
          "value": "value",
          "key": "key"
        }
      ],
      "concurrency": {
        "limit": 1,
        "behavior": "QUEUE"
      },
      "deleted": true,
      "checks": [
        {
          "condition": "condition",
          "style": "ERROR",
          "message": "message",
          "behavior": "BLOCK_EXECUTION"
        },
        {
          "condition": "condition",
          "style": "ERROR",
          "message": "message",
          "behavior": "BLOCK_EXECUTION"
        }
      ],
      "namespace": "namespace",
      "disabled": true,
      "id": "id",
      "workerGroup": {
        "fallback": "FAIL",
        "key": "key"
      },
      "updated": "2000-01-23T04:56:07.000+00:00",
      "tasks": [
        {
          "taskCache": {
            "ttl": "ttl",
            "enabled": true
          },
          "description": "description",
          "type": "type",
          "logToFile": true,
          "version": "version",
          "timeout": {
            "expression": "expression",
            "value": "value"
          },
          "allowWarning": true,
          "allowFailure": true,
          "assets": "",
          "logLevel": "ERROR",
          "runIf": "runIf",
          "disabled": true,
          "id": "id",
          "workerGroup": {
            "fallback": "FAIL",
            "key": "key"
          },
          "retry": "{}"
        },
        {
          "taskCache": {
            "ttl": "ttl",
            "enabled": true
          },
          "description": "description",
          "type": "type",
          "logToFile": true,
          "version": "version",
          "timeout": {
            "expression": "expression",
            "value": "value"
          },
          "allowWarning": true,
          "allowFailure": true,
          "assets": "",
          "logLevel": "ERROR",
          "runIf": "runIf",
          "disabled": true,
          "id": "id",
          "workerGroup": {
            "fallback": "FAIL",
            "key": "key"
          },
          "retry": "{}"
        }
      ],
      "errors": [
        {
          "taskCache": {
            "ttl": "ttl",
            "enabled": true
          },
          "description": "description",
          "type": "type",
          "logToFile": true,
          "version": "version",
          "timeout": {
            "expression": "expression",
            "value": "value"
          },
          "allowWarning": true,
          "allowFailure": true,
          "assets": "",
          "logLevel": "ERROR",
          "runIf": "runIf",
          "disabled": true,
          "id": "id",
          "workerGroup": {
            "fallback": "FAIL",
            "key": "key"
          },
          "retry": "{}"
        },
        {
          "taskCache": {
            "ttl": "ttl",
            "enabled": true
          },
          "description": "description",
          "type": "type",
          "logToFile": true,
          "version": "version",
          "timeout": {
            "expression": "expression",
            "value": "value"
          },
          "allowWarning": true,
          "allowFailure": true,
          "assets": "",
          "logLevel": "ERROR",
          "runIf": "runIf",
          "disabled": true,
          "id": "id",
          "workerGroup": {
            "fallback": "FAIL",
            "key": "key"
          },
          "retry": "{}"
        }
      ],
      "retry": null
    },
    {
      "outputs": [
        {
          "displayName": "displayName",
          "description": "description",
          "id": "id",
          "type": "STRING",
          "value": "{}",
          "required": true
        },
        {
          "displayName": "displayName",
          "description": "description",
          "id": "id",
          "type": "STRING",
          "value": "{}",
          "required": true
        }
      ],
      "variables": null,
      "inputs": [
        {
          "dependsOn": "",
          "defaults": "",
          "displayName": "displayName",
          "prefill": "",
          "description": "description",
          "id": "id",
          "type": "",
          "required": true
        },
        {
          "dependsOn": "",
          "defaults": "",
          "displayName": "displayName",
          "prefill": "",
          "description": "description",
          "id": "id",
          "type": "",
          "required": true
        }
      ],
      "finally": [
        {
          "taskCache": {
            "ttl": "ttl",
            "enabled": true
          },
          "description": "description",
          "type": "type",
          "logToFile": true,
          "version": "version",
          "timeout": {
            "expression": "expression",
            "value": "value"
          },
          "allowWarning": true,
          "allowFailure": true,
          "assets": "",
          "logLevel": "ERROR",
          "runIf": "runIf",
          "disabled": true,
          "id": "id",
          "workerGroup": {
            "fallback": "FAIL",
            "key": "key"
          },
          "retry": "{}"
        },
        {
          "taskCache": {
            "ttl": "ttl",
            "enabled": true
          },
          "description": "description",
          "type": "type",
          "logToFile": true,
          "version": "version",
          "timeout": {
            "expression": "expression",
            "value": "value"
          },
          "allowWarning": true,
          "allowFailure": true,
          "assets": "",
          "logLevel": "ERROR",
          "runIf": "runIf",
          "disabled": true,
          "id": "id",
          "workerGroup": {
            "fallback": "FAIL",
            "key": "key"
          },
          "retry": "{}"
        }
      ],
      "description": "description",
      "sla": [
        {
          "id": "id",
          "type": "MAX_DURATION",
          "behavior": "FAIL",
          "labels": [
            "SLA_labels",
            "SLA_labels"
          ]
        },
        {
          "id": "id",
          "type": "MAX_DURATION",
          "behavior": "FAIL",
          "labels": [
            "SLA_labels",
            "SLA_labels"
          ]
        }
      ],
      "afterExecution": [
        {
          "taskCache": {
            "ttl": "ttl",
            "enabled": true
          },
          "description": "description",
          "type": "type",
          "logToFile": true,
          "version": "version",
          "timeout": {
            "expression": "expression",
            "value": "value"
          },
          "allowWarning": true,
          "allowFailure": true,
          "assets": "",
          "logLevel": "ERROR",
          "runIf": "runIf",
          "disabled": true,
          "id": "id",
          "workerGroup": {
            "fallback": "FAIL",
            "key": "key"
          },
          "retry": "{}"
        },
        {
          "taskCache": {
            "ttl": "ttl",
            "enabled": true
          },
          "description": "description",
          "type": "type",
          "logToFile": true,
          "version": "version",
          "timeout": {
            "expression": "expression",
            "value": "value"
          },
          "allowWarning": true,
          "allowFailure": true,
          "assets": "",
          "logLevel": "ERROR",
          "runIf": "runIf",
          "disabled": true,
          "id": "id",
          "workerGroup": {
            "fallback": "FAIL",
            "key": "key"
          },
          "retry": "{}"
        }
      ],
      "triggers": [
        {
          "allowConcurrent": true,
          "stopAfter": [
            "CREATED",
            "CREATED"
          ],
          "description": "description",
          "type": "type",
          "logToFile": true,
          "version": "version",
          "labels": [
            "The_labels_to_pass_to_the_execution_created_",
            "The_labels_to_pass_to_the_execution_created_"
          ],
          "failOnTriggerError": true,
          "assets": {
            "outputs": {
              "expression": "expression",
              "value": [
                {
                  "metadata": {
                    "key": "{}"
                  },
                  "displayName": "displayName",
                  "namespace": "namespace",
                  "description": "description",
                  "id": "id",
                  "type": "type"
                },
                {
                  "metadata": {
                    "key": "{}"
                  },
                  "displayName": "displayName",
                  "namespace": "namespace",
                  "description": "description",
                  "id": "id",
                  "type": "type"
                }
              ]
            },
            "inputs": {
              "expression": "expression",
              "value": [
                {
                  "id": "id",
                  "type": "type"
                },
                {
                  "id": "id",
                  "type": "type"
                }
              ]
            },
            "enableAuto": {
              "expression": "expression",
              "value": true
            }
          },
          "logLevel": null,
          "disabled": false,
          "id": "id",
          "workerGroup": {
            "fallback": "FAIL",
            "key": "key"
          },
          "conditions": [
            {
              "type": "type"
            },
            {
              "type": "type"
            }
          ]
        },
        {
          "allowConcurrent": true,
          "stopAfter": [
            "CREATED",
            "CREATED"
          ],
          "description": "description",
          "type": "type",
          "logToFile": true,
          "version": "version",
          "labels": [
            "The_labels_to_pass_to_the_execution_created_",
            "The_labels_to_pass_to_the_execution_created_"
          ],
          "failOnTriggerError": true,
          "assets": {
            "outputs": {
              "expression": "expression",
              "value": [
                {
                  "metadata": {
                    "key": "{}"
                  },
                  "displayName": "displayName",
                  "namespace": "namespace",
                  "description": "description",
                  "id": "id",
                  "type": "type"
                },
                {
                  "metadata": {
                    "key": "{}"
                  },
                  "displayName": "displayName",
                  "namespace": "namespace",
                  "description": "description",
                  "id": "id",
                  "type": "type"
                }
              ]
            },
            "inputs": {
              "expression": "expression",
              "value": [
                {
                  "id": "id",
                  "type": "type"
                },
                {
                  "id": "id",
                  "type": "type"
                }
              ]
            },
            "enableAuto": {
              "expression": "expression",
              "value": true
            }
          },
          "logLevel": null,
          "disabled": false,
          "id": "id",
          "workerGroup": {
            "fallback": "FAIL",
            "key": "key"
          },
          "conditions": [
            {
              "type": "type"
            },
            {
              "type": "type"
            }
          ]
        }
      ],
      "pluginDefaults": [
        {
          "forced": true,
          "values": "{}",
          "type": "type"
        },
        {
          "forced": true,
          "values": "{}",
          "type": "type"
        }
      ],
      "revision": 1,
      "labels": [
        {
          "value": "value",
          "key": "key"
        },
        {
          "value": "value",
          "key": "key"
        }
      ],
      "concurrency": {
        "limit": 1,
        "behavior": "QUEUE"
      },
      "deleted": true,
      "checks": [
        {
          "condition": "condition",
          "style": "ERROR",
          "message": "message",
          "behavior": "BLOCK_EXECUTION"
        },
        {
          "condition": "condition",
          "style": "ERROR",
          "message": "message",
          "behavior": "BLOCK_EXECUTION"
        }
      ],
      "namespace": "namespace",
      "disabled": true,
      "id": "id",
      "workerGroup": {
        "fallback": "FAIL",
        "key": "key"
      },
      "updated": "2000-01-23T04:56:07.000+00:00",
      "tasks": [
        {
          "taskCache": {
            "ttl": "ttl",
            "enabled": true
          },
          "description": "description",
          "type": "type",
          "logToFile": true,
          "version": "version",
          "timeout": {
            "expression": "expression",
            "value": "value"
          },
          "allowWarning": true,
          "allowFailure": true,
          "assets": "",
          "logLevel": "ERROR",
          "runIf": "runIf",
          "disabled": true,
          "id": "id",
          "workerGroup": {
            "fallback": "FAIL",
            "key": "key"
          },
          "retry": "{}"
        },
        {
          "taskCache": {
            "ttl": "ttl",
            "enabled": true
          },
          "description": "description",
          "type": "type",
          "logToFile": true,
          "version": "version",
          "timeout": {
            "expression": "expression",
            "value": "value"
          },
          "allowWarning": true,
          "allowFailure": true,
          "assets": "",
          "logLevel": "ERROR",
          "runIf": "runIf",
          "disabled": true,
          "id": "id",
          "workerGroup": {
            "fallback": "FAIL",
            "key": "key"
          },
          "retry": "{}"
        }
      ],
      "errors": [
        {
          "taskCache": {
            "ttl": "ttl",
            "enabled": true
          },
          "description": "description",
          "type": "type",
          "logToFile": true,
          "version": "version",
          "timeout": {
            "expression": "expression",
            "value": "value"
          },
          "allowWarning": true,
          "allowFailure": true,
          "assets": "",
          "logLevel": "ERROR",
          "runIf": "runIf",
          "disabled": true,
          "id": "id",
          "workerGroup": {
            "fallback": "FAIL",
            "key": "key"
          },
          "retry": "{}"
        },
        {
          "taskCache": {
            "ttl": "ttl",
            "enabled": true
          },
          "description": "description",
          "type": "type",
          "logToFile": true,
          "version": "version",
          "timeout": {
            "expression": "expression",
            "value": "value"
          },
          "allowWarning": true,
          "allowFailure": true,
          "assets": "",
          "logLevel": "ERROR",
          "runIf": "runIf",
          "disabled": true,
          "id": "id",
          "workerGroup": {
            "fallback": "FAIL",
            "key": "key"
          },
          "retry": "{}"
        }
      ],
      "retry": null
    }
  ]
}

Changes

    • info

      added the enum value EXPIRATION_DATE to the property items/field of the query request parameter filters

    • info

      added the enum value USERNAME to the property items/field of the query request parameter filters

    • info

      added the optional property ////// to the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added to the ///// response property allOf list for the response status

    • info

      added to the ///// response property allOf list for the response status

    • info

      added to the ///// response property allOf list for the response status

    • info

      added to the ///// response property allOf list for the response status

    • info

      removed from the ///// response property allOf list for the response status

    • info

      removed from the ///// response property allOf list for the response status

    • info

      removed from the ///// response property allOf list for the response status

    • info

      removed from the ///// response property allOf list for the response status

    • info

      removed subschema #1 subschema #2 from the ///// response property oneOf list for the response status