Skip to main content
GET
Get one anomaly

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

  • "is-new": Adds isNew: true when this anomaly is the earliest occurrence of its case, by report control date. False when a case already has an older occurrence - and false too when the anomaly carries no case at all (a ticket, an observation).
  • "actions-info": Adds actions { canBeUpdated, canBeArchived, canBeUnarchived, canBeDeleted, canBeResolved, canBeUnresolved }.
  • "updatable-fields": Adds updatableFields - per-type editable-field flags.
  • "sightings": Adds the observation sightings (signalements), newest first.
  • "sightings-count": Adds sightingsCount - how many times this anomaly has been reported (grouped ticketing).
  • "position": Plan position (PlanItem) when the anomaly is placed on a plan.
  • "unit": Hydrates the linked unit (id, ref, name).
  • "technical-installation": Hydrates the linked technical installation (id, ref, name, image with a presigned download URL).
  • "equipment": Hydrates the linked equipment (id, ref, name).
  • "report": Hydrates the linked report (id, ref, status) - non-conformity / prescription.
  • "origin": Adds origin: the reporter (observation, ticket), linked commission (prescription), linked intervention's assignee (non-conformity), and the source report reference (page/ref) when set.
  • "interventions": Adds interventions: the anomaly's linked curative interventions (comment/providerAction/clientDecision/attachments).
  • "resolution": Adds resolution { resolvedBy, resolvedByProvider } once the anomaly is resolved (resolver = the assignee at resolution time).
  • "library-anomaly": Hydrates the source library template (id, title, resolutionDelay, category, subCategory).
  • "assignee": Adds assignee { id, name } - the user the anomaly is assigned to.
Available options:
is-new,
actions-info,
updatable-fields,
sightings,
sightings-count,
position,
unit,
technical-installation,
equipment,
report,
origin,
interventions,
resolution,
library-anomaly,
assignee

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:
non_conformity,
observation,
prescription,
audit,
ticket
status
enum<string>
required
Available options:
extracted,
unreviewed,
pending,
resolved
risk
enum<string>
required
Available options:
low,
medium,
high,
critic
title
string
required
Required string length: 1 - 300
description
string | null
required
Maximum string length: 5000
externalReference
string | null
required
Required string length: 1 - 100
unitId
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)$
technicalInstallationId
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)$
equipmentId
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)$
libraryAnomalyId
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)$
reportId
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)$
caseId
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)$
sortOrder
number | null
required
pageNumber
integer | null
required
Required range: 0 < x <= 9007199254740991
assignedToUserId
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)$
resolvedComment
string | null
required
Maximum string length: 2000
location
string | null
required
Maximum string length: 200
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)$
observedAt
string<date-time> | null
required
dueAt
string<date-time> | null
required
resolvedAt
string<date-time> | null
required
historizedAt
string<date-time> | null
required
archivedAt
string<date-time> | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
isNew
boolean
actions
object
updatableFields
object
sightings
object[]
sightingsCount
integer
Required range: 0 <= x <= 9007199254740991
position
object | null
unit
object | null
technicalInstallation
object | null
equipment
object | null
report
object | null
origin
object
interventions
object[]
resolution
object
libraryAnomaly
object | null
assignee
object | null