Developers
Exams19

Update an exam question

PATCH/products/{product_id}/exams/{exam_id}/questions/{exam_question_id}

Updates an exam question. When alternatives is supplied, it replaces the entire set of alternatives. Answers already recorded in completed attempts are not regraded.

To avoid overwriting a newer version, send the ETag from the retrieve operation in the If-Match header.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

product_id*string

Public ID of the product, prefixed with prd_.

exam_id*string

Public ID of the exam, prefixed with exm_.

exam_question_id*string

Public ID of the exam question, prefixed with exq_.

Header Parameters

Idempotency-Key?string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

If-Match?string

Expected revision of the resource, in the same format as the ETag header (W/"<type>:<id>:<revision>"). If the resource has changed since that revision, the request fails with 412 and the revision_mismatch error code. * matches the current revision. Any other value fails with 400 and the if_match_invalid error code. When omitted, the update is applied to the current revision.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/products/string/exams/string/questions/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "alternatives": [      {        "correct": true,        "id": "string",        "text": "string"      }    ],    "created_at": "2019-08-24T14:15:22Z",    "deleted": true,    "exam_id": "string",    "format": "multiple_choice",    "id": "string",    "image": "string",    "object": "exam_question",    "position": 0,    "revision": "string",    "text": "string",    "updated_at": "2019-08-24T14:15:22Z"  }}

Retrieve an exam question GET

The `correct` field of each alternative is included only when the current credentials have the `exams.read_answer_key` permission; otherwise, the field is omitted.

Delete an exam question DELETE

Moves the question to the trash. Attempts that already answered the question remain unchanged.