Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

The transformations entity to post

TransformationName
string
required

The name of the Transformation.

TransformationId
string

The id of the Transformation.

WorkspaceId
string

The id of the Workspace.

Connection
string

The destination connection, usually it is a value of Connection Name.

TransformationTriggerMode
string

Whether to run the transformation on a schedule or after a job. Defaults to None.

TriggerAfterJob
string

The specified job the transformation will run after.

TriggerAfterJobId
string

The specified job the transformation will run after.

TriggerAfterJobType
string

The type of specified job the transformation will run after.

TriggerTasks
string

A comma separated list of Task Ids.

ScheduledCron
string

The scheduler cron string.

SendEmailNotification
string

Set this to true to send email notifications after transformation is completed, default is false.

NotifyEmailTo
string

The email address where notifications will be sent to.

NotifyEmailSubject
string

The email subject for notifications.

EmailErrorOnly
string

Send the error message only.

Verbosity
string

The log verbosity level of the job, where 0 represents None, 1 represents Error, 2 represents Info, 3 represents Transfer, and 5 represents Verbose, default is 0.

RowVersion
integer<int64>

The version number of row information.

CommandTimeout
string

Controls the timeout for the connections, default is 300.

AutomaticJobRetry
string

Whether retry failed tasks, default is true.

ProjectPath
string

The project path of DBT Transformation.

DBTSchema
string

The schema of DBT Transformation.

Type
string

The type of Transformation, default is Transformation.

Threads
string

The threads count of DBT,default is 4.

ProjectType
string

The type of DBT project, default is local.

GitRepositoryURL
string

The URL of the Git repository where project resides.

GitToken
string

The token of accessing Git.

IsTrigger
string

The trigger of after job, default is false.

Scheduled
string

Set this to true to the job can be executed according to a specific scheduler, default is false.

HistoryId
string

The historyId of Transformations, default is 0.

WithHistory
string

When true, return info contains history, default is false.

EnableParallelProcessing
string

Whether allow current transformation to support parallel processing of queries, default is false.

WorkerPool
string

The size of threads in worker pool, default is 2.

CanUpdate
string

Whether the current entity can be updated.

CanRemove
string

Whether the current entity can be removed.

CanExecute
string

Whether the current entity can be executed.

Response

transformations created

TransformationName
string
required

The name of the Transformation.

TransformationId
string

The id of the Transformation.

WorkspaceId
string

The id of the Workspace.

Connection
string

The destination connection, usually it is a value of Connection Name.

TransformationTriggerMode
string

Whether to run the transformation on a schedule or after a job. Defaults to None.

TriggerAfterJob
string

The specified job the transformation will run after.

TriggerAfterJobId
string

The specified job the transformation will run after.

TriggerAfterJobType
string

The type of specified job the transformation will run after.

TriggerTasks
string

A comma separated list of Task Ids.

ScheduledCron
string

The scheduler cron string.

SendEmailNotification
string

Set this to true to send email notifications after transformation is completed, default is false.

NotifyEmailTo
string

The email address where notifications will be sent to.

NotifyEmailSubject
string

The email subject for notifications.

EmailErrorOnly
string

Send the error message only.

Verbosity
string

The log verbosity level of the job, where 0 represents None, 1 represents Error, 2 represents Info, 3 represents Transfer, and 5 represents Verbose, default is 0.

RowVersion
integer<int64>

The version number of row information.

CommandTimeout
string

Controls the timeout for the connections, default is 300.

AutomaticJobRetry
string

Whether retry failed tasks, default is true.

ProjectPath
string

The project path of DBT Transformation.

DBTSchema
string

The schema of DBT Transformation.

Type
string

The type of Transformation, default is Transformation.

Threads
string

The threads count of DBT,default is 4.

ProjectType
string

The type of DBT project, default is local.

GitRepositoryURL
string

The URL of the Git repository where project resides.

GitToken
string

The token of accessing Git.

IsTrigger
string

The trigger of after job, default is false.

Scheduled
string

Set this to true to the job can be executed according to a specific scheduler, default is false.

HistoryId
string

The historyId of Transformations, default is 0.

WithHistory
string

When true, return info contains history, default is false.

EnableParallelProcessing
string

Whether allow current transformation to support parallel processing of queries, default is false.

WorkerPool
string

The size of threads in worker pool, default is 2.

CanUpdate
string

Whether the current entity can be updated.

CanRemove
string

Whether the current entity can be removed.

CanExecute
string

Whether the current entity can be executed.