CloudWorks
BaseConnectionInput
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
workspace_id
|
str | None
|
If you are a restricted integration user, add the Workspace ID to which you have access in the payload. |
None
|
AzureBlobConnectionInfo
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
The name of the Azure Blob connection. |
required |
storage_account_name
|
str
|
The name of the Azure Storage account. |
required |
container_name
|
str
|
The name of the Azure Blob container. |
required |
AzureBlobConnectionInput
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sas_token
|
str
|
The SAS token for the Azure Blob connection. Must be created on the container directly and not on any child blobs and have at least 'Read' and 'List' permissions. |
required |
AmazonS3ConnectionInfo
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
The name of the Amazon S3 connection. |
required |
bucket_name
|
str
|
The name of the Amazon S3 bucket. |
required |
AmazonS3ConnectionInput
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
access_key_id
|
str
|
The access key ID for the Amazon S3 connection. |
required |
secret_access_key
|
str
|
The secret access key for the Amazon S3 connection. |
required |
GoogleBigQueryConnectionInfo
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
The name of the Google BigQuery connection. |
required |
dataset
|
str
|
The ID of the Google BigQuery dataset. |
required |
GoogleServiceAccountJson
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
type
|
str
|
The type of the service account. |
required |
project_id
|
str
|
The project ID of the service account. |
required |
private_key_id
|
str
|
The private key ID of the service account. |
required |
private_key
|
str
|
The private key of the service account. |
required |
client_email
|
str
|
The client email of the service account. |
required |
client_id
|
str
|
The client ID of the service account. |
required |
auth_uri
|
str
|
The authentication URI of the service account. |
required |
token_uri
|
str
|
The token URI of the service account. |
required |
auth_provider_x509_cert_url
|
str
|
The authentication provider's X.509 certificate URL. |
required |
client_x509_cert_url
|
str
|
The client's X.509 certificate URL. |
required |
GoogleBigQueryConnectionInput
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
serviceAccountKey
|
GoogleServiceAccountJson
|
The service account JSON for the Google BigQuery connection. |
required |
ConnectionInput
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
type
|
Literal[str, str, str]
|
The type of this connection. |
required |
body
|
AzureBlobConnectionInput | AmazonS3ConnectionInput | GoogleBigQueryConnectionInput
|
Connection information. |
required |
Connection
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_id
|
str
|
The unique identifier of this connection. |
required |
connection_type
|
Literal[str, str, str]
|
The type of this connection. |
required |
body
|
AzureBlobConnectionInfo | AmazonS3ConnectionInfo | GoogleBigQueryConnectionInfo
|
Connection information. |
required |
status
|
int
|
The status of this connection. 1 indicates a valid connection, 0 indicates an invalid connection. |
required |
integration_error_code
|
str | None
|
The error code of the connection, if any. |
required |
workspace_id
|
str | None
|
The workspace that was given when creating this connection. |
required |
LatestRun
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
triggered_by
|
str
|
The user who triggered this run. |
required |
start_date
|
datetime
|
The start timestamp of this run. |
required |
end_date
|
datetime | None
|
The end timestamp of this run. This can be None, if the integration is currently running. |
None
|
success
|
bool
|
Whether this run was successful. |
required |
message
|
str
|
Result message of this run. |
required |
execution_error_code
|
int | None
|
Error code if run failed. |
None
|
trigger_source
|
str | None
|
Source that triggered the run. |
None
|
ScheduleBase
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
Name of the schedule. |
required |
type
|
Literal[str, str, str, str, str]
|
Trigger Frequency |
required |
timezone
|
Literal[str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str]
|
Timezone for the schedule. |
required |
ScheduleInput
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
time
|
str | None
|
Time for scheduled runs in HH:mm format. |
None
|
from_time
|
str | None
|
Time for scheduled runs in HH:mm format, if type is hourly. |
None
|
to_time
|
str | None
|
Time for scheduled runs in HH:mm format, if type is hourly. |
None
|
days_of_week
|
list[int]
|
Days of week when schedule is active. |
required |
start_date
|
str
|
Start date for the schedule in YYYY-MM-DD format. Must be in the Future, i.e. current day, if the |
required |
end_date
|
str | None
|
End date for the schedule in YYYY-MM-DD format. Must be in the Future, i.e. current day, if the |
None
|
Schedule
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
time
|
str | None
|
Time for scheduled runs in HH:mm format. |
None
|
to_time
|
str | None
|
End time for scheduled runs. |
None
|
from_time
|
str | None
|
Start time for scheduled runs. |
None
|
start_date
|
datetime
|
Start date of the schedule. |
required |
end_date
|
datetime | None
|
End date of the schedule, if set. |
None
|
days_of_week
|
list[int]
|
Days of week when schedule is active. |
[]
|
repeat_every
|
int | None
|
Frequency of repetition. |
None
|
status
|
str
|
Current status of the schedule. |
required |
Integration
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
integration_id
|
str
|
The unique identifier of this integration. |
required |
integration_type
|
Literal[str, str, str]
|
The type of this integration. |
required |
model_id
|
str
|
The ID of the model this integration belongs to. |
required |
workspace_id
|
str
|
The ID of the workspace this integration belongs to. |
required |
nux_visible
|
bool
|
Whether this integration is visible in the UI. |
required |
process_id
|
str | None
|
The ID of the process (for Process type). |
None
|
schedule
|
Schedule | None
|
Schedule configuration if defined. |
None
|
SingleIntegration
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
integration_type
|
None
|
Sentinel for erroneous implementation of the Anaplan API. This field is not provided when getting an individual integration by Id. |
None
|
AnaplanSource
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
type
|
Literal[str]
|
Literal signifying this is an Anaplan source. |
'Anaplan'
|
action_id
|
int
|
The ID of the action to be used as a source. This can be a process, or export. |
required |
FileSource
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_id
|
str
|
The unique identifier of the connection. |
required |
type
|
Literal[str, str]
|
The type of this connection. |
required |
file
|
str
|
The file path relative to the root of the connection. |
required |
FileTarget
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_id
|
str
|
The unique identifier of the connection. |
required |
type
|
Literal[str, str]
|
The type of this connection. |
required |
overwrite
|
bool
|
Whether to overwrite the file if it exists. |
True
|
TableSource
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
type
|
Literal[str]
|
The type of this connection. |
'GoogleBigQuery'
|
connection_id
|
str
|
The unique identifier of the connection. |
required |
table
|
str
|
The table name in the BigQuery dataset in the connection. |
required |
TableTarget
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
overwrite
|
bool
|
Whether to overwrite the table if it exists. |
False
|
AnaplanTarget
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
type
|
Literal[str]
|
Literal signifying this is an Anaplan target. |
'Anaplan'
|
action_id
|
int
|
The ID of the action to be used as a target. This can be a process, or import. |
required |
file_id
|
int
|
The ID of the file to be used as a target. |
required |
IntegrationJobInput
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
type
|
Literal[str, str, str, str, str, str]
|
The type of this integration. |
required |
sources
|
list[Union[AnaplanSource, FileSource, TableSource]]
|
The sources of this integration. |
required |
targets
|
list[Union[AnaplanTarget, FileTarget, TableTarget]]
|
The targets of this integration. |
required |
IntegrationProcessInput
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
The name of this integration process. |
required |
version
|
Literal[str]
|
The version of this integration. |
'2.0'
|
workspace_id
|
str
|
The ID of the workspace this integration belongs to. |
required |
model_id
|
str
|
The ID of the model this integration belongs to. |
required |
process_id
|
int
|
The ID of the process this integration belongs to. |
required |
IntegrationInput
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
The name of this integration. |
required |
version
|
Literal[str]
|
The version of this integration. |
'2.0'
|
workspace_id
|
str
|
The ID of the workspace this integration belongs to. |
required |
model_id
|
str
|
The ID of the model this integration belongs to. |
required |
process_id
|
int | None
|
If given, an integration process will be created, instead of an Import or Export |
None
|
nux_visible
|
bool
|
Whether this integration is visible in the UI. |
False
|
jobs
|
list[IntegrationJobInput]
|
The jobs in this integration. |
required |
RunSummary
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
The unique identifier of this run. |
required |
triggered_by
|
str
|
|
required |
last_run
|
datetime
|
Last Run timestamp. |
required |
start_date
|
datetime
|
Start timestamp. |
required |
end_date
|
datetime | None
|
The end timestamp of this run. This can be None, if the integration is currently running. |
None
|
success
|
bool
|
Whether this run was successful. |
required |
message
|
str
|
Result message of this run. |
required |
execution_error_code
|
int | None
|
Error code if run failed. |
None
|
trace_id
|
str
|
The trace ID for this run. |
required |
trigger_source
|
Literal[str, str]
|
Source that triggered the run. |
required |
RunStatus
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
The unique identifier of this run. |
required |
integration_id
|
str
|
The ID of the integration this run belongs to. |
required |
trace_id
|
str
|
The trace ID for this run. |
required |
start_date
|
datetime
|
The start timestamp of this run. |
required |
end_date
|
datetime | None
|
The end timestamp of this run. This can be None, if the integration is currently running. |
None
|
success
|
bool
|
Whether this run was successful. |
required |
message
|
str
|
Result message of this run. |
required |
execution_error_code
|
int | None
|
Error code if run failed. |
None
|
flow_group_id
|
str | None
|
The ID of the flow group, if any. |
None
|
trigger_source
|
Literal[str, str]
|
Source that triggered the run. |
required |
ErrorSummary
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
local_message_text
|
str
|
Error message text. |
required |
ErrorMessage
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
error_message
|
list[Union[TaskResultDetail, ErrorSummary]]
|
|
required |
action_id
|
str
|
The ID of the action that failed. |
required |
action_name
|
str
|
The name of the action that failed. |
required |
failure_dump_generated
|
bool
|
Whether a failure dump was generated. |
required |
RunError
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task_id
|
str
|
The Task ID of the invoked Anaplan Action. |
required |
error_messages
|
list[ErrorMessage]
|
The error messages of the run. |
required |
NotificationUser
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_guid
|
str
|
The unique identifier of the user. |
required |
first_name
|
str
|
The user's first name. |
required |
last_name
|
str
|
The user's last name. |
required |
NotificationItem
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
type
|
Literal[str, str, str]
|
The type of notification event that triggers notifications. |
required |
users
|
list[NotificationUser]
|
The list of users who will receive this notification. |
required |
Notification
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
config
|
list[NotificationItem]
|
The configuration for different notification types. |
required |
NotificationConfig
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
notification_id
|
str
|
The unique identifier of this notification configuration. |
required |
integration_ids
|
list[str]
|
The IDs of the integrations associated with this notification. |
required |
channels
|
list[Literal[str, str]]
|
The channels through which notifications will be sent. |
required |
notifications
|
Notification
|
The detailed notification configuration settings. |
required |
NotificationItemInput
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
type
|
Literal[str, str, str]
|
The type of notification event that triggers notifications. |
required |
users
|
list[str]
|
The list of user IDs who will receive this notification. Must not be empty. If you want nobody to receive notifications for this type, omit the entire config item. If you want to override an existing list of users with an empty one, you must delete the notification configuration and create a new one. |
required |
NotificationConfigInput
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
config
|
list[NotificationItemInput]
|
The configuration for different notification types. |
required |
NotificationInput
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
integration_ids
|
list[str]
|
The IDs of the integrations associated with this notification. |
required |
channels
|
list[Literal[str, str]]
|
The channels through which notifications will be sent. |
required |
notifications
|
NotificationConfigInput
|
The detailed notification configuration settings. |
required |