Skip to main content
GET
Get one intervention

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"]):

  • "assignee": Resolve the assigned user (id/ref/name) and the assigned provider contact (name, email, provider).
  • "units": Resolves every unit the intervention concerns - through its compliances, its anomalies, or the units and equipments it directly targets.
  • "equipments": Resolves every equipment the intervention concerns - through its compliances, or the equipments it directly targets.
  • "verification": Resolve the verifying user (id/ref/name); verifiedAt and decisionComment are in the default shape.
  • "counts": Adds _count of linked signatures (the delete guard), plus commentsCount and reportsCount.
  • "actions-info": Adds actions { canBeUpdated, canBeArchived, canBeUnarchived, canBeDeleted, canBeVerified }.
  • "createdBy": Include the creator's identity as createdBy (id, ref, name).
  • "routine": Resolve the linked routine (id/ref/name).
  • "anomalies-stats": Adds anomaliesStats (counts of the linked anomalies by status).
  • "rules": Adds the covered rules, deduplicated (rule when exactly one, rules list, rulesCount).
  • "technical-installations": Technical installations behind the covered rules (main + concerned), deduped with presigned images.
  • "signed-by": Adds signedBy (name of the latest signer, null until a signature exists).
  • "signatures": Adds the signatures (signer, role, date, comment, handwritten trace, unit, provider) with the compliance coverages each one signed off. A trace that does not match the capture shape comes back null.
Available options:
assignee,
units,
equipments,
verification,
counts,
actions-info,
createdBy,
routine,
anomalies-stats,
rules,
technical-installations,
signed-by,
signatures

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
creationStatus
enum<string>
required
Available options:
scheduled,
done
isPlanned
boolean
required
autoCreated
boolean
required
scheduledStart
string<date-time> | null
required
scheduledEnd
string<date-time> | null
required
dueAt
string<date-time> | null
required
actualStart
string<date-time> | null
required
actualEnd
string<date-time> | null
required
verifiedAt
string<date-time> | null
required
decisionComment
string | null
required
Maximum string length: 2000
historizedAt
string<date-time> | null
required
archivedAt
string<date-time> | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
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)$
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)$
routineId
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)$
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)$
assignedUser
object | null
assignedContact
object | null
units
object[]
equipments
object[]
verifiedByUser
object | null
_count
object
commentsCount
integer
Required range: 0 <= x <= 9007199254740991
reportsCount
integer
Required range: 0 <= x <= 9007199254740991
actions
object
createdBy
object | null
routine
object | null
anomaliesStats
object
rule
object | null
rules
object[]
rulesCount
integer
Required range: 0 <= x <= 9007199254740991
technicalInstallations
object[]
signedBy
string | null
signatures
object[]