createTrainingQuestion

mutation · in the family Training question

What it does

Save one question into a course’s bank — the prompt, two to six options, which is right, the explanation — marked drafted or written.

Create a TrainingQuestion in the caller's org group (🎓 — THE WIRE); requires the unrestricted capability and the training-manage right. courseKey must be a live play key and stepN one of its steps (VALIDATION otherwise); a course's bank is capped at 60 non-doomed questions (CONFLICT/TRAINING_CAP). Born active — in the draw at once.

What happens

Creates a record; an active question joins the draw at once.

Who may call it

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

Owner
System Administrator
Manager
An API key whose scope allows api:createTrainingQuestion

Arguments

Name	Type	Required	Notes
`input`	NewTrainingQuestionInput `NewTrainingQuestionInput!`	yes	No 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 ExampleCreateTrainingQuestion($input: NewTrainingQuestionInput!) {
  createTrainingQuestion(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    courseKey
    stepN
    prompt
    options
    correctIndex
    explanation
    source
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "courseKey": "<course key>",
    "prompt": "<prompt>",
    "options": [
      "<options>"
    ],
    "correctIndex": 1,
    "explanation": "<explanation>",
    "source": "<source>"
  }
}

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

Example response

{
  "data": {
    "createTrainingQuestion": {
      "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

VALIDATION/INVALID — Something in the request is not valid. (VALIDATION)
AUTHN/REQUIRED — Sign in to do this. (AUTHN)
AUTHZ/FORBIDDEN — Your role does not allow this action. (AUTHZ)
RATE_LIMIT/THROTTLED — Too many requests in a short time. (RATE_LIMIT)
CONFLICT/* — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. (CONFLICT)
VALIDATION/VERSION_REQUIRED — The request did not say which app version it came from. (VALIDATION)

Dry run

Add dryRun: true to the request envelope (extensions.at) to rehearse this call: every check runs, the write is rehearsed against the current records and nothing is stored; the answer is the refusal a real call would give, or the record it would create. Every response to a rehearsal carries dryRun: true, so a rehearsed record is never mistaken for a saved one.