Skip to main content
GET
Get one training

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

extend
enum<string>[]

Extend options (JSON-encoded array, e.g. ?extend=["category"]):

  • "trained-users": Named attendance roster (user id/name + status + proof) and count.
  • "assigned-to": Resolves the assigned user (via identity) or provider contact (id, name).
  • "created-by": Resolves the creator as createdBy (id, name).
  • "units": Resolves every unit the training concerns - through its compliances, its anomalies, or the units and equipments it directly targets.
  • "actions-info": Adds actions { canBeUpdated, canBeArchived, canBeUnarchived, canBeDeleted }.
  • "rules": Adds the rules the training answers for, deduplicated (rule when exactly one, rules list, rulesCount), each with its rrule periodicity.
  • "counts": Adds _count of the linked comments and attachments.
  • "verification": Resolves the verifying user as verifiedBy (id, name); verifiedAt is in the default shape.
Available options:
trained-users,
assigned-to,
created-by,
units,
actions-info,
rules,
counts,
verification

Response

Default Response

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
ref
string
required
Maximum string length: 40
Pattern: ^[A-Z]+-[1-9]\d*(?:-[A-Z]+-[1-9]\d*)*$
type
enum<string>
required
Available options:
preventive,
curative,
troubleshooting,
audit,
exercise,
session,
qualification
status
enum<string>
required
Available options:
draft,
to_be_scheduled,
scheduling_in_progress,
scheduled,
in_progress,
awaiting_report,
awaiting_proof,
awaiting_validation,
validated,
rejected
title
string | null
required
Required string length: 1 - 200
description
string | null
required
Maximum string length: 2000
autoCreated
boolean
required
creationStatus
enum<string>
required
Available options:
scheduled,
done
isPlanned
boolean
required
scheduledStart
string<date-time> | null
required
scheduledEnd
string<date-time> | null
required
actualStart
string<date-time> | null
required
actualEnd
string<date-time> | null
required
verifiedAt
string<date-time> | null
required
verifiedByUserId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
assignedContactId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
assignedUserId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
organizationId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
historizedAt
string<date-time> | null
required
archivedAt
string<date-time> | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
attendeeCount
integer | null
required
Required range: 0 <= x <= 9007199254740991
trainingProof
object | null
required
trainedUsers
object[]
trainedUsersCount
integer
Required range: 0 <= x <= 9007199254740991
assignedUser
object | null
assignedContact
object | null
createdBy
object | null
units
object[]
actions
object
rule
object | null
rules
object[]
rulesCount
integer
Required range: 0 <= x <= 9007199254740991
_count
object
verifiedBy
object | null