Aller au contenu principal

Rapports

Génération, téléchargement et planification des rapports PDF et Excel.

GET /api/v1/entities/{entityId}/reports/dora-roi/validate GET /api/v1/entities/{entityId}/reports/exports GET /api/v1/entities/{entityId}/reports/exports/{exportId} DELETE /api/v1/entities/{entityId}/reports/exports/{exportId} GET /api/v1/entities/{entityId}/reports/exports/{exportId}/download POST /api/v1/entities/{entityId}/reports/generate GET /api/v1/entities/{entityId}/reports/metrics POST /api/v1/entities/{entityId}/reports/preview GET /api/v1/entities/{entityId}/reports/schedules POST /api/v1/entities/{entityId}/reports/schedules GET /api/v1/entities/{entityId}/reports/schedules/{scheduleId} PUT /api/v1/entities/{entityId}/reports/schedules/{scheduleId} DELETE /api/v1/entities/{entityId}/reports/schedules/{scheduleId} POST /api/v1/entities/{entityId}/reports/snapshots/generate GET /api/v1/entities/{entityId}/reports/types

GET /api/v1/entities/{entityId}/reports/dora-roi/validate

Accès
Permission rapports : lecture (Reports.Read) , accordée par le rôle de l’utilisateur sur l’entité du chemin.
Limite de débit
aucune (les lectures ne sont pas limitées)

Paramètres

Nom Où Type Contraintes
entityId requis chemin string (uuid) —

Réponse 200 · application/json

Schéma DoraRoiValidationResponse

Champ Type Contraintes
completionPercentage integer —
isValid boolean —
exportAllowed boolean —
warnings DoraRoiValidationItem[] —
errors DoraRoiValidationItem[] —

GET /api/v1/entities/{entityId}/reports/exports

Accès
Permission rapports : lecture (Reports.Read) , accordée par le rôle de l’utilisateur sur l’entité du chemin.
Limite de débit
aucune (les lectures ne sont pas limitées)

Paramètres

Nom Où Type Contraintes
entityId requis chemin string (uuid) —
reportType requête string —
page requête integer défaut : 1
pageSize requête integer défaut : 20

Réponse 200 · application/json

Schéma ReportExportListResponse

Champ Type Contraintes
items requis ReportExportResponse[] —
pagination requis ReportPaginationMeta —

GET /api/v1/entities/{entityId}/reports/exports/{exportId}

Accès
Permission rapports : lecture (Reports.Read) , accordée par le rôle de l’utilisateur sur l’entité du chemin.
Limite de débit
aucune (les lectures ne sont pas limitées)

Paramètres

Nom Où Type Contraintes
entityId requis chemin string (uuid) —
exportId requis chemin string (uuid) —

Réponse 200 · application/json

Schéma ReportExportResponse

Champ Type Contraintes
id string (uuid) —
reportType string —
title string —
format string —
status string —
fileSize integer | null —
generatedByUserId string (uuid) —
generatedByName string | null —
scheduleId string (uuid) | null —
errorMessage string | null —
createdAt string (date-time) —
completedAt string (date-time) | null —
expiresAt string (date-time) —

DELETE /api/v1/entities/{entityId}/reports/exports/{exportId}

Accès
Permission rapports : lecture (Reports.Read) , accordée par le rôle de l’utilisateur sur l’entité du chemin.
Limite de débit
60 requêtes d’écriture par minute et par utilisateur (budget partagé entre tous les points d’accès concernés ; GET non comptés)

Paramètres

Nom Où Type Contraintes
entityId requis chemin string (uuid) —
exportId requis chemin string (uuid) —

Réponse 200

Réponse non décrite dans le document OpenAPI (le code de l’action ne déclare pas son type de retour).

GET /api/v1/entities/{entityId}/reports/exports/{exportId}/download

Accès
Permission rapports : lecture (Reports.Read) , accordée par le rôle de l’utilisateur sur l’entité du chemin.
Limite de débit
aucune (les lectures ne sont pas limitées)

Paramètres

Nom Où Type Contraintes
entityId requis chemin string (uuid) —
exportId requis chemin string (uuid) —

Réponse 200

Réponse non décrite dans le document OpenAPI (le code de l’action ne déclare pas son type de retour).

