workflow

workflow#

Classes:

`AppliedWorkflowTag`
`ApplyWorkflowRequest`	Request body for the workflow apply endpoint.
`UpdateWorkflow`
`Workflow`
`WorkflowJob`
`WorkflowParameter`
`WorkflowParent`
`WorkflowParentGroup`

class AppliedWorkflowTag#

Attributes:

`colour`
`description`
`title`
`uid`

colour: Literal['black', 'gray', 'red', 'orange', 'yellow', 'green', 'teal', 'cyan', 'sky', 'blue', 'indigo', 'purple', 'pink'] | None#

description: str | None#

title: str | None#

uid: str | None#

class ApplyWorkflowRequest#

Request body for the workflow apply endpoint.

Attributes:

`group`
`lane`
`parent_juids`
`tag`
`workflow`

group: JobGroupMeta | None#

lane: str | None#

parent_juids: List[str]#

tag: AppliedWorkflowTag | None#

workflow: Workflow#

class UpdateWorkflow#

Attributes:

`category`
`description`
`jobs`
`parents`
`pinned`
`title`

category: str | None#

description: str | None#

jobs: Dict[str, WorkflowJob] | None#

parents: Dict[str, WorkflowParent] | None#

pinned: bool | None#

title: str | None#

class Workflow#

Attributes:

`category`
`createdAt`
`createdBy`
`csVersion`
`description`
`id`
`imported`
`jobs`	Dictionary of jobs for the workflow, where the key is JXX
`parents`	Dictionary of parent jobs for the workflow, where the key is PXX
`pinned`
`reference`
`title`
`updatedAt`
`updatedBy`
`workflowVersion`

category: str#

createdAt: datetime#

createdBy: str | None#

csVersion: str#

description: str#

id: str#

imported: bool#

jobs: Dict[str, WorkflowJob]#: Dictionary of jobs for the workflow, where the key is JXX

parents: Dict[str, WorkflowParent]#: Dictionary of parent jobs for the workflow, where the key is PXX

pinned: bool#

reference: bool#

title: str#

updatedAt: datetime#

updatedBy: str | None#

workflowVersion: str#

class WorkflowJob#

Attributes:

`description`
`groups`
`individualResults`	Array representing result overrides for the app, computed from the spec.
`jobType`
`parameters`
`spec`
`title`

description: str#

groups: List[List[str]]#

individualResults: List[List[str]]#: Array representing result overrides for the app, computed from the spec. This consists of a list of string pairs, with the first string pair representing the source result and the second the destination result, in the format of [“{result.job_uid}.{result.output}.{result.result}”, “{uid}.{input_name}.{conn_idx}.{result.name}”,]

jobType: str#

parameters: Dict[str, WorkflowParameter]#

spec: JobSpec#

title: str#

class WorkflowParameter#

Attributes:

`flagged`
`locked`
`notes`
`value`
`visible`

flagged: bool#

locked: bool#

notes: str#

value: str | int | float | bool | None#

visible: bool#

class WorkflowParent#

Attributes:

`groups`
`jobType`

groups: Dict[str, WorkflowParentGroup]#

jobType: str#

class WorkflowParentGroup#

Attributes:

`connections`
`name`
`required`

connections: List[str]#

name: str#

required: List[str]#

workflow

Contents

workflow#