Skip to content

Transactional

User

Parameters:

Name Type Description Default
id str

The unique identifier of this user.

required
active bool

Whether this user is active or not.

required
email str

The email address of this user.

required
email_opt_in bool

Whether this user has opted in to receive emails or not.

required
first_name str

The first name of this user.

required
last_name str

The last name of this user.

required
last_login_date str | None

The last login date of this user in ISO format.

None

ListItem

Parameters:

Name Type Description Default
id int

The unique identifier of this list item.

required
name str

The name of this list item.

required
code str | None

The code of this list item.

None
properties dict

The properties of this list item.

{}
subsets dict

The subsets of this list item.

{}
parent str | None

The parent of this list item.

None
parent_id str | None

The unique identifier of the parent of this list item.

None

Module

Parameters:

Name Type Description Default
id int

The unique identifier of this module.

required
name str

The name of this module.

required

LineItem

Parameters:

Name Type Description Default
id int

The unique identifier of this line item.

required
name str

The name of this line item.

required
module_id int

The unique identifier of the module this line item belongs to.

required
module_name str

The name of the module this line item belongs to.

required
format str

The format of this line item.

required
format_metadata dict

The format metadata of this line item.

required
summary str

The summary of this line item.

required
applies_to list[dict]

The applies to value of this line item.

[]
time_scale str

The time scale of this line item.

required
time_range str

The time range of this line item.

required
version dict

The version of this line item.

required
style str

The style of this line item.

required
cell_count int | None

The cell count of this line item.

None
notes str

The notes of this line item.

required
is_summary bool

Whether this line item is a summary or not.

required
formula str | None

The formula of this line item.

None
formula_scope str

The formula scope of this line item.

required
use_switchover bool

Whether the switchover is used or not.

required
breakback bool

Whether the breakback is enabled or not.

required
brought_forward bool

Whether the brought forward is enabled or not.

required
start_of_section bool

Whether this line item is the start of a section or not.

required

Failure

Parameters:

Name Type Description Default
index int

The index of the item that failed.

required
reason str

The reason for the failure.

required
details str

The details of the failure.

required

ModelStatus

Parameters:

Name Type Description Default
peak_memory_usage_estimate int | None

The peak memory usage estimate of this model.

required
peak_memory_usage_time int | None

The peak memory usage time of this model.

required
progress float

The progress of this model.

required
current_step str

The current step of this model.

required
tooltip str | None

The tooltip of this model.

required
task_id str | None

The unique identifier of the task of this model.

required
creation_time int

The creation time of this model.

required
export_task_type str | None

The export task type of this model.

required

InsertionResult

Parameters:

Name Type Description Default
added int

The number of items successfully added.

required
ignored int

The number of items ignored, or items that failed.

required
total int

The total number of items.

required
failures list[Failure]

The list of failures.

[]