Get workflow

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

Requires project.runs.read.

Arguments

ArgumentTypeRequired
projectReferenceString!Yes
workflowIdString!Yes
inputSourceSelectorInputNo

Input fields

input

SourceSelectorInput

FieldTypeRequiredDescription
sourceTargetKindSourceTargetKindNoThe source to read; default runtimeTargetKind, else project.
runtimeTargetKindRuntimeTargetKindNoUsed as the source to read when sourceTargetKind is omitted.
targetEnvironmentIdIDNoRequired with the kind environment.
targetBranchIdIDNoRequired with the kind preview_branch.

Response

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

FieldTypeDescription
idID!
nameString!
descriptionString
targetString!The execution target that implements the workflow.
sourcePathString!
editModeWorkflowEditMode!
versionString
inputSchemaJSONThe 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

graphql
query Workflow($projectReference: String!, $workflowId: String!, $input: SourceSelectorInput) {
  workflow(projectReference: $projectReference, workflowId: $workflowId, input: $input) {
    id
    name
    description
    editMode
    inputSchema
  }
}
json
{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "workflowId": "00000000-0000-4000-8000-000000000001"
}