POST /api/v1/entities/{entityId}/reports/generate

Accès
Permission rapports : lecture (Reports.Read) , accordée par le rôle de l’utilisateur sur l’entité du chemin.
Limite de débit
60 requêtes d’écriture par minute et par utilisateur (budget partagé entre tous les points d’accès concernés ; GET non comptés)

Paramètres

Nom Où Type Contraintes
entityId requis chemin string (uuid) —

Corps de la requête application/json, requis

Schéma GenerateReportRequest

Champ Type Contraintes
reportType requis string —
format requis string —
title string | null —
parameters ReportParametersDto | null —
scheduleId string (uuid) | null —

Réponse 200 · application/json

Schéma ReportExportResponse

Champ Type Contraintes
id string (uuid) —
reportType string —
title string —
format string —
status string —
fileSize integer | null —
generatedByUserId string (uuid) —
generatedByName string | null —
scheduleId string (uuid) | null —
errorMessage string | null —
createdAt string (date-time) —
completedAt string (date-time) | null —
expiresAt string (date-time) —

GET /api/v1/entities/{entityId}/reports/metrics

Accès
Permission rapports : lecture (Reports.Read) , accordée par le rôle de l’utilisateur sur l’entité du chemin.
Limite de débit
aucune (les lectures ne sont pas limitées)

Paramètres

Nom Où Type Contraintes
entityId requis chemin string (uuid) —

Réponse 200 · application/json

Schéma ReportMetricsResponse

Champ Type Contraintes
totalExports requis integer —
exportsThisMonth requis integer —
activeSchedules requis integer —
availableReportTypes requis integer —

POST /api/v1/entities/{entityId}/reports/preview

Accès
Permission rapports : lecture (Reports.Read) , accordée par le rôle de l’utilisateur sur l’entité du chemin.
Limite de débit
60 requêtes d’écriture par minute et par utilisateur (budget partagé entre tous les points d’accès concernés ; GET non comptés)

Paramètres

Nom Où Type Contraintes
entityId requis chemin string (uuid) —

Corps de la requête application/json, requis

Schéma GenerateReportRequest

Champ Type Contraintes
reportType requis string —
format requis string —
title string | null —
parameters ReportParametersDto | null —
scheduleId string (uuid) | null —

Réponse 200 · application/json

Schéma ReportPreviewResponse

Champ Type Contraintes
reportType string —
title string —
generatedAt string (date-time) —
complianceData ComplianceReportData | null —
executiveData ExecutiveReportData | null —
riskData RiskReportData | null —
auditData AuditReportData | null —
gdprData GdprReportData | null —
gapAnalysisData GapAnalysisReportData | null —

GET /api/v1/entities/{entityId}/reports/schedules

Accès
Permission rapports : lecture (Reports.Read) , accordée par le rôle de l’utilisateur sur l’entité du chemin.
Limite de débit
aucune (les lectures ne sont pas limitées)

Paramètres

Nom Où Type Contraintes
entityId requis chemin string (uuid) —
page requête integer défaut : 1
pageSize requête integer défaut : 20

Réponse 200 · application/json

Schéma ReportScheduleListResponse

Champ Type Contraintes
items requis ReportScheduleResponse[] —
pagination requis ReportPaginationMeta —

POST /api/v1/entities/{entityId}/reports/schedules

Accès
Permission rapports : planification (Reports.Schedule) , accordée par le rôle de l’utilisateur sur l’entité du chemin.
Limite de débit
60 requêtes d’écriture par minute et par utilisateur (budget partagé entre tous les points d’accès concernés ; GET non comptés)

Paramètres

Nom Où Type Contraintes
entityId requis chemin string (uuid) —

Corps de la requête application/json, requis

Schéma CreateReportScheduleRequest

Champ Type Contraintes
reportType requis string —
format requis string —
title string | null —
frequency requis string —
dayOfGeneration integer ≥ 1 · ≤ 31
parameters ReportParametersDto | null —
recipients RecipientDto[] | null —
includeAiSynthesis boolean —

Réponse 200 · application/json

Schéma ReportScheduleResponse

