server.web.routes.v2.cli.workflow
=================================

.. py:module:: server.web.routes.v2.cli.workflow

.. autoapi-nested-parse::

   Routes for Workflow.



Attributes
----------

.. autoapisummary::

   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


Functions
---------

.. autoapisummary::

   server.web.routes.v2.cli.workflow.get_workflow_validation_status
   server.web.routes.v2.cli.workflow.get_workflow_tasks
   server.web.routes.v2.cli.workflow.get_workflow_user_validation
   server.web.routes.v2.cli.workflow.get_workflow_run_for_workflow_reset
   server.web.routes.v2.cli.workflow.reset_workflow
   server.web.routes.v2.cli.workflow.get_workflow_status
   server.web.routes.v2.cli.workflow.get_workflow_status_viz
   server.web.routes.v2.cli.workflow.workflows_by_user_form
   server.web.routes.v2.cli.workflow.task_details_by_wf_id
   server.web.routes.v2.cli.workflow.wf_details_by_wf_id


Module Contents
---------------

.. py:data:: logger

.. py:data:: SessionMaker

.. py:data:: _cli_label_mapping

.. py:data:: _reversed_cli_label_mapping

.. py:data:: _cli_order
   :value: ['PENDING', 'SCHEDULED', 'RUNNING', 'DONE', 'FATAL']


.. py:function:: get_workflow_validation_status(request: fastapi.Request) -> Any
   :async:


   Check if workflow is valid.


.. py:function:: get_workflow_tasks(workflow_id: int, limit: int, status: Optional[list[str]] = Query(None)) -> Any

   Get the tasks for a given workflow.


.. py:function:: 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.


.. py:function:: 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'


.. py:function:: reset_workflow(workflow_id: int, request: fastapi.Request) -> Any
   :async:


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


.. py:function:: get_workflow_status(workflow_id: Optional[Union[int, str, List[Union[int, str]]]] = Query(None), limit: Optional[int] = Query(None), user: Optional[list[str]] = Query(None)) -> Any

   Get the status of the workflow.


.. py:function:: get_workflow_status_viz(workflow_ids: list[int] = Query(None)) -> Any

   Get the status of the workflows for GUI.


.. py:function:: workflows_by_user_form(user: Optional[str] = Query(None), tool: Optional[str] = Query(None), wf_name: Optional[str] = Query(None), wf_args: Optional[str] = Query(None), wf_attribute_value: Optional[str] = Query(None), wf_attribute_key: Optional[str] = Query(None), wf_id: Optional[str] = Query(None), date_submitted: Optional[str] = Query(None), date_submitted_end: Optional[str] = Query(None), status: Optional[str] = Query(None)) -> Any

   Fetch associated workflows and workflow runs by username.


.. py:function:: task_details_by_wf_id(workflow_id: int, tt_name: str) -> Any

   Fetch Task details associated with Workflow ID and TaskTemplate name.


.. py:function:: wf_details_by_wf_id(workflow_id: int) -> Any

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