Arguments

Name	Description	Default
pipelineName R	The name of the pipeline
listenerName R	The name of the listener

SQL Call

exec Pipeline.ClearErrors 'sharepoint-usstates', 'sql-listener'

Http Call

/bsc/pipeline/clearerrors

Output Columns

This call does not return data.

Arguments

Name	Description	Default
pipelineName R	The name of the pipeline
name R	The name of the listener
system R	The destination system (AzureBusTopic,Twilio,SQL...)
config	The name of the destination adapter configuration
remoteObject	The name of the remote object, table or endpoint
mode	The processing mode of the listener (each,batch)	each
initialize	When 1 send all initialization data	False
deleteCDC	When 1 send all delete operations	False
upsertCDC	When 1 send all upsert operations	False
columns	List of columns for forward (leave blank for all)
filter	Destination SQL-Like filter
options	JSON object providing options specific to the destination adapter

SQL Call

exec Pipeline.CreateListener 'sharepoint-usstates', 'sql-listener-usstates'

Http Call

/bsc/pipeline/createlistener

Output Columns

This call does not return data.

Arguments

Name	Description	Default
name R	The name of the pipeline
adapter R	The name of the source adapter
config R	The configuration name of the source adapter
sourceTable R	The source table to read from
interval	The polling interval to the source system as a cron expression
mode	The pipeline mode (CDC,Sync,CDCSync)
filter	Adapter-specific filter if required (ex: Twitter)

SQL Call

exec Pipeline.CreatePipeline 'sharepoint-usstates', 'sharepoint', 'sp-config', 'USStates', 'az-config', '* * /5 * * ?', 'cdcsync'

Http Call

/bsc/pipeline/createpipeline

Output Columns

This call does not return data.

Arguments

Name	Description	Default
pipelineName R	The name of the pipeline
listenerName R	The name of the listener

SQL Call

exec Pipeline.DeleteListener 'sharepoint-usstates', 'sql-listener-usstates'

Http Call

/bsc/pipeline/deletelistener

Output Columns

This call does not return data.

Arguments

Name	Description	Default
name R	The name of the listener

SQL Call

exec Pipeline.DeletePipeline 'sharepoint-usstates'

Http Call

/bsc/pipeline/deletepipeline

Output Columns

This call does not return data.

Arguments

Name	Description	Default
pipelineName R	The name of the pipeline
listenerName R	The name of the listener

SQL Call

exec Pipeline.DisableListener 'sharepoint-usstates', 'sql-listener'

Http Call

/bsc/pipeline/disablelistener

Output Columns

This call does not return data.

Arguments

Name	Description	Default
name R	The name of the pipeline

SQL Call

exec Pipeline.DisablePipeline 'sharepoint-usstates'

Http Call

/bsc/pipeline/disablepipeline

Output Columns

This call does not return data.

Arguments

Name	Description	Default
pipelineName R	The name of the pipeline
listenerName R	The name of the listener

SQL Call

exec Pipeline.EnableListener 'sharepoint-usstates', 'sql-listener'

Http Call

/bsc/pipeline/enablelistener

Output Columns

This call does not return data.

Arguments

Name	Description	Default
name R	The name of the pipeline

SQL Call

exec Pipeline.EnablePipeline 'sharepoint-usstates'

Http Call

/bsc/pipeline/enablepipeline

Output Columns

This call does not return data.

Arguments

Name	Description	Default
dbName	The database name to connect to (leave blank for Azure SQL Databases)
schemaName R	The schema name to use	dbo
tableName R	The table name to create
connectionStr R	The Central Connection String name
fields R	The list of fields selected from the source pipeline

SQL Call

exec Pipeline.GetCreateDDL 'datalake', 'twitterschema', 'twitter-capture1', 'localsqldb001', 'string id,int age' 

Http Call

/bsc/pipeline/getcreateddl

Output Columns

String sql

Arguments

Name	Description	Default
executionId R	The execution id
pipelineName R	The name of the pipeline

SQL Call

exec Pipeline.GetExecutionLog '87632ad6-9d4c-4ff1-bf61-91159f3857be'

Http Call

/bsc/pipeline/getexecutionlog

Output Columns

String executionId
DateTime eventDate
String message
String level
String pipelineName
String listenerName
String pipelineId
String listenerId

Arguments

Name	Description	Default
pipelineName R	The name of the pipeline
listenerName	The name of the listener

SQL Call

exec Pipeline.GetExecutions 'pipelineName'
exec Pipeline.GetExecutions 'pipelineName', 'listenerName'

Http Call

/bsc/pipeline/getexecutions

Output Columns

String ExecutionId
DateTime ExecutionDate
String ErrorMessage
String StackTrace
Int32 RecordCount
Int32 TotalMin
Int32 Year
Int32 Month
Int32 Day
Int32 Hour
Int32 Minute
String PipelineName
String ListenerName
String PipelineId
String ListenerId