Champ Type Contraintes
id string (uuid) —
reportType string —
title string —
format string —
frequency string —
dayOfGeneration integer —
includeAiSynthesis boolean —
isActive boolean —
lastGeneratedAt string (date-time) | null —
nextGenerationAt string (date-time) | null —
recipients RecipientDto[] | null —
createdByUserId string (uuid) —
createdByName string | null —
createdAt string (date-time) —
updatedAt string (date-time) —

GET /api/v1/entities/{entityId}/reports/schedules/{scheduleId}

Accès
Permission rapports : lecture (Reports.Read) , accordée par le rôle de l’utilisateur sur l’entité du chemin.
Limite de débit
aucune (les lectures ne sont pas limitées)

Paramètres

Nom Où Type Contraintes
entityId requis chemin string (uuid) —
scheduleId requis chemin string (uuid) —

Réponse 200 · application/json

Schéma ReportScheduleResponse

Champ Type Contraintes
id string (uuid) —
reportType string —
title string —
format string —
frequency string —
dayOfGeneration integer —
includeAiSynthesis boolean —
isActive boolean —
lastGeneratedAt string (date-time) | null —
nextGenerationAt string (date-time) | null —
recipients RecipientDto[] | null —
createdByUserId string (uuid) —
createdByName string | null —
createdAt string (date-time) —
updatedAt string (date-time) —

PUT /api/v1/entities/{entityId}/reports/schedules/{scheduleId}

Accès
Permission rapports : planification (Reports.Schedule) , accordée par le rôle de l’utilisateur sur l’entité du chemin.
Limite de débit
60 requêtes d’écriture par minute et par utilisateur (budget partagé entre tous les points d’accès concernés ; GET non comptés)

Paramètres

Nom Où Type Contraintes
entityId requis chemin string (uuid) —
scheduleId requis chemin string (uuid) —

Corps de la requête application/json, requis

Schéma UpdateReportScheduleRequest

Champ Type Contraintes
title string | null —
frequency string | null —
dayOfGeneration integer | null ≥ 1 · ≤ 31
parameters ReportParametersDto | null —
recipients RecipientDto[] | null —
includeAiSynthesis boolean | null —
isActive boolean | null —

Réponse 200 · application/json

Schéma ReportScheduleResponse

Champ Type Contraintes
id string (uuid) —
reportType string —
title string —
format string —
frequency string —
dayOfGeneration integer —
includeAiSynthesis boolean —
isActive boolean —
lastGeneratedAt string (date-time) | null —
nextGenerationAt string (date-time) | null —
recipients RecipientDto[] | null —
createdByUserId string (uuid) —
createdByName string | null —
createdAt string (date-time) —
updatedAt string (date-time) —

DELETE /api/v1/entities/{entityId}/reports/schedules/{scheduleId}

Accès
Permission rapports : planification (Reports.Schedule) , accordée par le rôle de l’utilisateur sur l’entité du chemin.
Limite de débit
60 requêtes d’écriture par minute et par utilisateur (budget partagé entre tous les points d’accès concernés ; GET non comptés)

Paramètres

Nom Où Type Contraintes
entityId requis chemin string (uuid) —
scheduleId requis chemin string (uuid) —

Réponse 200

Réponse non décrite dans le document OpenAPI (le code de l’action ne déclare pas son type de retour).

POST /api/v1/entities/{entityId}/reports/snapshots/generate

Accès
Permission rapports : planification (Reports.Schedule) , accordée par le rôle de l’utilisateur sur l’entité du chemin.
Limite de débit
60 requêtes d’écriture par minute et par utilisateur (budget partagé entre tous les points d’accès concernés ; GET non comptés)

Paramètres

Nom Où Type Contraintes
entityId requis chemin string (uuid) —

Réponse 200

Réponse non décrite dans le document OpenAPI (le code de l’action ne déclare pas son type de retour).

GET /api/v1/entities/{entityId}/reports/types

Accès
Permission rapports : lecture (Reports.Read) , accordée par le rôle de l’utilisateur sur l’entité du chemin.
Limite de débit
aucune (les lectures ne sont pas limitées)

Paramètres

Nom Où Type Contraintes
entityId requis chemin string (uuid) —

Réponse 200 · application/json

Type ReportTypeSummary[]

Schémas

Objets utilisés par les opérations de cette page. Les nombres sont écrits en JSON comme des nombres ; les énumérations, comme des chaînes.

