Models¶
All models are importable directly from pyawe:
Enumerations¶
Bases: str, Enum
Lifecycle status shared by workflows, tasks, and jobs.
CANCELLED is task-only and set automatically by the propagator when a
task is on a rejected decision branch; do not set it via update_task.
Bases: str, Enum
Schedule health indicator shared by workflows, tasks, and jobs.
Bases: str, Enum
Task execution model.
Bases: str, Enum
Direction of a task port.
Bases: str, Enum
Data type carried by a task port.
Bases: str, Enum
Execution mechanism for an automated task.
Bases: str, Enum
Iteration strategy for a loop block.
Auth¶
dataclass
¶
LoginInfo(token: str, user_id: str, email: str, username: str, roles: List[str], permissions: List[str])
Session information returned by a successful :meth:AweClient.login call.
Workflows¶
dataclass
¶
Workflow(id: UUID, name: str, is_template: bool, created_at: datetime, updated_at: datetime, status: Status, schedule_status: ScheduleStatus, is_shared: bool, created_by: Optional[str] = None, description: Optional[str] = None, job_id: Optional[UUID] = None, team_id: Optional[UUID] = None, parent_loop_block_id: Optional[UUID] = None, sort_order: Optional[int] = None, story_points: Optional[int] = None)
A workflow definition or instance.
dataclass
¶
Workflow with its associated tasks and inter-task links.
Tasks¶
dataclass
¶
Task(id: UUID, name: str, is_template: bool, created_at: datetime, updated_at: datetime, status: Status, schedule_status: ScheduleStatus, workflow_id: UUID, is_start: bool, is_end: bool, task_type: str, created_by: Optional[str] = None, description: Optional[str] = None, rework_task_id: Optional[UUID] = None, loop_block_id: Optional[UUID] = None, assigned_to: Optional[str] = None, start_time: Optional[datetime] = None, end_time: Optional[datetime] = None, decision_outcome: Optional[str] = None, decision_input_port: Optional[str] = None, input_values: Optional[Any] = None, output_values: Optional[Any] = None, is_locked: bool = False, canvas_x: Optional[float] = None, canvas_y: Optional[float] = None, effort: Optional[int] = None)
A task within a workflow.
instance-attribute
¶
One of "standard", "decision", "automated", "loop_block".
class-attribute
instance-attribute
¶
Set when task_type == "loop_block".
class-attribute
instance-attribute
¶
User UUID string; no foreign-key constraint (users live in a separate service).
class-attribute
instance-attribute
¶
Input port name that drives auto-decide for decision tasks.
class-attribute
instance-attribute
¶
When True, structural edits are blocked for non-privileged users.
class-attribute
instance-attribute
¶
Unitless effort estimate (e.g. story points). None means not yet estimated.
dataclass
¶
TaskWithContext(task: Task, workflow_name: str, job_id: Optional[UUID] = None, job_name: Optional[str] = None)
A task enriched with its workflow and job names, returned by list_mine.
dataclass
¶
TaskLink(from_task_id: UUID, to_task_id: UUID, branch_label: Optional[str] = None, data_bindings: Optional[Any] = None)
dataclass
¶
dataclass
¶
dataclass
¶
Port specs paired with their current runtime values.
class-attribute
instance-attribute
¶
Dict of {name: value} or None when no values have been set.
dataclass
¶
TaskScript(id: UUID, task_id: UUID, script_type: str, timeout_secs: int, retry_limit: int, created_at: datetime, updated_at: datetime, endpoint: Optional[str] = None, script_body: Optional[str] = None, execution_profile_id: Optional[UUID] = None)
Automated execution script attached to a task.
dataclass
¶
TaskRun(id: UUID, task_id: UUID, created_at: datetime, runner_id: Optional[str] = None, started_at: Optional[datetime] = None, completed_at: Optional[datetime] = None, outcome: Optional[str] = None, input_json: Optional[Any] = None, output_json: Optional[Any] = None, error_message: Optional[str] = None)
Record of a single automated task execution attempt.
class-attribute
instance-attribute
¶
"Success", "Failure", or "Timeout".
dataclass
¶
Assignment of a team role to a task.
Jobs¶
dataclass
¶
Job(id: UUID, name: str, status: Status, schedule_status: ScheduleStatus, created_at: datetime, updated_at: datetime, archived: bool, team_id: Optional[UUID] = None, project_id: Optional[UUID] = None, job_type: Optional[str] = None, start_date: Optional[str] = None, end_date: Optional[str] = None)
A job that groups related workflow instances.
class-attribute
instance-attribute
¶
"sprint", "kanban", or "backlog"; None for legacy jobs.
class-attribute
instance-attribute
¶
ISO 8601 date string; set when job_type == "sprint".
class-attribute
instance-attribute
¶
ISO 8601 date string; set when job_type == "sprint".
dataclass
¶
Job with its associated workflows.
Loop Blocks¶
dataclass
¶
LoopBlock(id: UUID, task_id: UUID, outer_workflow_id: UUID, inner_workflow_id: UUID, loop_type: str, loop_config: Any, created_at: datetime, updated_at: datetime)
A loop block that wraps an inner workflow repeated across iterations.
dataclass
¶
Response from POST /loop-blocks: the new outer task and its loop block.
Notes¶
dataclass
¶
dataclass
¶
A folder used to organise notes.
Execution Profiles¶
dataclass
¶
ExecutionProfile(id: UUID, name: str, image: str, cpu_request: str, cpu_limit: str, memory_request: str, memory_limit: str, created_by: str, created_at: datetime, updated_at: datetime, description: Optional[str] = None)
Approved Kubernetes execution environment for automated tasks.