Arguments

Name	Description	Default
pipelineName	The name of the pipeline to filter on

SQL Call

exec Pipeline.GetJobStats

Http Call

/bsc/pipeline/getjobstats

Output Columns

String pipelineName
String listenerName
String status
String lastSyncId
Int64 lastProcessedCount
Int64 lastErrorCount
Double lastTotalKB
Int64 totalProcessedCount
Int64 totalErrorCount
String lastRunTime
String resultMessage
String stackTrace
Boolean replaying
String pipelineIdentifier
String listenerIdentifier
String disabled

Arguments

Name	Description	Default
pipelineName	The name of the pipeline
listenerName	The name of the listener (starts with)

SQL Call

exec Pipeline.GetListeners 'sharepoint-usstates' 

Http Call

/bsc/pipeline/listlisteners

Output Columns

String pipelineName	The name of the pipeline
String name	The name of the listener
String identifier	The internal unique id for this pipeline
String owner	The owner of the pipeline
Boolean enabled	true when the pipeline is enabled
DateTime createdOn	The date the pipeline was created
String system	The destination system (AzureBusTopic,Twilio,SQL...)
String config	The name of the destination adapter configuration
String remoteObject	The name of the remote object, table or endpoint
String mode	The processing mode of the listener (each,batch)
Boolean initialize	When 1 send all initialization data
Boolean deleteCDC	When 1 send all delete operations
Boolean upsertCDC	When 1 send all upsert operations
String columns	List of columns for forward (leave blank for all)
String filter	Destination SQL-Like filter
String options	JSON object providing options specific to the destination adapter
DateTime lastPingedOn	Last date/time the listener sent a Ping while running
Boolean isInit	True when the listener is currently processing items from the INIT log
Boolean isReplaying	True when the listener is replaying from the CDC log as requested
Boolean hasRetries	True when the listener has items to retry at the next execution cycle
Boolean hasErrors	True when the listener has errors that will not be retried automatically
Boolean clearErrors	True when errors will be deleted at the next execution cycle, as requested
Boolean replayErrors	True when errors will be replayed at the next execution cycle, as requested

Arguments

Name	Description	Default
name	The name of the pipeline (starts with)

SQL Call

exec Pipeline.ListPipelines

Http Call

/bsc/pipeline/listpipelines

Output Columns

String name	The name of the pipeline
String identifier	The internal unique id for this pipeline
String owner	The owner of the pipeline
Boolean enabled	true when the pipeline is enabled
DateTime createdOn	The date the pipeline was created
String adapter	The name of the source adapter
String config	The configuration name of the source adapter
String sourceTable	The source table to read from
String interval	The polling interval to the source system as a cron expression
String mode	The pipeline mode (CDC,Sync,CDCSync)
String filter	Adapter-specific filter if required (ex: Twitter)
String columnList	List of columns available from the source system
String IDs	The Primary Key of the source system (if any)

Arguments

Name	Description	Default
pipelineName R	The name of the pipeline
listenerName R	The name of the listener

SQL Call

exec Pipeline.reinitialize 'pipeline001', 'listener001'

Http Call

/bsc/pipeline/reinitialize

Output Columns

This call does not return data.

Arguments

Name	Description	Default
pipelineName R	The name of the pipeline
listenerName R	The name of the listener
startTime R	Replay date (in UTC). Send an empty string to replay the complete CDC log

SQL Call

exec Pipeline.replay 'pipeline001', 'listener001', '2019-03-02t03:41:12.4760949z'

Http Call

/bsc/pipeline/replay

Output Columns

This call does not return data.

Arguments

Name	Description	Default
pipelineName R	The name of the pipeline
listenerName R	The name of the listener

SQL Call

exec Pipeline.ReplayErrors 'sharepoint-usstates', 'sql-listener'

Http Call

/bsc/pipeline/replayerrors

Output Columns

This call does not return data.

Arguments

Name	Description	Default
pipelineName R	The name of the pipeline
name R	The name of the listener

SQL Call

exec Pipeline.RunListener 'sharepoint-usstates'

Http Call

/bsc/pipeline/runlistener

Output Columns

This call does not return data.

Arguments

Name	Description	Default
name R	The name of the pipeline

SQL Call

exec Pipeline.RunPipeline 'sharepoint-usstates'

Http Call

/bsc/pipeline/runpipeline

Output Columns

This call does not return data.

Arguments

Name	Description	Default
name R	The name of the pipeline
interval R	The polling interval to the source system as a cron expression

SQL Call

exec Pipeline.UpdatePipelineSchedule 'sharepoint-usstates',  '* * /5 * * ?'

Http Call

/bsc/pipeline/updatepipelineschedule

Output Columns

This call does not return data.