Pipeline Workflows

Owned by Oliver Seeliger (Unlicensed)
Last updated: Feb 24, 2022 by Claudio Jordi (Deactivated)
11 min read

Pipeline Workflows control the steps applied to data imported into projects via subscriptions (referred to as Data Sources in the graphical user interface).

Methods

List Pipeline Workflows

GET https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/pipeline_workflows

Returns an array of all pipeline workflows in a project.

Parameters:
  • tenant – User tenant.
  • project_id – Project identifier.
Query Parameters:
  • omit_steps (optional) – If set to true all the arrays of pipeline workflow steps are omitted.
Headers:See Common Headers.
Status Codes:
  • 200 – Array of pipeline workflows is returned.

See also Common Status Codes.

Returns:

Array of pipeline workflows.

[
    {
        "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"
    }
]

Create Pipeline Workflow

POST https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/pipeline_workflows

Adds a new pipeline workflow to the project.

Parameters:
  • tenant – User tenant.
  • project_id – Project 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:
  • 201 – Pipeline workflow created.

See also Common Status Codes.

Returns:

The created pipeline workflow.

{
    "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"
}

Get Pipeline Workflow

GET https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/pipeline_workflows/(id: workflow_id)

Return details about an individual pipeline workflow.

Parameters:
  • tenant – User tenant.
  • project_id – Project identifier.
  • workflow_id – Pipeline workflow identifier.
Query Parameters:
  • omit_steps (optional) – If set to true the array of pipeline workflow steps is omitted.
Headers:See Common Headers.
Status Codes:
  • 200 – Pipeline workflow returned.

See also Common Status Codes.

Returns:

The pipeline workflow.

{
    "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"
}

Update Pipeline Workflow

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

Updates a pipeline workflow.

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:
  • 202 – Pipeline workflow updated.

See also Common Status Codes.

Returns:

The modified pipeline workflow.

{
    "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.

{
    "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"
}

Delete Pipeline Workflow

DELETE https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/pipeline_workflows/(id: workflow_id)

Delete a pipeline workflow.

Parameters:
  • tenant – User tenant.
  • project_id – Project identifier.
  • workflow_id – Pipeline workflow identifier.
Headers:See Common Headers.
Status Codes:
  • 204 – Pipeline workflow deleted.

See also Common Status Codes.