Python SDK - Data Types Documentation : Service Desk & Manuals

Classes

Common

GenericResource

Property	Type	Required	Default
owner	str	true	-
owner_information	OwnerInformation	true	-
id	str	true	-
name	str	true	-
description	str	true	-
tags	[str]	true	-
created_at	datetime	true	-
updated_at	datetime	true	-
notes	Union[str, None]	true	-
projects	Project	true	-
home_project	int	true	-
permissions	int	true	-
resource_type	int	true	-

Paginated

Property	Type	Required	Default
ipp	int	true	-
items	[obj]	true	-
page	int	true	-
paginated	bool	true	-
total_items	int	true	-

SearchParameterBase

Abstract class. Represents the search parameters that are used in several list functions.

Property	Type	Required	Default
page	int	false	None
limit	int	false	None
ordering	SortOrder	false	None
search	str	false	None

OwnerInformation

Property	Type	Required	Default
ownerId	str	true	-
type	str	true	-

UserOwnerInformation

Inherits: OwnerInformation

Property	Type	Required	Default
first_name	str	true	-
last_name	str	true	-

GroupOwnerInformation

Inherits: OwnerInformation

Property	Type	Required	Default
name	str	true	-
tags	[str]	true	-

Connections

Connection

Representation of a connection.

Inherits: GenericResource

Property	Type	Required	Default
connection_type	ConnectionType	true	-
key_id	str	true	-
key_name	str	true	-

CreateDatasetFromDatabase

Representation of the create request parameters.

Property	Type	Required	Default
connection_id	str	true	-
connection_type	ConnectionType	true	-
connection_table_name	str	true	-
dt_name	str	true	-
access	[DatabaseTablePrivilege]	true	-
resource_type	GenericResourceType	true	-
dt_description	str	false	None
dt_notes	str	false	None
dt_tags	[str]	false	None
connection_schema	str	false	None
target_project	str	false	None

DatabaseConnectionTableInformation

Representation of data table information from database connection.

Property	Type	Required	Default
id	str	true	-
name	str	true	-
access	[DatabaseTablePrivilege]	false	[]
dt_id	str	false	None
dt_name	str	false	None
schema	str	false	None

DatabaseConnectionTableInformationSearchParameters

Representation of database connection specific search parameters.

Inherits: SearchParametersBase

Property	Type	Required	Default
project_id	str	false	None
sort_by	DatabaseConnectionTableSortType	false	None
tables_listing_mode	TablesListingMode	false	None

DataTables

DataTableInformation

Inherits: GenericResource

Property	Type	Required	Default
workflows	[WorkflowInformation]	true	-
row_count	int	true	-
data_source	DataSourceInformation	true	-
locked	DatasetLock	true	-

DataTable

Inherits: DataTableInformation

Property	Type	Required	Default
attributes	dict	true	-
attributes_operator	AttributesOperator	true	-
dataset_type_specific_metadata	dict	true	-

DataTableColumn

Property	Type	Required	Default
name	str	true	-
index	int	true	-
type	RepresentationType	true	-

DataTableContent

Property	Type	Required	Default
total_count	int	true	-
distinct_values	[dict]	true	-
editable	bool	true	-
row_unique_id_column	str	true	-
filterable_information_id	str	true	-
schema	[DataTableColumn]	false	None
records	[dict]	false	None
errors	[str]	false	None
total_filter_matches	int	false	None
aggregation_metadata	[dict]	false	None
download_link_id	str	false	None

UploadedDataResponse

Property	Type	Required	Default
data	DataTable	true	-
modified_datasets	ModifiedDatasetName	true	-
fallback_data_tables	DataTable	true	-

ModifiedDatasetName

Property	Type	Required	Default
old_dataset_name	str	true	-
new_dataset_name	str	true	-

DataSourceInformation

Property	Type	Required	Default
id	str	true	-

CSVSourceInformation

Inherits: DataSourceInformation

Property	Type	Required	Default
job_id		true	-

DatabaseTableConnectionSourceInformation

Inherits: DataSourceInformation

Property	Type	Required	Default
access	[DatabaseTablePrivilege]	true	-
database_connection	Connection	true	-
table_name	str	true	-
table_schema	str	true	-

FilesystemFileConnectionSourceInformation

Inherits: DataSourceInformation

Property	Type	Required	Default
filesystem_connection	Connection	true	-
relative_file_path	str	true	-
merge_pattern	FilesystemConnectionMergePattern	true	-

ParquetSourceInformation

Inherits: DataSourceInformation

Property	Type	Required	Default
job_id	str	true	-

FilterableSourceInformation

Inherits: DataSourceInformation

Property	Type	Required	Default
job_id	str	true	-
storage_type	DataTableStorageType	true	-
external_connection_info	ExternalConnectionInformation	true	-

VirtualDataSourceInformation

Inherits: DataSourceInformation

Property	Type	Required	Default
vdt_source_id	str	true	-

FilesystemConnectionMergePattern

Property	Type	Required	Default
merge_rule	str	true	-
file_name	str	true	-

ExternalConnectionInformation

