Skip to main content
GET
Get one report

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

  • "created-by": Adds the report author (createdByUser with display name).
  • "anomalies-stats": Adds anomaliesStats (counts of non-deleted anomalies by status).
  • "anomalies": Adds the report anomalies (non-deleted list).
  • "attachments": Adds the report attachments (non-deleted).
  • "origin": Adds the report source: commission (PV) and/or intervention (RVRE, via coverage), with the intervention assignment.
  • "rules": Adds the covered rules, deduplicated (rule when exactly one, rules list, rulesCount).
  • "scopes": Adds the covered compliances via coverages (compliance type + rule with its technical installations + target ids).
  • "units": Adds the deduped units covered by the report (via compliances).
  • "equipments": Adds the deduped equipments covered by the report (via compliances).
  • "technical-installations": Adds the deduped technical installations covered by the report (via compliances), with presigned images.
  • "actions-info": Adds actions { canBeUpdated, canBeArchived, canBeUnarchived, canBeDeleted }.
  • "updatable-fields": Adds updatableFields { comment, status } - per-field editability for the UI.
  • "download-url": Adds a presigned downloadUrl for the report's document.
Available options:
created-by,
anomalies-stats,
anomalies,
attachments,
origin,
rules,
scopes,
units,
equipments,
technical-installations,
actions-info,
updatable-fields,
download-url

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:
pv,
rvre,
rvrat,
cr
status
enum<string>
required
Available options:
unreviewed,
pending,
processing,
pending_verification,
in_treatment,
resolved,
compliant,
with_reservations
comment
string | null
required
Maximum string length: 2000
checkedAt
string<date-time>
required
historizedAt
string<date-time> | null
required
archivedAt
string<date-time> | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
doc
object
required
createdByUser
object | null
anomaliesStats
object
anomalies
object[]
attachments
object[]
commission
object | null
intervention
object | null
rule
object | null
rules
object[]
rulesCount
integer
Required range: 0 <= x <= 9007199254740991
coverages
object[]
units
object[]
equipments
object[]
technicalInstallations
object[]
actions
object
updatableFields
object
downloadUrl
string<uri>