Skip to content
aimrack

Training

The training resource.

Base/training
GET/training

List trainings

Retrieve a paginated list of trainings. 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.

GET/training
curl --request GET \
  --url '<your-host>/training?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "name": "Example",
    "version": 0,
    "status": "string",
    "frequency": "string",
    "type": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "createdBy": "string"
  }
]
GET/training

Retrieve a training

Fetch a single training by filtering on `id`.

Query parameters

idstring

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

GET/training
curl --request GET \
  --url '<your-host>/training?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "version": 0,
  "status": "string",
  "frequency": "string",
  "type": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}
POST/training

Create a training

Create a new training.

Body parameters

namestringrequired
descriptionstring
versionnumberrequired
processIdstring

References process.id

statustrainingStatusrequired
frequencytrainingFrequencyrequired
typetrainingTyperequired
contentobject
estimatedDurationstring
tagsarray
assigneestring

References user.id

companyIdstring

References company.id

grantsAbilityIdstring

References ability.id

POST/training
curl --request POST \
  --url <your-host>/training \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","description":"string","version":0,"status":"string","frequency":"string","type":"string"}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "version": 0,
  "status": "string",
  "frequency": "string",
  "type": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}
PATCH/training

Update a training

Update an existing training, matched on `id`.

Body parameters

namestringrequired
descriptionstring
versionnumberrequired
processIdstring

References process.id

statustrainingStatusrequired
frequencytrainingFrequencyrequired
typetrainingTyperequired
contentobject
estimatedDurationstring
tagsarray
assigneestring

References user.id

companyIdstring

References company.id

grantsAbilityIdstring

References ability.id

PATCH/training
curl --request PATCH \
  --url '<your-host>/training?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example"}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "version": 0,
  "status": "string",
  "frequency": "string",
  "type": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}
DELETE/training

Delete a training

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

Query parameters

idstring

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

DELETE/training
curl --request DELETE \
  --url '<your-host>/training?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content