Property	Type	Required	Default
connection	Connection	true	-
connection_type	ConnectionType	true	-

DatabaseTableConnectionInformation

Inherits: ExternalConnectionInformation

Property	Type	Required	Default
table_name	str	true	-
schema	[DatatableColumn]	true	-
access	[DatabaseTablePrivilege]	true	-

CassandraTableConnectionInformation

Inherits: ExternalConnectionInformation

Property	Type	Required	Default
table_name	str	true	-

Functions

FunctionExecutionError

Property	Type	Required	Default
type	str	true	-
message	str	false	None
trace	str	false	None
caused_by	[]	false	None

FunctionExecutionResult

Property	Type	Required	Default
status	FunctionExecutionStatus	true	-
stdout	str	false	None
stderr	str	false	None
response	dict	false	None
error	[FunctionExecutionError]	false	None

ProductionLines

ProductionLine [FunctionExecutionError]

Inherits: GenericResource

Property	Type	Required	Default
version_number	int	true	-
workflow_sequence	[ProductionLineSequenceEntry]	true	-
production_line_variable	[dict]	true	-
job_naming_rule	dict	false	None
error	[FunctionExecutionError]	false	None

ProductionLineJob

Property	Type	Required	Default
id	str	true	-
start_time	datetime	true	-
name	str	true	-
execution_number	int	true	-
production_line	ProductionLine	true	-
state	ProductionLineJobState	true	-
canceled	bool	true	-
execution_sequence	ProductionLineJobEntry	true	-
overridden_values	[dict]	false	None
end_time	datetime	false	None
schedule_id	str	false	None

ProductionLineJobEntry

Property	Type	Required	Default
position	int	true	-

ProductionLineSequenceEntry

Abstract representation of a production line sequence entry

Property	Type	Required	Default
position	int	true	-

Projects

Project

Property	Type	Required	Default
id	str	true	-
project_type	str	true	-
name	str	true	-
owner	str	true	-
description	str	true	-
notes	str	true	-
tags	[str]	true	-
created_at	datetime	true	-
updated_at	datetime	true	-
secured	bool	true	-
owner_information	OwnerInformation	true	-

ProjectSearchParameters

Representation of project specific search parameters.

Inherits: SearchParametersBase

Property	Type	Required	Default
sort_by	ResourceSortProperty	false	None

Users

User

Property	Type	Required	Default
id	str	true	-
first_name	str	true	-
last_name	str	true	-
email	str	true	-
username	str	true	-
super_admin	bool	true	-
created_at	date	true	-
updated_at	date	true	-
groups	[dict]	true	-
domains	[dict]	true	-
modules	[OneDataModule]	true	-
internal_account	bool	true	-
default_domain	str	false	None
preferred_projects	[dict]	false	None
user_variables	[dict]	false	None

Workflows

Workflow

Inherits: GenericResource

Property	Type	Required	Default
version_number	int	true	-
nodes	dict	true	-
node_notes	dict	true	-
auxiliaries	[WorkflowAuxiliaries]	true	-
sources	[dict]	true	-
sinks	[dict]	true	-
groups	[dict]	true	-
recent_execution	str	true	-
variables	[dict]	true	-
job_naming_rule	str	true	-

WorkflowAuxiliaries

Property	Type	Required	Default
type	str	true	-
x	int	true	-
y	int	true	-

WorkflowInformation

Property	Type	Required	Default
owner	str	true	-
id	str	true	-
name	str	true	-
description	str	true	-
notes	str	true	-
tags	[str]	true	-
projects	[Project]	true	-
created_at	datetime	true	-
updated_at	datetime	true	-
owner_information	OwnerInformation	true	-
home_project	Project	true	-
permissions	[Permission]	true	-
resource_type	GenericResourceType	true	-
recent_execution	str	true	-
version_number	int	true	-
recent_execution_in_workflow	str	true	-

WorkflowJob

Inherits: WorkflowJobShallow

Property	Type	Required	Default
results	[dict]	true	-
errors	[dict]	true	-
warnings	[dict]	true	-
variable_configuration	dict	true	-

WorkflowJobShallow

Inherits: GenericResource

Property	Type	Required	Default
start_time	datetime	true	-
end_time	datetime	true	-
workflow_id	str	true	-
workflow_version	int	true	-
workflow_name	str	true	-
workflow_permission	[Permission]	true	-
execution_number	int	true	-
execution_state	JobExecutionState	true	-
execution_context	JobExecutionContext	true	-
execution_context_metadata	dict	true	-
schedule_id	str	true	-

Enums

AttributesOperator

AND = "AND"
OR = "OR"

ConnectionType

DB_CONNECTION = "DB_CONNECTION"
REST_API_CONNECTION = "REST_API_CONNECTION"
FILESYSTEM_CONNECTION = "FILESYSTEM_CONNECTION"
CASSANDRA_CONNECTION = "CASSANDRA_CONNECTION"

DatabaseConnectionTableSortType

NAME = "name"
SCHEMA = "schema"
DATASET = "dataset"

DatabaseTablePrivilege

