server.web.routes.v3.cli.task_template

Routes for TaskTemplate.

Attributes

logger

Functions

`get_task_template_details_for_workflow`(, ...)	Fetch Task Template details (ID, Name, and Version) for a given Workflow.
`get_task_template_version_for_tasks`() → Any)	Get the task_template_version_ids using repository pattern.
`get_requested_cores`() → Any)	Get the min, max, and avg of requested cores.
`get_most_popular_queue`(, db)	Get the most popular queue of the task template.
`get_task_template_resource_usage`(...)	Unified endpoint for task template resource usage.
`get_task_template_resource_aggregates`(...)	Server-computed aggregates (KPIs, clusters, efficiency) for a task template.
`get_workflow_tt_status_viz`(, dialect)	Get the status of the workflows for GUI.
`get_workflow_has_resource_errors`(...)	Check if any task instances in this workflow have resource errors.
`get_fatal_error_breakdown`(...)	Classify fatal errors for one template by type.
`get_tt_error_log_viz`() → Any)	Get the error logs for a task template id for GUI.

Module Contents

server.web.routes.v3.cli.task_template.logger

server.web.routes.v3.cli.task_template.get_task_template_details_for_workflow(workflow_id: int = Query(..., ge=1), task_template_id: int = Query(..., ge=1), task_template_version_id: int | None = None, db: sqlalchemy.orm.Session = Depends(get_db)) → Any: Fetch Task Template details (ID, Name, and Version) for a given Workflow.

server.web.routes.v3.cli.task_template.get_task_template_version_for_tasks(task_id: int | None = None, workflow_id: int | None = None, db: sqlalchemy.orm.Session = Depends(get_db)) → Any: Get the task_template_version_ids using repository pattern.

server.web.routes.v3.cli.task_template.get_requested_cores(task_template_version_ids: str | None = None, db: sqlalchemy.orm.Session = Depends(get_db)) → Any: Get the min, max, and avg of requested cores.

server.web.routes.v3.cli.task_template.get_most_popular_queue(task_template_version_ids: str | None = Query(...), db: sqlalchemy.orm.Session = Depends(get_db)) → Any: Get the most popular queue of the task template.

async server.web.routes.v3.cli.task_template.get_task_template_resource_usage(request_data: jobmon.server.web.schemas.task_template.TaskTemplateResourceUsageRequest, db: sqlalchemy.orm.Session = Depends(get_db)) → jobmon.server.web.schemas.task_template.TaskTemplateResourceUsageResponse

Unified endpoint for task template resource usage.

Returns modern Pydantic models suitable for both GUI frontend and Python client consumption with full type safety.

async server.web.routes.v3.cli.task_template.get_task_template_resource_aggregates(request_data: jobmon.server.web.schemas.task_template.TaskTemplateResourceAggregatesRequest, db: sqlalchemy.orm.Session = Depends(get_db)) → jobmon.server.web.schemas.task_template.TaskTemplateResourceAggregatesResponse

Server-computed aggregates (KPIs, clusters, efficiency) for a task template.

Uses a narrow-column query and avoids materializing the full task_instance × task × task_resources payload that the viz endpoint returns.

server.web.routes.v3.cli.task_template.get_workflow_tt_status_viz(workflow_id: int, db: sqlalchemy.orm.Session = Depends(get_db), dialect: str = Depends(get_dialect)) → Any: Get the status of the workflows for GUI.

server.web.routes.v3.cli.task_template.get_workflow_has_resource_errors(workflow_id: int, db: sqlalchemy.orm.Session = Depends(get_db)) → jobmon.server.web.schemas.task_template.WorkflowResourceErrorCheckResponse: Check if any task instances in this workflow have resource errors.

server.web.routes.v3.cli.task_template.get_fatal_error_breakdown(workflow_id: int, tt_version_id: int, workflow_run_id: int | None = None, db: sqlalchemy.orm.Session = Depends(get_db)) → jobmon.server.web.schemas.task_template.FatalErrorBreakdownResponse: Classify fatal errors for one template by type.

server.web.routes.v3.cli.task_template.get_tt_error_log_viz(wf_id: int, tt_id: int | None = None, ti_id: int | None = None, page: int = 1, page_size: int = 10, just_recent_errors: str = 'false', cluster_errors: str = 'false', fatal_tasks_only: str = 'false', workflow_run_id: int | None = None, task_template_version_id: int | None = None, db: sqlalchemy.orm.Session = Depends(get_db)) → Any: Get the error logs for a task template id for GUI.