Get task

task(projectReference: String!, taskId: String!, input: SourceSelectorInput): Task!

Requires project.runs.read.

Arguments

ArgumentTypeRequired
projectReferenceString!Yes
taskIdString!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 Task!. Open the type for its fields and nested types.

FieldTypeDescription
idID!
nameString!
descriptionString
targetString!The execution target that implements the task.
sourcePathString!
editModeTaskEditMode!
inputSchemaJSONThe JSON Schema of the task input, when the task declares one.
outputSchemaJSONThe JSON Schema of the task output, when the task declares one.

All fields of Task.

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

Example

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