READ = "READ"
APPEND = "APPEND"
REPLACE = "REPLACE"
UNKNOWN = "UNKNOWN"

DatasetLock

LOCKED = "LOCKED"
APPLIED_AUTHORIZATION_DIMENSIONS = "APPLIED_AUTHORIZATION_DIMENSIONS"
OPEN = "OPEN"

DataTableStorageType

CSV = "CSV"
KUDU = "KUDU"
PARQUET = "PARQUET"
ORC = "ORC"
POSTGRESQL = "POSTGRESQL"
EXTERNAL_STORAGE = "EXTERNAL_STORAGE"

FunctionExecutionStatus

SUCCESS = "SUCCESS"
FUNCTION_ERROR = "FUNCTION_ERROR"

GenericResourceType

DATA = "DATA"
WORKFLOW = "WORKFLOW"
WORKFLOW_JOB = "WORKFLOW_JOB"
DYNAMIC_REPORT = "DYNAMIC_REPORT"
KEY = "KEY"
PROCESS_MODEL = "PROCESS_MODEL"
SCHEDULE = "SCHEDULE"
MACHINE_LEARNING_MODEL = "MACHINE_LEARNING_MODEL"
DB_CONNECTION = "DB_CONNECTION"
PRODUCTION_LINE = "PRODUCTION_LINE"
PYTHON_MODEL = "PYTHON_MODEL"
MODEL_GROUP = "MODEL_GROUP"
FUNCTION = "FUNCTION"

JobExecutionState

INITIAL = "initial"
RUNNING = "running"
FAILED = "failed"
ABORTED = "aborted"
SUCCESS = "success"

JobExecutionContext

MANUAL = "MANUAL"
SCHEDULED = "SCHEDULED"
MICROSERVICE = "MICROSERVICE"
PRODUCTION_LINE = "PRODUCTION_LINE"
SCHEDULED_PRODUCTION_LINE = "SCHEDULED_PRODUCTION_LINE"
DEBUG = "DEBUG"

OneDataModule

DATAHUB = "DATAHUB"
MODELHUB = "MODELHUB"
PROCESSING_LIBRARY = "PROCESSING_LIBRARY"
USE_CASES = "USE_CASES"
APP_BUILDER = "APP_BUILDER"
APP_VIEWER = "APP_VIEWER"

Permission

READ = "READ"
WRITE = "WRITE"
CREATE = "CREATE"
DELETE = "DELETE"
EXECUTE = "EXECUTE"
SHARE = "SHARE"

ProductionLineJobState

INITIAL = "INITIAL"
SUCCESS = "SUCCESS"
FAILED = "FAILED"
RUNNING = "RUNNING"
ABORTED = "ABORTED"

RepresentationType

DOUBLE = "double"
STRING = "string"
NUMERIC = "numeric"
DATETIME = "datetime"
INT = "int"

ResourceSortProperty

NAME = "name"
OWNER = "owner"
UPDATED = "updated"
CREATED = "created"

SortOrder

ASC = "ASC"
DESC = "DESC"

TablesListingMode

SCHEMA_CONFIGURED_IN_THE_CONNECTION = "SCHEMA_CONFIGURED_IN_THE_CONNECTION"
ALL_SCHEMATA_EXCEPT_BLACKLISTED = "ALL_SCHEMATA_EXCEPT_BLACKLISTED"
ALL_SCHEMATA = "ALL_SCHEMATA"

UserSortProperty

FORENAME = "forename"
LASTNAME = "lastname"
EMAIL = "email"

Python SDK - Data Types Documentation Print

Classes

Common

GenericResource

Paginated

SearchParameterBase

OwnerInformation

UserOwnerInformation

GroupOwnerInformation

Connections

Connection

CreateDatasetFromDatabase

DatabaseConnectionTableInformation

DatabaseConnectionTableInformationSearchParameters

DataTables

DataTableInformation

DataTable

DataTableColumn

DataTableContent

UploadedDataResponse

ModifiedDatasetName

DataSourceInformation

CSVSourceInformation

DatabaseTableConnectionSourceInformation

FilesystemFileConnectionSourceInformation

ParquetSourceInformation

FilterableSourceInformation

VirtualDataSourceInformation

FilesystemConnectionMergePattern

ExternalConnectionInformation

DatabaseTableConnectionInformation

CassandraTableConnectionInformation

Functions

FunctionExecutionError

FunctionExecutionResult

ProductionLines

ProductionLine [FunctionExecutionError]

ProductionLineJob

ProductionLineJobEntry

ProductionLineSequenceEntry

Projects

Project

ProjectSearchParameters

Users

User

Workflows

Workflow

WorkflowAuxiliaries

WorkflowInformation

WorkflowJob

WorkflowJobShallow

Enums

AttributesOperator

ConnectionType

DatabaseConnectionTableSortType

DatabaseTablePrivilege

DatasetLock

DataTableStorageType

FunctionExecutionStatus

GenericResourceType

JobExecutionState

JobExecutionContext

OneDataModule

Permission

ProductionLineJobState

RepresentationType

ResourceSortProperty

SortOrder

TablesListingMode

UserSortProperty

Related Articles