{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace." }, "datatank_handle": { "type": "string", "description": "The name of the workspace Datatank to be deleted." } }, "required": [ "PCID", "org_handle", "workspace_handle", "datatank_handle" ]}
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace." }, "datatank_handle": { "type": "string", "description": "The name of the workspace Datatank." } }, "required": [ "PCID", "org_handle", "workspace_handle", "datatank_handle" ]}
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org for which we want to list the workspace Datatank." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace." }, "limit": { "type": "integer", "description": "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": { "type": "string", "description": "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." } }, "required": [ "PCID", "org_handle", "workspace_handle" ]}
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace." }, "datatank_handle": { "type": "string", "description": "The name of the workspace Datatank to be deleted." }, "datatank_table_name": { "type": "string", "description": "The name of the workspace Datatank table." } }, "required": [ "PCID", "org_handle", "workspace_handle", "datatank_handle", "datatank_table_name" ]}
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org where we want to create the workspace Datatank table." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace." }, "datatank_handle": { "type": "string", "description": "The name of the workspace Datatank." }, "datatank_table_name": { "type": "string", "description": "The name of the workspace Datatank table." } }, "required": [ "PCID", "org_handle", "workspace_handle", "datatank_handle", "datatank_table_name" ]}
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the user for which we want to list the workspace Datatank tables." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace." }, "datatank_handle": { "type": "string", "description": "The name of the Datatank." }, "limit": { "type": "integer", "description": "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": { "type": "string", "description": "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." } }, "required": [ "PCID", "org_handle", "workspace_handle", "datatank_handle" ]}
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
—
The description value
desired_state
string
No
—
Desired State
frequency
object
No
—
The frequency value
name
string
No
—
The name value
skip_initial_refresh
boolean
No
—
Skip Initial Refresh
source_query
string
No
—
Source Query
source_schema
string
No
—
Source Schema
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org for which we want to list the workspace Datatank." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace." }, "datatank_handle": { "type": "string", "description": "The name of the workspace Datatank." }, "datatank_table_name": { "type": "string", "description": "The name of the workspace Datatank table to be updated." }, "description": { "type": "string", "description": "The description value" }, "desired_state": { "type": "string", "description": "Desired State", "enum": [ "enabled", "disabled", "paused" ] }, "frequency": { "type": "object", "description": "The frequency value", "properties": { "schedule": { "type": "string", "description": "The schedule for the pipeline if the type is interval or cron." }, "type": { "type": "string", "description": "The type of frequency. Can be interval, cron or manual." } }, "required": [ "type" ] }, "name": { "type": "string", "description": "The name value" }, "skip_initial_refresh": { "type": "boolean", "description": "Skip Initial Refresh" }, "source_query": { "type": "string", "description": "Source Query" }, "source_schema": { "type": "string", "description": "Source Schema" } }, "required": [ "PCID", "org_handle", "workspace_handle", "datatank_handle", "datatank_table_name" ]}
Run organization workspace Flowpipe pipeline commandParameters:
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
—
The args value
command
string
Yes
—
The command value
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the organization which contains the workspace." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace where the Flowpipe pipeline exists." }, "pipeline_name": { "type": "string", "description": "Identifier of the Flowpipe pipeline on which the command will be run." }, "args": { "type": "object", "description": "The args value" }, "command": { "type": "string", "description": "The command value", "enum": [ "run" ] } }, "required": [ "PCID", "org_handle", "workspace_handle", "pipeline_name", "command" ]}
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the organization which contains the workspace." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace where the pipeline exists." }, "pipeline_id": { "type": "string", "description": "The id of the pipeline whose detail needs to be fetched." } }, "required": [ "PCID", "org_handle", "workspace_handle", "pipeline_id" ]}
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the organization which contains the workspace." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace for which we want to list the pipelines." }, "where": { "type": "string", "description": "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": { "type": "integer", "description": "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": { "type": "string", "description": "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." } }, "required": [ "PCID", "org_handle", "workspace_handle" ]}
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org which contains the workspace." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace where the pipeline exists." }, "pipeline_id": { "type": "string", "description": "The id of the pipeline whose triggers need to be fetched." }, "where": { "type": "string", "description": "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": { "type": "integer", "description": "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": { "type": "string", "description": "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." } }, "required": [ "PCID", "org_handle", "workspace_handle", "pipeline_id" ]}
Run organization workspace Flowpipe trigger commandParameters:
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
—
The args value
command
string
Yes
—
The command value
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the organization which contains the workspace." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace where the Flowpipe trigger exists." }, "trigger_name": { "type": "string", "description": "Identifier of the Flowpipe trigger on which the command will be run." }, "args": { "type": "object", "description": "The args value" }, "command": { "type": "string", "description": "The command value", "enum": [ "run", "reset" ] } }, "required": [ "PCID", "org_handle", "workspace_handle", "trigger_name", "command" ]}
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
—
The schedule value
state
string
No
—
The state of the trigger.
title
string
No
—
Optional title for the trigger.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org which contains the workspace." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace where we want to create the trigger." }, "args": { "type": "object", "description": "A map of arguments to be passed to be trigger." }, "description": { "type": "string", "description": "Optional description for the trigger." }, "name": { "type": "string", "description": "The name of the trigger, has to be unique in a workspace." }, "pipeline": { "type": "string", "description": "The name / identifier of the pipeline which needs to be triggered." }, "schedule": { "type": "object", "description": "The schedule value", "properties": { "schedule": { "type": "string", "description": "The schedule for the pipeline if the type is interval or cron." }, "type": { "type": "string", "description": "The type of frequency. Can be interval, cron or manual." } }, "required": [ "type" ] }, "state": { "type": "string", "description": "The state of the trigger.", "enum": [ "enabled", "disabled" ] }, "title": { "type": "string", "description": "Optional title for the trigger." } }, "required": [ "PCID", "org_handle", "workspace_handle", "args", "pipeline", "schedule" ]}
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the organization which contains the workspace." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace where the pipeline exists." }, "trigger_name": { "type": "string", "description": "The name of the trigger which needs to be deleted." } }, "required": [ "PCID", "org_handle", "workspace_handle", "trigger_name" ]}
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org which contains the workspace." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace where the trigger exists." }, "trigger_name": { "type": "string", "description": "The name of the flowpipe trigger whose details needs to be fetched." } }, "required": [ "PCID", "org_handle", "workspace_handle", "trigger_name" ]}
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the organization which contains the workspace." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace for which we want to list the triggers." }, "where": { "type": "string", "description": "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": { "type": "integer", "description": "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": { "type": "string", "description": "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." } }, "required": [ "PCID", "org_handle", "workspace_handle" ]}
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
—
The schedule value
state
string
No
—
The desired state of the trigger.
title
string
No
—
Optional title for the trigger.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org which contains the workspace." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace where the trigger exists." }, "trigger_name": { "type": "string", "description": "The name of the trigger which needs to be updated." }, "args": { "type": "object", "description": "A map of arguments to be passed to be trigger." }, "description": { "type": "string", "description": "Optional description for the trigger." }, "name": { "type": "string", "description": "The name of the trigger." }, "schedule": { "type": "object", "description": "The schedule value", "properties": { "schedule": { "type": "string", "description": "The schedule for the pipeline if the type is interval or cron." }, "type": { "type": "string", "description": "The type of frequency. Can be interval, cron or manual." } }, "required": [ "type" ] }, "state": { "type": "string", "description": "The desired state of the trigger.", "enum": [ "enabled", "disabled" ] }, "title": { "type": "string", "description": "Optional title for the trigger." } }, "required": [ "PCID", "org_handle", "workspace_handle", "trigger_name" ]}
Get organization workspace installed modParameters:
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
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of an organization that owns the workspace." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace where mod was installed." }, "mod_alias": { "type": "string", "description": "The mod alias or mod ID" } }, "required": [ "PCID", "org_handle", "workspace_handle", "mod_alias" ]}
Install a mod to an organization workspaceParameters:
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
—
The branch value
constraint
string
No
—
The constraint value
integration_handle
string
No
—
Integration Handle
path
string
No
—
The path value
version
string
No
—
The version value
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of an organization that owns the workspace." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace where the mod will be installed." }, "branch": { "type": "string", "description": "The branch value" }, "constraint": { "type": "string", "description": "The constraint value" }, "integration_handle": { "type": "string", "description": "Integration Handle" }, "path": { "type": "string", "description": "The path value" }, "version": { "type": "string", "description": "The version value" } }, "required": [ "PCID", "org_handle", "workspace_handle" ]}
List organization workspace installed modsParameters:
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of an organization that owns the workspace." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace where mods were installed" }, "limit": { "type": "integer", "description": "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": { "type": "string", "description": "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." } }, "required": [ "PCID", "org_handle", "workspace_handle" ]}
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of an organization that owns the workspace." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace where the mod was installed." }, "mod_alias": { "type": "string", "description": "The mod alias or mod ID to delete." } }, "required": [ "PCID", "org_handle", "workspace_handle", "mod_alias" ]}
Update a mod in an organization workspaceParameters:
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
—
The branch value
constraint
string
No
—
The constraint value
version
string
No
—
The version value
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of an organization that owns the workspace." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace where the mod will be updated." }, "mod_alias": { "type": "string", "description": "The mod alias or mod ID to update." }, "branch": { "type": "string", "description": "The branch value" }, "constraint": { "type": "string", "description": "The constraint value" }, "version": { "type": "string", "description": "The version value" } }, "required": [ "PCID", "org_handle", "workspace_handle", "mod_alias" ]}
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
—
The args value
command
string
Yes
—
The command value
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the organization which contains the workspace." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace where the pipeline exists." }, "pipeline_id": { "type": "string", "description": "Id of the pipeline on which the command will be run." }, "args": { "type": "object", "description": "The args value" }, "command": { "type": "string", "description": "The command value", "enum": [ "run" ] } }, "required": [ "PCID", "org_handle", "workspace_handle", "pipeline_id", "command" ]}
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
—
The args value
desired_state
string
No
—
The desired state of the pipeline.
frequency
object
Yes
—
The frequency value
pipeline
string
Yes
—
The name of the pipeline to be executed.
tags
object
No
—
The tags value
title
string
Yes
—
The title of the pipeline.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the organization which contains the workspace." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace where we want to create the pipeline." }, "args": { "description": "The args value" }, "desired_state": { "type": "string", "description": "The desired state of the pipeline.", "enum": [ "enabled", "disabled" ] }, "frequency": { "type": "object", "description": "The frequency value", "properties": { "schedule": { "type": "string", "description": "The schedule for the pipeline if the type is interval or cron." }, "type": { "type": "string", "description": "The type of frequency. Can be interval, cron or manual." } }, "required": [ "type" ] }, "pipeline": { "type": "string", "description": "The name of the pipeline to be executed.", "enum": [ "pipeline.snapshot_dashboard", "pipeline.snapshot_query" ] }, "tags": { "description": "The tags value" }, "title": { "type": "string", "description": "The title of the pipeline." } }, "required": [ "PCID", "org_handle", "workspace_handle", "args", "frequency", "pipeline", "title" ]}
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the organization which contains the workspace." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace where the pipeline exists." }, "pipeline_id": { "type": "string", "description": "Provide the id of the pipeline which needs to be deleted." } }, "required": [ "PCID", "org_handle", "workspace_handle", "pipeline_id" ]}
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the organization which contains the workspace." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace where the pipeline exists." }, "pipeline_id": { "type": "string", "description": "The id of the pipeline whose detail needs to be fetched." } }, "required": [ "PCID", "org_handle", "workspace_handle", "pipeline_id" ]}
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the organization which contains the workspace." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace for which we want to list the pipelines." }, "where": { "type": "string", "description": "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": { "type": "integer", "description": "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": { "type": "string", "description": "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." } }, "required": [ "PCID", "org_handle", "workspace_handle" ]}
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
—
The args value
desired_state
string
No
—
The desired state of the pipeline.
frequency
object
No
—
The frequency value
tags
object
No
—
The tags value
title
string
No
—
The title of the pipeline.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the organization which contains the workspace." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace where the pipeline exists." }, "pipeline_id": { "type": "string", "description": "The id of the pipeline which needs to be updated." }, "args": { "description": "The args value" }, "desired_state": { "type": "string", "description": "The desired state of the pipeline.", "enum": [ "enabled", "disabled" ] }, "frequency": { "type": "object", "description": "The frequency value", "properties": { "schedule": { "type": "string", "description": "The schedule for the pipeline if the type is interval or cron." }, "type": { "type": "string", "description": "The type of frequency. Can be interval, cron or manual." } }, "required": [ "type" ] }, "tags": { "description": "The tags value" }, "title": { "type": "string", "description": "The title of the pipeline." } }, "required": [ "PCID", "org_handle", "workspace_handle", "pipeline_id" ]}