> ## Documentation Index > Fetch the complete documentation index at: https://api-documentation.kare-app.fr/llms.txt > Use this file to discover all available pages before exploring further. # Get one report ## OpenAPI ````yaml /api/rs/openapi.json get /rs/reports/v1/{id} openapi: 3.0.3 info: title: KARE API description: Backend API for the KARE platform version: dev servers: - url: http://localhost:3000 description: Local dev security: [] tags: - name: better-auth description: >- Better Auth's own endpoints (sign-in, session, MFA, password) - generated from the audience's live config via `generateOpenAPISchema()`, not hand-written. paths: /rs/reports/v1/{id}: get: tags: - reports summary: Get one report operationId: getReportRSV1 parameters: - schema: type: array items: type: string enum: - created-by - anomalies-stats - anomalies - attachments - origin - rules - scopes - units - equipments - technical-installations - actions-info - updatable-fields - download-url description: >- 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. in: query name: extend required: false - schema: type: string format: uuid 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)$ in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: id: type: string format: uuid 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: type: string maxLength: 40 pattern: ^[A-Z]+-[1-9]\d*(?:-[A-Z]+-[1-9]\d*)*$ type: type: string enum: - pv - rvre - rvrat - cr status: type: string enum: - unreviewed - pending - processing - pending_verification - in_treatment - resolved - compliant - with_reservations comment: nullable: true type: string maxLength: 2000 checkedAt: type: string format: date-time historizedAt: nullable: true type: string format: date-time archivedAt: nullable: true type: string format: date-time createdAt: type: string format: date-time updatedAt: type: string format: date-time doc: type: object properties: id: type: string format: uuid 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: type: string maxLength: 40 pattern: ^[A-Z]+-[1-9]\d*(?:-[A-Z]+-[1-9]\d*)*$ name: type: string minLength: 1 maxLength: 255 required: - id - ref - name additionalProperties: false createdByUser: nullable: true type: object properties: id: type: string format: uuid 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)$ name: type: string required: - id - name additionalProperties: false anomaliesStats: type: object properties: total: type: integer minimum: 0 maximum: 9007199254740991 extracted: type: integer minimum: 0 maximum: 9007199254740991 unreviewed: type: integer minimum: 0 maximum: 9007199254740991 pending: type: integer minimum: 0 maximum: 9007199254740991 resolved: type: integer minimum: 0 maximum: 9007199254740991 required: - total - extracted - unreviewed - pending - resolved additionalProperties: false anomalies: type: array items: type: object properties: id: type: string format: uuid 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: type: string maxLength: 40 pattern: ^[A-Z]+-[1-9]\d*(?:-[A-Z]+-[1-9]\d*)*$ type: type: string enum: - non_conformity - observation - prescription - audit - ticket status: type: string enum: - extracted - unreviewed - pending - resolved risk: type: string enum: - low - medium - high - critic title: type: string minLength: 1 maxLength: 300 required: - id - ref - type - status - risk - title additionalProperties: false attachments: type: array items: type: object properties: id: type: string format: uuid 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)$ name: type: string minLength: 1 maxLength: 255 mimeType: type: string minLength: 1 maxLength: 100 size: type: integer minimum: 0 exclusiveMinimum: true maximum: 1073741824 slot: nullable: true type: string minLength: 1 maxLength: 50 required: - id - name - mimeType - size - slot additionalProperties: false commission: nullable: true type: object properties: id: type: string format: uuid 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: type: string maxLength: 40 pattern: ^[A-Z]+-[1-9]\d*(?:-[A-Z]+-[1-9]\d*)*$ visitType: type: string status: type: string heldAt: nullable: true type: string format: date-time signedBy: nullable: true type: string required: - id - ref - visitType - status - heldAt - signedBy additionalProperties: false intervention: nullable: true type: object properties: id: type: string format: uuid 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: type: string maxLength: 40 pattern: ^[A-Z]+-[1-9]\d*(?:-[A-Z]+-[1-9]\d*)*$ type: type: string status: type: string scheduledStart: nullable: true type: string format: date-time scheduledEnd: nullable: true type: string format: date-time signedBy: nullable: true type: string assignedUser: nullable: true type: object properties: id: type: string format: uuid 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)$ name: type: string required: - id - name additionalProperties: false assignedContact: nullable: true type: object properties: id: type: string format: uuid 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)$ name: type: string provider: type: object properties: id: type: string format: uuid 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)$ name: type: string types: type: array items: type: string required: - id - name - types additionalProperties: false required: - id - name - provider additionalProperties: false required: - id - ref - type - status - scheduledStart - scheduledEnd - signedBy - assignedUser - assignedContact additionalProperties: false rule: nullable: true type: object properties: id: type: string format: uuid 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)$ name: type: string required: - id - name additionalProperties: false rules: type: array items: type: object properties: id: type: string format: uuid 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)$ name: type: string required: - id - name additionalProperties: false rulesCount: type: integer minimum: 0 maximum: 9007199254740991 coverages: type: array items: type: object properties: id: type: string format: uuid 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)$ compliance: type: object properties: id: type: string format: uuid 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)$ type: type: string enum: - site - equipment - user unitId: nullable: true type: string format: uuid 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: nullable: true type: string format: uuid 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)$ userId: nullable: true type: string format: uuid 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)$ rule: type: object properties: id: type: string format: uuid 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)$ name: type: string minLength: 1 maxLength: 200 technicalInstallations: type: array items: type: object properties: id: type: string format: uuid 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)$ name: type: string minLength: 1 maxLength: 150 imageUrl: nullable: true type: string format: uri required: - id - name - imageUrl additionalProperties: false required: - id - name - technicalInstallations additionalProperties: false required: - id - type - unitId - equipmentId - userId - rule additionalProperties: false required: - id - compliance additionalProperties: false units: type: array items: type: object properties: id: type: string format: uuid 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)$ name: type: string minLength: 1 maxLength: 150 required: - id - name additionalProperties: false equipments: type: array items: type: object properties: id: type: string format: uuid 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)$ name: type: string minLength: 1 maxLength: 150 required: - id - name additionalProperties: false technicalInstallations: type: array items: type: object properties: id: type: string format: uuid 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)$ name: type: string minLength: 1 maxLength: 150 imageUrl: nullable: true type: string format: uri required: - id - name - imageUrl additionalProperties: false actions: type: object properties: canBeUpdated: type: boolean canBeArchived: type: boolean canBeUnarchived: type: boolean canBeDeleted: type: boolean canBeRestored: type: boolean canSetCoverages: type: boolean required: - canBeUpdated - canBeArchived - canBeUnarchived - canBeDeleted - canBeRestored - canSetCoverages additionalProperties: false updatableFields: type: object properties: comment: type: boolean status: type: boolean required: - comment - status additionalProperties: false downloadUrl: type: string format: uri required: - id - ref - type - status - comment - checkedAt - historizedAt - archivedAt - createdAt - updatedAt - doc additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: error: type: string message: type: string requestId: type: string details: {} required: - error - message - requestId additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: error: type: string message: type: string requestId: type: string details: {} required: - error - message - requestId additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: error: type: string message: type: string requestId: type: string details: {} required: - error - message - requestId additionalProperties: false ````