Training Question

The training question resource.

Basehttps://rest.carbon.ms/trainingQuestion

GET/trainingQuestion

List training questions

Retrieve a paginated list of training questions. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/trainingQuestion

curl --request GET \
  --url 'https://rest.carbon.ms/trainingQuestion?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "trainingId": "xyz789",
    "question": "string",
    "type": "string",
    "sortOrder": 0,
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z",
    "createdBy": "string"
  }
]

GET/trainingQuestion

Retrieve a training question

Fetch a single training question by filtering on `id`.

Query parameters

idstring

Match on the training question's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/trainingQuestion

curl --request GET \
  --url 'https://rest.carbon.ms/trainingQuestion?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "trainingId": "xyz789",
  "question": "string",
  "type": "string",
  "sortOrder": 0,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}

POST/trainingQuestion

Create a training question

Create a new training question.

Body parameters

trainingIdstringrequired

References training.id

questionstringrequired

typetrainingQuestionTyperequired

sortOrdernumberrequired

requiredboolean

optionsarray

correctAnswersarray

correctBooleanboolean

matchingPairsobject

correctNumbernumber

tolerancenumber

companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/trainingQuestion

curl --request POST \
  --url https://rest.carbon.ms/trainingQuestion \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"trainingId":"xyz789","question":"string","type":"string","sortOrder":0,"companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "trainingId": "xyz789",
  "question": "string",
  "type": "string",
  "sortOrder": 0,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}

PATCH/trainingQuestion

Update a training question

Update an existing training question, matched on `id`.

Body parameters

trainingIdstringrequired

References training.id

questionstringrequired

typetrainingQuestionTyperequired

sortOrdernumberrequired

requiredboolean

optionsarray

correctAnswersarray

correctBooleanboolean

matchingPairsobject

correctNumbernumber

tolerancenumber

companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/trainingQuestion

curl --request PATCH \
  --url 'https://rest.carbon.ms/trainingQuestion?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"trainingId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "trainingId": "xyz789",
  "question": "string",
  "type": "string",
  "sortOrder": 0,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}

DELETE/trainingQuestion

Delete a training question

Delete a training question, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the training question to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/trainingQuestion

curl --request DELETE \
  --url 'https://rest.carbon.ms/trainingQuestion?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content