Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameters:
  • tenant – User tenant.
  • project_id – Project identifier.
  • workflow_id – Pipeline workflow identifier.
Form Parameters:
  • name – The name for the new pipeline workflow.
  • title – The title for the new pipeline workflow.
  • steps – JSON-encoded list of dictionaries describing the pipeline workflow steps with their configuration
Headers:See Common Headers.
Status Codes:
  • 200202 – Pipeline workflow updated.

See also Common Status Codes.

Returns:

The modified pipeline workflow.

Code Block
js
js
{
    "name": "default",
    "title": "Default Pipeline Workflow",
    "project_default": true,
    "steps": [
        {
            "name": "Custom Pipelet 1"
            "type": "pipelet",
            "config": {
                "pipelet": "squirro/pipelet_1_implementation",
                "config": {
                    "pipelet_param_1": "value_1"
                }
            },
            "id": "ZOuHRfAQQ6ST59cAa9FOhQ"
        },
        {
            "name": "Index"
            "type": "index",
            "id": "index",
        },
        {
            "name": "Custom Keyword 1",
            "type": "keyword",
            "config": {
                "keywords": {
                    "key_1": [
                        "value_1"
                    ]
                },
                "query": "Keyword Query 1"
            },
            "id": "oX5OvLhBQxuMVBYt0VbnhA"
        }
    ],
    "id": "kAvdogQOQvGHijqcIPi_WA",
    "project_id": "FzbcEMMNTBeQcG2wnwnxLQ"
}


Move Pipeline Workflow Step

PUT https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/pipeline_workflows/(id: workflow_id)/steps/(id: step_id)/move

Updates a pipeline workflow by moving a step of type Pipelet to a new position among the workflow steps.

Parameters:
  • tenant – User tenant.
  • project_id – Project identifier.
  • workflow_id – Pipeline workflow identifier.
  • step_id – Pipelet step identifier.
Form Parameters:
  • after (optional) – The step identifier of the step to precede the moved pipelet step with step_id. If the after parameter is omitted, the pipelet step is placed at the beginning of the pipeline workflow steps.
Headers:See Common Headers.
Status Codes:
  • 202 – Pipeline workflow updated.

See also Common Status Codes.

Returns:

The pipeline workflow with the modified steps.

Code Block
js
js
{
    "name": "default",
    "title": "Default Pipeline Workflow",
    "project_default": true,
    "steps": [
        {
            "name": "Custom Pipelet 1"
            "type": "pipelet",
            "config": {
                "pipelet": "squirro/pipelet_1_implementation",
                "config": {
                    "pipelet_param_1": "value_1"
                }
            },
            "id": "ZOuHRfAQQ6ST59cAa9FOhQ"
        },
        {
            "name": "Index"
            "type": "index",
            "id": "index",
        },
        {
            "name": "Custom Keyword 1",
            "type": "keyword",
            "config": {
                "keywords": {
                    "key_1": [
                        "value_1"
                    ]
                },
                "query": "Keyword Query 1"
            },
            "id": "oX5OvLhBQxuMVBYt0VbnhA"
        }
    ],
    "id": "kAvdogQOQvGHijqcIPi_WA",
    "project_id": "FzbcEMMNTBeQcG2wnwnxLQ"
}


...