Pipeline Workflows control the steps applied to data imported into projects via subscriptions. WORK IN PROGRESS FOR RELEASE 2.6.0. TODO: Detail the format of steps.
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: |
|
---|---|
Query Parameters: |
|
Headers: | See Common Headers. |
Status Codes: |
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: |
|
---|---|
Form Parameters: |
|
Headers: | See Common Headers. |
Status Codes: |
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: |
|
---|---|
Query Parameters: |
|
Headers: | See Common Headers. |
Status Codes: |
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: |
|
---|---|
Form Parameters: |
|
Headers: | See Common Headers. |
Status Codes: |
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: |
|
---|---|
Form Parameters: | |
Headers: | See Common Headers. |
Status Codes: |
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: |
|
---|---|
Headers: | See Common Headers. |
Status Codes: |
See also Common Status Codes. |