answerWorkflowQuestion

Mutation

mutation AnswerWorkflowQuestion($batchId: ID!, $answers: JSON!) {
  answerWorkflowQuestion(batchId: $batchId, answers: $answers) {
    id
    displayNumber
    workflowId
    workflow {
      id
      name
      description
      draftDefinition
      draftSchemaVersion
      activeVersionId
    }
    versionId
    version {
      id
      workflowId
      version
      name
      description
      schemaVersion
    }
  }
}

Variables

{
  "batchId": "id",
  "answers": "value"
}

Response

{
  "data": {
    "answerWorkflowQuestion": {
      "id": "id",
      "displayNumber": 1,
      "workflowId": "id",
      "workflow": {
        "id": "id",
        "name": "string",
        "description": "string",
        "draftDefinition": "value",
        "draftSchemaVersion": 1,
        "activeVersionId": "id"
      },
      "versionId": "id",
      "version": {
        "id": "id",
        "workflowId": "id",
        "version": 1,
        "name": "string",
        "description": "string",
        "schemaVersion": 1
      }
    }
  }
}

MUTATION

answerWorkflowQuestion(batchId: ID!, answers: JSON!): WorkflowRun!

Arguments

batchId

ID!

required

Identifier of the batch.

answers

JSON!

required

The answers used to filter or perform the operation.

Returns

WorkflowRun!

ID!

Stable identifier for this workflow run.

displayNumber

Int!

The display number associated with this workflow run.

workflowId

ID!

Identifier of the related workflow.

workflow

Workflow!

The workflow associated with this workflow run.

versionId

ID!

Identifier of the related version.

version

WorkflowVersion!

Version reported for this workflow run.

triggerId

Identifier of the related trigger. May be null when unavailable or not applicable.

trigger

WorkflowTrigger

The trigger associated with this workflow run. May be null when unavailable or not applicable.

triggerEventId

Identifier of the related trigger event. May be null when unavailable or not applicable.

parentRunId

Identifier of the related parent run. May be null when unavailable or not applicable.

parentRun

WorkflowRun

The parent run associated with this workflow run. May be null when unavailable or not applicable.

childRuns

[WorkflowRun!]!

Child runs associated with this workflow run.

triggerKind

String!

The trigger kind associated with this workflow run.

triggerSubjectKey

String!

The trigger subject key associated with this workflow run.

triggerPayload

JSON!

The trigger payload associated with this workflow run.

status

WorkflowRunStatus!

Current status of this workflow run.

phase

String!

The phase associated with this workflow run.

exclusiveWorktree

Boolean!

Whether this run was configured to reserve its worktree exclusively.

worktreeConcurrency

WorkflowWorktreeConcurrency!

The immutable worktree concurrency mode captured when this run was created.

blocksGitOperations

Boolean!

The immutable Git-blocking setting captured when this run was created.

generation

Int!

The generation associated with this workflow run.

sessionData

JSON!

The session data associated with this workflow run.

sessionRevision

Int!

The session revision associated with this workflow run.

worktree

WorkflowRunWorktreeRef

The worktree associated with this workflow run. May be null when unavailable or not applicable.

agent

Agent

The agent this workflow run executed on. May be null when the run did not target an agent or the agent is no longer available.

queue

[WorktreeRunQueueEntry!]!

Effective admission queue while this run is queued, including work ahead of it. Empty after admission.

blockedReason

String

The blocked reason associated with this workflow run. May be null when unavailable or not applicable.

error

String

Error message when this workflow run did not complete successfully. May be null when unavailable or not applicable.

queuedAt

String!

ISO 8601 timestamp when this workflow run was queued.

startedAt

String

ISO 8601 timestamp when this workflow run started. May be null when unavailable or not applicable.

pausedAt

String

ISO 8601 timestamp when this workflow run was paused. May be null when unavailable or not applicable.

finishedAt

String

ISO 8601 timestamp when this workflow run finished. May be null when unavailable or not applicable.

archivedAt

String

ISO 8601 timestamp when this workflow run was archived. May be null when unavailable or not applicable.

createdAt

String!

ISO 8601 timestamp when this workflow run was created.

updatedAt

String!

ISO 8601 timestamp when this workflow run was last updated.

attempts

[WorkflowStepAttempt!]!

Attempts associated with this workflow run.

waits

[WorkflowWait!]!

Waits associated with this workflow run.

events

[WorkflowRunEvent!]!

Events associated with this workflow run.

resourceLinks

[WorkflowRunResourceLink!]!

Resource links associated with this workflow run.

attemptCount

Int!

Number of attempts.

eventCount

Int!

Number of events.

Mutation

mutation AnswerWorkflowQuestion($batchId: ID!, $answers: JSON!) {
  answerWorkflowQuestion(batchId: $batchId, answers: $answers) {
    id
    displayNumber
    workflowId
    workflow {
      id
      name
      description
      draftDefinition
      draftSchemaVersion
      activeVersionId
    }
    versionId
    version {
      id
      workflowId
      version
      name
      description
      schemaVersion
    }
  }
}

Variables

{
  "batchId": "id",
  "answers": "value"
}

Response

{
  "data": {
    "answerWorkflowQuestion": {
      "id": "id",
      "displayNumber": 1,
      "workflowId": "id",
      "workflow": {
        "id": "id",
        "name": "string",
        "description": "string",
        "draftDefinition": "value",
        "draftSchemaVersion": 1,
        "activeVersionId": "id"
      },
      "versionId": "id",
      "version": {
        "id": "id",
        "workflowId": "id",
        "version": 1,
        "name": "string",
        "description": "string",
        "schemaVersion": 1
      }
    }
  }
}

Overview

Queries

Mutations

Types

Arguments

Returns