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.

You can retrieve created workflows with their workflow_id or search for workflows by using a query matching a field. You can use the use_case field to search for similar workflows.

Path and HTTP methods

  1. GET /_plugins/_flow_framework/workflow/_search
  2. POST /_plugins/_flow_framework/workflow/_search

Example request: All created workflows

  1. GET /_plugins/_flow_framework/workflow/_search
  2. {
  3.   "query": {
  4.     "match_all": {}
  5.   }
  6. }

copy

Example request: All workflows with a use_case of REMOTE_MODEL_DEPLOYMENT

  1. GET /_plugins/_flow_framework/workflow/_search
  2. {
  3.   "query": {
  4.     "match": {
  5.       "use_case": "REMOTE_MODEL_DEPLOYMENT"
  6.     }
  7.   }
  8. }

copy

Example response

OpenSearch responds with a list of workflow templates matching the search parameters.