DoraRoiValidationResponse

Champ Type Contraintes
completionPercentage integer —
isValid boolean —
exportAllowed boolean —
warnings DoraRoiValidationItem[] —
errors DoraRoiValidationItem[] —

DoraRoiValidationItem

Champ Type Contraintes
sheet string —
field string —
supplierId string (uuid) | null —
supplierName string | null —
message string —

ReportExportListResponse

Champ Type Contraintes
items requis ReportExportResponse[] —
pagination requis ReportPaginationMeta —

ReportExportResponse

Champ Type Contraintes
id string (uuid) —
reportType string —
title string —
format string —
status string —
fileSize integer | null —
generatedByUserId string (uuid) —
generatedByName string | null —
scheduleId string (uuid) | null —
errorMessage string | null —
createdAt string (date-time) —
completedAt string (date-time) | null —
expiresAt string (date-time) —

ReportPaginationMeta

Champ Type Contraintes
total requis integer —
page requis integer —
pageSize requis integer —

GenerateReportRequest

Champ Type Contraintes
reportType requis string —
format requis string —
title string | null —
parameters ReportParametersDto | null —
scheduleId string (uuid) | null —

ReportParametersDto

Champ Type Contraintes
framework string | null —
dateFrom string (date) | null —
dateTo string (date) | null —
comparisonDate string (date) | null —
includeControlDetails boolean —
includeActionPlan boolean —
includeRisks boolean —
includeEvidence boolean —
includeAuditLog boolean —
riskMethodology string | null —
riskStatusFilter string | null —
gdprContent string | null —
activeProcessingOnly boolean —
includeBreach boolean —
includeDsr boolean —
detailLevel string | null —

ReportMetricsResponse

Champ Type Contraintes
totalExports requis integer —
exportsThisMonth requis integer —
activeSchedules requis integer —
availableReportTypes requis integer —

ReportPreviewResponse

Champ Type Contraintes
reportType string —
title string —
generatedAt string (date-time) —
complianceData ComplianceReportData | null —
executiveData ExecutiveReportData | null —
riskData RiskReportData | null —
auditData AuditReportData | null —
gdprData GdprReportData | null —
gapAnalysisData GapAnalysisReportData | null —

ComplianceReportData

Champ Type Contraintes
entityInfo EntityInfoRow —
frameworkLabel string —
overallScore number —
previousScore number | null —
delta number | null —
comparisonFormulaChanged boolean —
comparisonFrameworkVersionChanged boolean —
domains ComplianceDomainRow[] —
controls ComplianceControlRow[] —
actionPlan ComplianceActionPlanRow[] —
linkedRisks ComplianceLinkedRiskRow[] —
scoreHistory ComplianceScoreHistoryPoint[] —
scoreHistoryFormulaChangedOn string (date) | null —
scoreHistoryFormulaNote string | null —
scoreHistoryFrameworkVersionNote string | null —

EntityInfoRow

Champ Type Contraintes
entityName requis string —
organizationName requis string —
sector requis string | null —
generatedAt requis string (date-time) —

ComplianceDomainRow

Champ Type Contraintes
domain requis string —
domainOrder requis integer —
total requis integer —
implemented requis integer —
inProgress requis integer —
notStarted requis integer —
notApplicable requis integer —
scorePercent requis number —

ComplianceControlRow

Champ Type Contraintes
code requis string —
title requis string —
domain requis string —
status requis string —
ownerName requis string | null —
dueDate requis string (date-time) | null —
implementationNote requis string | null —

ComplianceActionPlanRow

Champ Type Contraintes
controlCode requis string —
controlTitle requis string —
domain requis string —
status requis string —
ownerName requis string | null —
dueDate requis string (date-time) | null —

ComplianceLinkedRiskRow

Champ Type Contraintes
riskCode requis string —
riskTitle requis string —
inherentScore requis number | null —
residualScore requis number | null —
treatmentType requis string | null —
ownerName requis string | null —

ComplianceScoreHistoryPoint

Champ Type Contraintes
month requis string (date) —
score requis number —
controlsTotal requis integer —
controlsImplemented requis integer —
formulaVersion integer | null défaut : 2
frameworkVersion integer | null —

ExecutiveReportData

