server.web.schemas.workflow

Classes

`WorkflowValidationRequest`	Request model for workflow validation.
`WorkflowValidationResponse`	Response model for workflow validation.
`WorkflowTasksResponse`	Response model for workflow tasks.
`WorkflowUserValidationResponse`	Response model for workflow user validation.
`WorkflowResetRequest`	Request model for workflow reset.
`WorkflowRunForResetResponse`	Response model for workflow run reset validation.
`WorkflowStatusResponse`	Response model for workflow status.
`WorkflowStatusVizResponse`	Response model for workflow status visualization.
`WorkflowOverviewFilters`	Filters for the workflow overview query.
`WorkflowOverviewItem`	Individual workflow item in overview response.
`WorkflowOverviewResponse`	Response model for workflow overview.
`TaskTableItem`	Individual task item in task table response.
`TaskTableResponse`	Response model for task table visualization.
`WorkflowDetailsItem`	Workflow details item.
`WorkflowDetailsResponse`	Response model for workflow details.
`RequestedResourceClusterItem`	One (task_template, task_resources_id) cluster of requested resources.
`WorkflowRequestedResourcesResponse`	Response for `GET /workflow/{wfid}/requested_resources`.

Module Contents

class server.web.schemas.workflow.WorkflowValidationRequest

Bases: pydantic.BaseModel

Request model for workflow validation.

task_ids: List[int]

class server.web.schemas.workflow.WorkflowValidationResponse

Bases: pydantic.BaseModel

Response model for workflow validation.

validation: bool

workflow_status: str | None = None

class server.web.schemas.workflow.WorkflowTasksResponse

Bases: pydantic.BaseModel

Response model for workflow tasks.

workflow_tasks: str

class server.web.schemas.workflow.WorkflowUserValidationResponse

Bases: pydantic.BaseModel

Response model for workflow user validation.

validation: bool

class server.web.schemas.workflow.WorkflowResetRequest

Bases: pydantic.BaseModel

Request model for workflow reset.

partial_reset: bool = False

class server.web.schemas.workflow.WorkflowRunForResetResponse

Bases: pydantic.BaseModel

Response model for workflow run reset validation.

workflow_run_id: int | None

class server.web.schemas.workflow.WorkflowStatusResponse

Bases: pydantic.BaseModel

Response model for workflow status.

workflows: str

class server.web.schemas.workflow.WorkflowStatusVizResponse

Bases: pydantic.BaseModel

Response model for workflow status visualization.

class server.web.schemas.workflow.WorkflowOverviewFilters

Bases: pydantic.BaseModel

Filters for the workflow overview query.

model_config

user: str | None = None

tool: str | None = None

wf_name: str | None = None

wf_args: str | None = None

wf_id: str | None = None

date_submitted: str | None = None

date_submitted_end: str | None = None

status: str | None = None

user_exclude: str | None = None

tool_exclude: str | None = None

status_exclude: str | None = None

wf_name_contains: bool = False

wf_args_contains: bool = False

wf_attributes: List[Tuple[str, str]] | None = None

wf_attribute_key: str | None = None

wf_attribute_value: str | None = None

class server.web.schemas.workflow.WorkflowOverviewItem

Bases: pydantic.BaseModel

Individual workflow item in overview response.

wf_id: int

wf_name: str

wf_submitted_date: str

wf_status_date: str

wf_args: str | None

wfr_count: int

wf_status: str

wf_tool: str

PENDING: int = 0

SCHEDULED: int = 0

RUNNING: int = 0

DONE: int = 0

FATAL: int = 0

class server.web.schemas.workflow.WorkflowOverviewResponse

Bases: pydantic.BaseModel

Response model for workflow overview.

workflows: List[WorkflowOverviewItem]

class server.web.schemas.workflow.TaskTableItem

Bases: pydantic.BaseModel

Individual task item in task table response.

task_id: int

task_name: str

task_status: str

task_command: str

task_num_attempts: int

task_status_date: str

task_max_attempts: int

class server.web.schemas.workflow.TaskTableResponse

Bases: pydantic.BaseModel

Response model for task table visualization.

tasks: List[TaskTableItem]

class server.web.schemas.workflow.WorkflowDetailsItem

Bases: pydantic.BaseModel

Workflow details item.

wf_name: str

wf_args: str | None

wf_created_date: str

wf_status_date: str

tool_name: str

wf_status: str

wf_status_desc: str

wfr_jobmon_version: str | None

wfr_heartbeat_date: str | None

wfr_user: str

wfr_id: int | None = None

class server.web.schemas.workflow.WorkflowDetailsResponse

Bases: pydantic.BaseModel

Response model for workflow details.

class server.web.schemas.workflow.RequestedResourceClusterItem

Bases: pydantic.BaseModel

One (task_template, task_resources_id) cluster of requested resources.

Sourced from task_resources rows joined through task — so the cluster is visible as soon as the workflow has been bound, even before any TaskInstances have launched. requested_resources is the raw JSON blob the user configured; fields are intentionally unrestricted (Dict[str, Any]) because RequestedResourcesModel is only a hint — users can stuff arbitrary keys into compute_resources.

task_template_id: int

task_template_name: str

task_template_version_id: int

task_resources_id: int

queue_name: str | None = None

num_tasks: int

requested_resources: Dict[str, Any]

class server.web.schemas.workflow.WorkflowRequestedResourcesResponse

Bases: pydantic.BaseModel

Response for GET /workflow/{wfid}/requested_resources.

clusters: List[RequestedResourceClusterItem]