1.6 KiB

Raw Blame History

layout	title	parent	nav_order
default	Search for a workflow state	Workflow APIs	65

Search for a workflow

This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated GitHub issue.
{: .warning}

You can search for resources created by workflows by matching a query to a field. The fields you can search correspond to those returned by the Get Workflow Status API.

Path and HTTP methods

GET /_plugins/_flow_framework/workflow/state/_search
POST /_plugins/_flow_framework/workflow/state/_search

Example request: All workflows with a state of `NOT_STARTED`

GET /_plugins/_flow_framework/workflow/state/_search
{
  "query": {
    "match": {
      "state": "NOT_STARTED"
    }
  }
}

{% include copy-curl.html %}

Example request: All workflows that have a `resources_created` field with a `workflow_step_id` of `register_model_2`

GET /_plugins/_flow_framework/workflow/state/_search
{
  "query": {
    "nested": {
      "path": "resources_created",
      "query": {
        "bool": {
          "must": [
            {
              "match": {
                "resources_created.workflow_step_id": "register_model_2"
              }
            }
          ]
        }
      }
    }
  }
}

{% include copy-curl.html %}

Example response

The response contains documents matching the search parameters.

1.6 KiB Raw Blame History