/turbot-pipes-pipelines | Type: Application | PCID required: Yes
Tools
turbot_pipes_pipelines_org_workspace_datatank_create
Create org workspace Datatank Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org where we want to create the workspace Datatank. |
workspace_handle | string | Yes | — | The handle of the workspace. |
description | string | No | — | description |
desired_state | string | No | — | desired_state |
handle | string | Yes | — | handle |
turbot_pipes_pipelines_org_workspace_datatank_delete
Delete org workspace Datatank Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org. |
workspace_handle | string | Yes | — | The handle of the workspace. |
datatank_handle | string | Yes | — | The name of the workspace Datatank to be deleted. |
turbot_pipes_pipelines_org_workspace_datatank_get
Get org workspace Datatank Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org. |
workspace_handle | string | Yes | — | The handle of the workspace. |
datatank_handle | string | Yes | — | The name of the workspace Datatank. |
turbot_pipes_pipelines_org_workspace_datatank_list
List org workspace Datatank Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org for which we want to list the workspace Datatank. |
workspace_handle | string | Yes | — | The handle of the workspace. |
limit | integer | No | — | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. |
next_token | string | No | — | When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data. |
turbot_pipes_pipelines_org_workspace_datatank_table_create
Create org workspace Datatank table Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org where we want to create the workspace Datatank table. |
workspace_handle | string | Yes | — | The handle of the workspace. |
datatank_handle | string | Yes | — | The name of the Datatank. |
description | string | No | — | description |
desired_state | string | No | — | desired_state |
frequency | object | No | — | frequency |
name | string | Yes | — | name |
part_per | string | No | — | part_per |
skip_initial_refresh | boolean | No | — | skip_initial_refresh |
source_query | string | No | — | source_query |
source_schema | string | No | — | source_schema |
source_table | string | No | — | source_table |
type | string | Yes | — | type |
turbot_pipes_pipelines_org_workspace_datatank_table_delete
Delete org workspace Datatank table Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org. |
workspace_handle | string | Yes | — | The handle of the workspace. |
datatank_handle | string | Yes | — | The name of the workspace Datatank to be deleted. |
datatank_table_name | string | Yes | — | The name of the workspace Datatank table. |
turbot_pipes_pipelines_org_workspace_datatank_table_get
Get org workspace Datatank table Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org where we want to create the workspace Datatank table. |
workspace_handle | string | Yes | — | The handle of the workspace. |
datatank_handle | string | Yes | — | The name of the workspace Datatank. |
datatank_table_name | string | Yes | — | The name of the workspace Datatank table. |
turbot_pipes_pipelines_org_workspace_datatank_table_list
List org workspace Datatank tables Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the user for which we want to list the workspace Datatank tables. |
workspace_handle | string | Yes | — | The handle of the workspace. |
datatank_handle | string | Yes | — | The name of the Datatank. |
limit | integer | No | — | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. |
next_token | string | No | — | When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data. |
turbot_pipes_pipelines_org_workspace_datatank_table_update
Update org workspace Datatank table Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org for which we want to list the workspace Datatank. |
workspace_handle | string | Yes | — | The handle of the workspace. |
datatank_handle | string | Yes | — | The name of the workspace Datatank. |
datatank_table_name | string | Yes | — | The name of the workspace Datatank table to be updated. |
description | string | No | — | description |
desired_state | string | No | — | desired_state |
frequency | object | No | — | frequency |
name | string | No | — | name |
skip_initial_refresh | boolean | No | — | skip_initial_refresh |
source_query | string | No | — | source_query |
source_schema | string | No | — | source_schema |
turbot_pipes_pipelines_org_workspace_datatank_update
Update org workspace Datatank Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org. |
workspace_handle | string | Yes | — | The handle of the workspace. |
datatank_handle | string | Yes | — | The name of the workspace Datatank. |
description | string | No | — | description |
desired_state | string | No | — | desired_state |
turbot_pipes_pipelines_org_workspace_flowpipe_pipeline_command
Run organization workspace Flowpipe pipeline command Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the organization which contains the workspace. |
workspace_handle | string | Yes | — | The handle of the workspace where the Flowpipe pipeline exists. |
pipeline_name | string | Yes | — | Identifier of the Flowpipe pipeline on which the command will be run. |
args | object | No | — | args |
command | string | Yes | — | command |
turbot_pipes_pipelines_org_workspace_flowpipe_pipeline_get
Get org workspace pipeline Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the organization which contains the workspace. |
workspace_handle | string | Yes | — | The handle of the workspace where the pipeline exists. |
pipeline_id | string | Yes | — | The id of the pipeline whose detail needs to be fetched. |
turbot_pipes_pipelines_org_workspace_flowpipe_pipeline_list
List organization workspace pipelines Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the organization which contains the workspace. |
workspace_handle | string | Yes | — | The handle of the workspace for which we want to list the pipelines. |
where | string | No | — | The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API. |
limit | integer | No | — | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. |
next_token | string | No | — | When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data. |
turbot_pipes_pipelines_org_workspace_flowpipe_pipeline_list_triggers
Get org workspace pipeline triggers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org which contains the workspace. |
workspace_handle | string | Yes | — | The handle of the workspace where the pipeline exists. |
pipeline_id | string | Yes | — | The id of the pipeline whose triggers need to be fetched. |
where | string | No | — | The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API. |
limit | integer | No | — | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. |
next_token | string | No | — | When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data. |
turbot_pipes_pipelines_org_workspace_flowpipe_trigger_command
Run organization workspace Flowpipe trigger command Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the organization which contains the workspace. |
workspace_handle | string | Yes | — | The handle of the workspace where the Flowpipe trigger exists. |
trigger_name | string | Yes | — | Identifier of the Flowpipe trigger on which the command will be run. |
args | object | No | — | args |
command | string | Yes | — | command |
turbot_pipes_pipelines_org_workspace_flowpipe_trigger_create
Create org workspace trigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org which contains the workspace. |
workspace_handle | string | Yes | — | The handle of the workspace where we want to create the trigger. |
args | object | Yes | — | A map of arguments to be passed to be trigger. |
description | string | No | — | Optional description for the trigger. |
name | string | No | — | The name of the trigger, has to be unique in a workspace. |
pipeline | string | Yes | — | The name / identifier of the pipeline which needs to be triggered. |
schedule | object | Yes | — | schedule |
state | string | No | — | The state of the trigger. |
title | string | No | — | Optional title for the trigger. |
turbot_pipes_pipelines_org_workspace_flowpipe_trigger_delete
Delete org workspace pipeline Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the organization which contains the workspace. |
workspace_handle | string | Yes | — | The handle of the workspace where the pipeline exists. |
trigger_name | string | Yes | — | The name of the trigger which needs to be deleted. |
turbot_pipes_pipelines_org_workspace_flowpipe_trigger_get
Get org workspace flowpipe trigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org which contains the workspace. |
workspace_handle | string | Yes | — | The handle of the workspace where the trigger exists. |
trigger_name | string | Yes | — | The name of the flowpipe trigger whose details needs to be fetched. |
turbot_pipes_pipelines_org_workspace_flowpipe_trigger_list
List organization workspace triggers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the organization which contains the workspace. |
workspace_handle | string | Yes | — | The handle of the workspace for which we want to list the triggers. |
where | string | No | — | The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API. |
limit | integer | No | — | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. |
next_token | string | No | — | When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data. |
turbot_pipes_pipelines_org_workspace_flowpipe_trigger_update
Update org workspace trigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org which contains the workspace. |
workspace_handle | string | Yes | — | The handle of the workspace where the trigger exists. |
trigger_name | string | Yes | — | The name of the trigger which needs to be updated. |
args | object | No | — | A map of arguments to be passed to be trigger. |
description | string | No | — | Optional description for the trigger. |
name | string | No | — | The name of the trigger. |
schedule | object | No | — | schedule |
state | string | No | — | The desired state of the trigger. |
title | string | No | — | Optional title for the trigger. |
turbot_pipes_pipelines_org_workspace_mod_get
Get organization workspace installed mod Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of an organization that owns the workspace. |
workspace_handle | string | Yes | — | The handle of the workspace where mod was installed. |
mod_alias | string | Yes | — | The mod alias or mod ID |
turbot_pipes_pipelines_org_workspace_mod_install
Install a mod to an organization workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of an organization that owns the workspace. |
workspace_handle | string | Yes | — | The handle of the workspace where the mod will be installed. |
branch | string | No | — | branch |
constraint | string | No | — | constraint |
integration_handle | string | No | — | integration_handle |
path | string | No | — | path |
version | string | No | — | version |
turbot_pipes_pipelines_org_workspace_mod_list
List organization workspace installed mods Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of an organization that owns the workspace. |
workspace_handle | string | Yes | — | The handle of the workspace where mods were installed |
limit | integer | No | — | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. |
next_token | string | No | — | When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data. |
turbot_pipes_pipelines_org_workspace_mod_uninstall
Uninstall mod from organization workspace. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of an organization that owns the workspace. |
workspace_handle | string | Yes | — | The handle of the workspace where the mod was installed. |
mod_alias | string | Yes | — | The mod alias or mod ID to delete. |
turbot_pipes_pipelines_org_workspace_mod_update
Update a mod in an organization workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of an organization that owns the workspace. |
workspace_handle | string | Yes | — | The handle of the workspace where the mod will be updated. |
mod_alias | string | Yes | — | The mod alias or mod ID to update. |
branch | string | No | — | branch |
constraint | string | No | — | constraint |
version | string | No | — | version |
turbot_pipes_pipelines_org_workspace_pipeline_command
Run org workspace pipeline command Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the organization which contains the workspace. |
workspace_handle | string | Yes | — | The handle of the workspace where the pipeline exists. |
pipeline_id | string | Yes | — | Id of the pipeline on which the command will be run. |
args | object | No | — | args |
command | string | Yes | — | command |
turbot_pipes_pipelines_org_workspace_pipeline_create
Create org workspace pipeline Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the organization which contains the workspace. |
workspace_handle | string | Yes | — | The handle of the workspace where we want to create the pipeline. |
args | object | Yes | — | args |
desired_state | string | No | — | The desired state of the pipeline. |
frequency | object | Yes | — | frequency |
pipeline | string | Yes | — | The name of the pipeline to be executed. |
tags | object | No | — | tags |
title | string | Yes | — | The title of the pipeline. |
turbot_pipes_pipelines_org_workspace_pipeline_delete
Delete org workspace pipeline Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the organization which contains the workspace. |
workspace_handle | string | Yes | — | The handle of the workspace where the pipeline exists. |
pipeline_id | string | Yes | — | Provide the id of the pipeline which needs to be deleted. |
turbot_pipes_pipelines_org_workspace_pipeline_get
Get org workspace pipeline Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the organization which contains the workspace. |
workspace_handle | string | Yes | — | The handle of the workspace where the pipeline exists. |
pipeline_id | string | Yes | — | The id of the pipeline whose detail needs to be fetched. |
turbot_pipes_pipelines_org_workspace_pipeline_list
List org workspace pipelines Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the organization which contains the workspace. |
workspace_handle | string | Yes | — | The handle of the workspace for which we want to list the pipelines. |
where | string | No | — | The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API. |
limit | integer | No | — | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. |
next_token | string | No | — | When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data. |
turbot_pipes_pipelines_org_workspace_pipeline_update
Update org workspace pipeline Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the organization which contains the workspace. |
workspace_handle | string | Yes | — | The handle of the workspace where the pipeline exists. |
pipeline_id | string | Yes | — | The id of the pipeline which needs to be updated. |
args | object | No | — | args |
desired_state | string | No | — | The desired state of the pipeline. |
frequency | object | No | — | frequency |
tags | object | No | — | tags |
title | string | No | — | The title of the pipeline. |