Champ Type Contraintes
entityInfo EntityInfoRow —
frameworkScores FrameworkScoreRow[] —
criticalRisks RiskReportRow[] —
riskSummary ExecutiveRiskSummary —
recentIncidents IncidentSummaryRow[] —
incidentSummary ExecutiveIncidentSummary —
overdueTasks OverdueTaskRow[] —
taskSummary ExecutiveTaskSummary —
upcomingDeadlines UpcomingDeadlineRow[] —
keyHighlights string[] —

FrameworkScoreRow

Champ Type Contraintes
frameworkType requis string —
label requis string —
score requis number —
controlsTotal requis integer —
controlsImplemented requis integer —
delta30d requis number | null —
trendStatus string défaut : "no-baseline"

RiskReportRow

Champ Type Contraintes
code requis string —
title requis string —
methodology requis string —
status requis string —
likelihood requis integer (int16) | null —
impact requis integer (int16) | null —
inherentScore requis number | null —
residualScore requis number | null —
treatmentType requis string | null —
ownerName requis string | null —
reviewDate requis string (date) | null —

ExecutiveRiskSummary

Champ Type Contraintes
totalRisks integer défaut : 0
openRisks integer défaut : 0
criticalCount integer défaut : 0
treatmentRate number défaut : 0

IncidentSummaryRow

Champ Type Contraintes
title requis string —
severity requis string —
status requis string —
detectedAt requis string (date-time) —
resolvedAt requis string (date-time) | null —

ExecutiveIncidentSummary

Champ Type Contraintes
totalPeriod integer défaut : 0
critical integer défaut : 0
high integer défaut : 0
resolved integer défaut : 0

OverdueTaskRow

Champ Type Contraintes
title requis string —
priority requis string —
dueDate requis string (date) —
assignedTo requis string | null —
daysOverdue requis integer —

ExecutiveTaskSummary

Champ Type Contraintes
total integer défaut : 0
inProgress integer défaut : 0
overdue integer défaut : 0
completedThisMonth integer défaut : 0

UpcomingDeadlineRow

Champ Type Contraintes
type requis string —
title requis string —
dueDate requis string (date) —
assignedTo requis string | null —

RiskReportData

Champ Type Contraintes
entityInfo EntityInfoRow —
totalRisks integer —
openRisks integer —
treatedRisks integer —
treatmentRate number —
summaryByCriticality RiskCriticalitySummary[] —
summaryByTreatment RiskTreatmentSummary[] —
matrixCells RiskMatrixCell[] —
risks RiskReportRow[] —
treatmentActions RiskTreatmentActionRow[] —

RiskCriticalitySummary

Champ Type Contraintes
label requis string —
count requis integer —

RiskTreatmentSummary

Champ Type Contraintes
treatmentType requis string —
count requis integer —

RiskMatrixCell

Champ Type Contraintes
likelihood requis integer —
impact requis integer —
count requis integer —
criticalityLabel requis string —

RiskTreatmentActionRow

Champ Type Contraintes
riskCode requis string —
action requis string —
status requis string —
ownerName requis string | null —
dueDate requis string (date) | null —
completedAt requis string (date-time) | null —

AuditReportData

Champ Type Contraintes
entityInfo EntityInfoRow —
dateFrom string (date) | null —
dateTo string (date) | null —
frameworksAudited string[] —
controlDetails AuditControlRow[] —
riskRegister RiskReportRow[] —
treatmentActions RiskTreatmentActionRow[] —
incidentLog AuditIncidentRow[] —
auditTrail AuditLogRow[] —
gdprCompliance GdprReportData | null —
taskCompletionLog AuditTaskRow[] —

AuditControlRow

Champ Type Contraintes
code requis string —
title requis string —
domain requis string —
framework requis string —
status requis string —
ownerName requis string | null —
dueDate requis string (date-time) | null —
implementationNote requis string | null —
lastModifiedAt requis string (date-time) | null —

AuditIncidentRow

Champ Type Contraintes
title requis string —
severity requis string —
status requis string —
detectedAt requis string (date-time) —
resolvedAt requis string (date-time) | null —
closedAt requis string (date-time) | null —
rootCause requis string | null —
regulatoryNotificationRequired requis boolean —
notificationsSent requis integer —

