Get workflow - Veryfront

workflow(projectReference: String!, workflowId: String!, input: SourceSelectorInput): Workflow!

Requires project.runs.read.

Arguments

Argument	Type	Required
`projectReference`	`String!`	Yes
`workflowId`	`String!`	Yes
`input`	`SourceSelectorInput`	No

Input fields

input

SourceSelectorInput

Field	Type	Required	Description
`sourceTargetKind`	`SourceTargetKind`	No	The source to read; default runtimeTargetKind, else project.
`runtimeTargetKind`	`RuntimeTargetKind`	No	Used as the source to read when sourceTargetKind is omitted.
`targetEnvironmentId`	`ID`	No	Required with the kind environment.
`targetBranchId`	`ID`	No	Required with the kind preview_branch.

Response

Returns Workflow!. Open the type for its fields and nested types.

Field	Type	Description
`id`	`ID!`
`name`	`String!`
`description`	`String`
`target`	`String!`	The execution target that implements the workflow.
`sourcePath`	`String!`
`editMode`	`WorkflowEditMode!`
`version`	`String`
`inputSchema`	`JSON`	The JSON Schema of the workflow input, when the workflow declares one.

All fields of Workflow. Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

query Workflow($projectReference: String!, $workflowId: String!, $input: SourceSelectorInput) {
  workflow(projectReference: $projectReference, workflowId: $workflowId, input: $input) {
    id
    name
    description
    editMode
    inputSchema
  }
}

{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "workflowId": "00000000-0000-4000-8000-000000000001"
}