Read workflow source

workflowSource(projectReference: String!, workflowId: String!, input: SourceReadSelectorInput): WorkflowSource!

Requires project.runs.read.

Arguments

ArgumentTypeRequired
projectReferenceString!Yes
workflowIdString!Yes
inputSourceReadSelectorInputNo

Input fields

input

SourceReadSelectorInput

FieldTypeRequiredDescription
sourceTargetKindWriteTargetKindNoThe source to read; default runtimeTargetKind, else project.
runtimeTargetKindRuntimeTargetKindNoUsed as the source to read when sourceTargetKind is omitted.
targetBranchIdIDNoRequired with the kind preview_branch.
targetEnvironmentIdIDNoNot supported for source reads; a non-null value is refused as invalid_input.

Response

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

FieldTypeDescription
idID!
nameString!
descriptionString
targetString!
sourcePathString!
sourceString!The source text of the workflow file.
versionString
schedulableBoolean!

All fields of WorkflowSource.

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

Example

graphql
query WorkflowSource($projectReference: String!, $workflowId: String!, $input: SourceReadSelectorInput) {
  workflowSource(projectReference: $projectReference, workflowId: $workflowId, input: $input) {
    id
    name
    description
    editMode
    schedulable
  }
}
json
{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "workflowId": "00000000-0000-4000-8000-000000000001"
}