server.web.routes.v2.cli.workflow

Routes for Workflow.

Attributes

logger
SessionMaker
_cli_label_mapping
_reversed_cli_label_mapping
_cli_order

Functions

get_workflow_validation_status(→ Any)	Check if workflow is valid.
get_workflow_tasks() → Any)	Get the tasks for a given workflow.
get_workflow_user_validation(→ Any)	Return all usernames associated with a given workflow_id's workflow runs.
get_workflow_run_for_workflow_reset(→ Any)	Last workflow_run_id associated with a given workflow_id started by the username.
reset_workflow(→ Any)	Update the workflow's status, all its tasks' statuses to 'G'.
get_workflow_status(, limit, user)	Get the status of the workflow.
get_workflow_status_viz() → Any)	Get the status of the workflows for GUI.
workflows_by_user_form(, tool, wf_name, wf_args, ...)	Fetch associated workflows and workflow runs by username.
task_details_by_wf_id(→ Any)	Fetch Task details associated with Workflow ID and TaskTemplate name.
wf_details_by_wf_id(→ Any)	Fetch name, args, dates, tool for a Workflow provided WF ID.

Module Contents

server.web.routes.v2.cli.workflow.logger

server.web.routes.v2.cli.workflow.SessionMaker

server.web.routes.v2.cli.workflow._cli_label_mapping

server.web.routes.v2.cli.workflow._reversed_cli_label_mapping

server.web.routes.v2.cli.workflow._cli_order = ['PENDING', 'SCHEDULED', 'RUNNING', 'DONE', 'FATAL']

async server.web.routes.v2.cli.workflow.get_workflow_validation_status(request: fastapi.Request) → Any

Check if workflow is valid.

server.web.routes.v2.cli.workflow.get_workflow_tasks(workflow_id: int, limit: int, status: list[str] | None = Query(None)) → Any

Get the tasks for a given workflow.

server.web.routes.v2.cli.workflow.get_workflow_user_validation(workflow_id: int, username: str) → Any

Return all usernames associated with a given workflow_id’s workflow runs.

Used to validate permissions for a self-service request.

server.web.routes.v2.cli.workflow.get_workflow_run_for_workflow_reset(workflow_id: int, username: str) → Any

Last workflow_run_id associated with a given workflow_id started by the username.

Used to validate for workflow_reset:

1. The last workflow_run of the current workflow must be in error state.

2. This last workflow_run must have been started by the input username.

3. This last workflow_run is in status ‘E’

async server.web.routes.v2.cli.workflow.reset_workflow(workflow_id: int, request: fastapi.Request) → Any

Update the workflow’s status, all its tasks’ statuses to ‘G’.

server.web.routes.v2.cli.workflow.get_workflow_status(workflow_id: int | str | List[int | str] | None = Query(None), limit: int | None = Query(None), user: list[str] | None = Query(None)) → Any

Get the status of the workflow.

server.web.routes.v2.cli.workflow.get_workflow_status_viz(workflow_ids: list[int] = Query(None)) → Any

Get the status of the workflows for GUI.

server.web.routes.v2.cli.workflow.workflows_by_user_form(user: str | None = Query(None), tool: str | None = Query(None), wf_name: str | None = Query(None), wf_args: str | None = Query(None), wf_attribute_value: str | None = Query(None), wf_attribute_key: str | None = Query(None), wf_id: str | None = Query(None), date_submitted: str | None = Query(None), date_submitted_end: str | None = Query(None), status: str | None = Query(None)) → Any

Fetch associated workflows and workflow runs by username.

server.web.routes.v2.cli.workflow.task_details_by_wf_id(workflow_id: int, tt_name: str) → Any

Fetch Task details associated with Workflow ID and TaskTemplate name.

server.web.routes.v2.cli.workflow.wf_details_by_wf_id(workflow_id: int) → Any

Fetch name, args, dates, tool for a Workflow provided WF ID.