Fail run - Veryfront

failRun(command: RunsFailRunCommand!, idempotencyKey: String): RunsRun!

Arguments

Argument	Type	Required	Description
`command`	`RunsFailRunCommand!`	Yes
`idempotencyKey`	`String`	No	Retry key for this mutation (1-128 characters); overrides Idempotency-Key.

Input fields

command

RunsFailRunCommand

Field	Type	Required	Description
`runId`	`ID!`	Yes	Run for a terminal action. A fresh or different terminal request against an already-terminal run or stale execution generation returns 409. Retrying the identical request with the same idempotency key returns its stored result after replay authorization.
`input`	`RunsFailRunCommandInput!`	Yes	Error for a failed run.

Response

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

Field	Type	Description
`id`	`ID!`	Unique run UUID.
`runId`	`ID!`	Public run ID that run events (metadata.run_id) and runtime tools name. Equals id for runs the server names; older runs keep their run_ ID.
`status`	`String!`	Current execution state.
`projectId`	`ID!`	Project containing the run.
`target`	`RunsRunTarget!`	Execution definition; its ID may be null only on historical runs.
`input`	`JSON`	Business input supplied when the run was created.
`output`	`JSON`	Final business output; null until successful finalization.
`error`	`RunsRunError`	Failure details, present only when the run failed.

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

Example

mutation FailRun($command: RunsFailRunCommand!, $idempotencyKey: String) {
  failRun(command: $command, idempotencyKey: $idempotencyKey) {
    id
    projectId
    runId
    status
    createdAt
  }
}

{
  "command": {
    "runId": "11111111-1111-4111-8111-111111111111",
    "input": {
      "error": {
        "code": "TASK_FAILED",
        "message": "The task could not be completed."
      }
    }
  }
}