mirror of
https://github.com/iSharkFly-Docs/opensearch-docs-cn
synced 2025-03-08 06:39:29 +00:00
6c92b54eba
* Add flow framework documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update _automating-workflows/api/create-workflow.md Co-authored-by: Owais Kazi <owaiskazi19@gmail.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Add callout of edges being optional Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add unregister to word list Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add registering local pretrained and custom models Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _automating-workflows/api/deprovision-workflow.md Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _automating-workflows/workflow-steps.md Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Added Flow Framework plugin to Vale Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * More editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update _automating-workflows/api/get-workflow-status.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _automating-workflows/api/get-workflow-status.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Add note about provisioning Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update _automating-workflows/index.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _automating-workflows/workflow-steps.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * More editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Removed code font from headings Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add agent documentation links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add experimental label and more links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add sample templates link Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added a tracking issue to warning Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Owais Kazi <owaiskazi19@gmail.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
1.7 KiB
1.7 KiB
| layout | title | parent | nav_order |
|---|---|---|---|
| default | Get a workflow | Workflow APIs | 20 |
Get 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}
The Get Workflow API retrieves the workflow template.
Path and HTTP methods
GET /_plugins/_flow_framework/workflow/<workflow_id>
Path parameters
The following table lists the available path parameters.
| Parameter | Data type | Description |
|---|---|---|
workflow_id |
String | The ID of the workflow to be retrieved. Required. |
Example request
GET /_plugins/_flow_framework/workflow/8xL8bowB8y25Tqfenm50
{% include copy-curl.html %}
Example response
To retrieve a template in YAML format, specify Content-Type: application/yaml in the request header:
curl -XGET "http://localhost:9200/_plugins/_flow_framework/workflow/8xL8bowB8y25Tqfenm50" -H 'Content-Type: application/yaml'
To retrieve a template in JSON format, specify Content-Type: application/json in the request header:
curl -XGET "http://localhost:9200/_plugins/_flow_framework/workflow/8xL8bowB8y25Tqfenm50" -H 'Content-Type: application/json'
OpenSearch responds with the stored template containing the same content as the body of the create workflow request. The order of fields in the returned template may not exactly match the original template but will function identically.