AlmondTill/G3N API

On this page

deactivateTrainingQuestion

mutation · in the family Training question

What it does

Retire a question from the draw — kept, never asked, until reactivated.

Retire a TrainingQuestion from the draw (active→inactive) — kept, never asked, until reactivated; sittings already submitted keep their grades. Requires the unrestricted capability + the CURRENT revision.

What happens

Reversible.

Who may call it

Capability area: Training — Courses, tests, certificates and the training rules of your team.

Arguments

NameTypeRequiredNotes
idID ID!yesThe id of the record.
revisionID ID!yesThe revision id you read on the record; the change is refused if an edit landed in the meantime.
reasonStringnoNo further notes.

Returns

TrainingQuestion TrainingQuestion! — A TrainingQuestion (🎓 — THE TRAINING PROGRAM, THE WIRE): ONE multiple-choice question of a course's bank — the prompt (at most 400 characters), 2..6 options (each at most 200 characters), correctIndex (0-based, below the options' count), the explanation shown after a sitting (at most 400 characters), the optional play step it tests and its source (drafted | written). THE STRICT SCHEMA: no unknown keys. active = in the draw · inactive = retired from the draw, kept · doomed. A course's bank holds at most 60 non-doomed questions (CONFLICT/TRAINING_CAP past it). courseKey is IMMUTABLE after birth. A submitted attempt is graded against ITS stored draw — a later edit here never re-grades it. NOT searchable (no filter roster until the face).

Example request

mutation ExampleDeactivateTrainingQuestion($id: ID!, $revision: ID!, $reason: String) {
  deactivateTrainingQuestion(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    courseKey
    stepN
    prompt
    options
    correctIndex
    explanation
    source
  }
}

Variables:

{
  "id": "01900000-0000-7000-8000-37386ae00000",
  "revision": "01900000-0000-7000-8000-b7960e180000",
  "reason": "Correcting a miscount."
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "deactivateTrainingQuestion": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "TQ-EXMP-0000-000F",
      "type": "TrainingQuestion",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "courseKey": "<course key>",
      "stepN": 1,
      "prompt": "<prompt>",
      "options": [
        "<options>"
      ],
      "correctIndex": 1,
      "explanation": "<explanation>",
      "source": "<source>"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer