You're viewing version 2.13 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Get workflow steps

This API returns a list of workflow steps, including their required inputs, outputs, default timeout values, and required plugins. For example, for the register_remote_model step, the Get Workflow Steps API returns the following information:

{
  "register_remote_model": {
    "inputs": [
      "name",
      "connector_id"
    ],
    "outputs": [
      "model_id",
      "register_model_status"
    ],
    "required_plugins": [
      "opensearch-ml"
    ]
  }
}

Path and HTTP methods

GET /_plugins/_flow_framework/workflow/_steps
GET /_plugins/_flow_framework/workflow/_step?workflow_step=<step_name>

Query parameters

The following table lists the available query parameters. All query parameters are optional.

Example request

To fetch all workflow steps, use the following request:

GET /_plugins/_flow_framework/workflow/_steps

To fetch specific workflow steps, pass the step names to the request as a query parameter:

GET /_plugins/_flow_framework/workflow/_step?workflow_step=create_connector,delete_model,deploy_model

Example response

OpenSearch responds with the workflow steps. The order of fields in the returned steps may not exactly match the original JSON but will function identically.

To retrieve the template in YAML format, specify Content-Type: application/yaml in the request header:

curl -XGET "http://localhost:9200/_plugins/_flow_framework/workflow/_steps" -H 'Content-Type: application/yaml'

To retrieve the template in JSON format, specify Content-Type: application/json in the request header:

curl -XGET "http://localhost:9200/_plugins/_flow_framework/workflow/_steps" -H 'Content-Type: application/json'