AuditLogRow

Champ Type Contraintes
action requis string —
resourceType requis string —
resourceId requis string (uuid) | null —
userName requis string | null —
timestamp requis string (date-time) —
diff requis string | null —

GdprReportData

Champ Type Contraintes
entityInfo EntityInfoRow —
processingActivities ProcessingActivityRow[] —
dpias DpiaRow[] —
dsrStats DsrStatsRow | null —
dataBreaches DataBreachRow[] —

ProcessingActivityRow

Champ Type Contraintes
name requis string —
purpose requis string —
legalBasis requis string —
status requis string —
referent requis string | null —
dataSubjects requis string —
dataCategories requis string —
hasSensitiveData requis boolean —
thirdCountryTransfers requis boolean —
retentionActivePeriod requis string | null —
dpiaRequired requis boolean —

DpiaRow

Champ Type Contraintes
title requis string —
processingActivityName requis string | null —
status requis string —
dpoDecision requis string | null —
nextReviewDate requis string (date) | null —
validatedAt requis string (date-time) | null —

DsrStatsRow

Champ Type Contraintes
total requis integer —
completed requis integer —
pending requis integer —
overdue requis integer —
avgDaysToComplete requis number —
byType requis map<string, integer> —

DataBreachRow

Champ Type Contraintes
title requis string —
detectedAt requis string (date-time) —
riskLevel requis string —
status requis string —
cnilNotificationRequired requis boolean —
cnilNotifiedAt requis string (date-time) | null —
personsNotificationRequired requis boolean —
personsNotifiedAt requis string (date-time) | null —

AuditTaskRow

Champ Type Contraintes
title requis string —
priority requis string —
status requis string —
assignedTo requis string | null —
dueDate requis string (date) | null —
completedAt requis string (date-time) | null —

GapAnalysisReportData

Champ Type Contraintes
entityInfo EntityInfoRow —
frameworkLabel string —
overallProgressPercent number —
domainSummaries GapDomainSummary[] —
questions GapQuestionRow[] —
remainingActions GapRemainingActionRow[] —

GapDomainSummary

Champ Type Contraintes
domain requis string —
totalQuestions requis integer —
gapsClosed requis integer —
progressPercent requis number —

GapQuestionRow

Champ Type Contraintes
questionId requis string —
domain requis string —
questionText requis string —
initialAnswer requis string —
currentControlStatus requis string | null —
gapClosed requis boolean —

GapRemainingActionRow

Champ Type Contraintes
questionId requis string —
domain requis string —
questionText requis string —
linkedControlCode requis string | null —
linkedControlTitle requis string | null —
currentControlStatus requis string —

ReportScheduleListResponse

Champ Type Contraintes
items requis ReportScheduleResponse[] —
pagination requis ReportPaginationMeta —

ReportScheduleResponse

Champ Type Contraintes
id string (uuid) —
reportType string —
title string —
format string —
frequency string —
dayOfGeneration integer —
includeAiSynthesis boolean —
isActive boolean —
lastGeneratedAt string (date-time) | null —
nextGenerationAt string (date-time) | null —
recipients RecipientDto[] | null —
createdByUserId string (uuid) —
createdByName string | null —
createdAt string (date-time) —
updatedAt string (date-time) —

RecipientDto

Champ Type Contraintes
userId string (uuid) | null —
email string | null —
name string | null —

CreateReportScheduleRequest

Champ Type Contraintes
reportType requis string —
format requis string —
title string | null —
frequency requis string —
dayOfGeneration integer ≥ 1 · ≤ 31
parameters ReportParametersDto | null —
recipients RecipientDto[] | null —
includeAiSynthesis boolean —

UpdateReportScheduleRequest

Champ Type Contraintes
title string | null —
frequency string | null —
dayOfGeneration integer | null ≥ 1 · ≤ 31
parameters ReportParametersDto | null —
recipients RecipientDto[] | null —
includeAiSynthesis boolean | null —
isActive boolean | null —

ReportTypeSummary

Champ Type Contraintes
reportType string —
label string —
description string —
availableFormats string[] —
availableFrameworks string[] —
isAvailable boolean —
unavailableReason string | null —

Mise à jour : 10 octobre 2026. Signaler une inexactitude