Contrôles
Contrôles d’une entité : liste, vue par domaine, détail et mise à jour du statut.
GET
/api/v1/entities/{entityId}/controls GET /api/v1/entities/{entityId}/controls/{id} PATCH /api/v1/entities/{entityId}/controls/{id} GET /api/v1/entities/{entityId}/controls/by-domain GET /api/v1/entities/{entityId}/controls
- Accès
-
Permission contrôles : lecture
(Controls.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) | — |
Status | requête | string | max. 100 caractères |
FrameworkType | requête | string | max. 100 caractères |
Domain | requête | string | max. 100 caractères |
OwnerUserId | requête | string (uuid) | — |
DueDateLte | requête | string (date-time) | — |
DueDateGte | requête | string (date-time) | — |
Q | requête | string | max. 200 caractères |
Limit | requête | integer | ≥ 1 · ≤ 100 |
Offset | requête | integer | ≥ 0 |
Réponse
200 · application/json
Schéma ControlListResponse
| Champ | Type | Contraintes |
|---|---|---|
data | ControlListItem[] | — |
totalCount | integer | — |
GET /api/v1/entities/{entityId}/controls/{id}
- Accès
-
Permission contrôles : lecture
(Controls.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) | — |
id requis | chemin | string (uuid) | — |
Réponse
200 · application/json
Schéma ControlDetailResponse
| Champ | Type | Contraintes |
|---|---|---|
id | string (uuid) | — |
controlDefinition | ControlDefinitionSummary | — |
status | string | — |
owner | OwnerSummary | null | — |
dueDate | string (date-time) | null | — |
implementationNote | string | null | — |
nonCompliantReason | string | null | — |
nonCompliantBy | string (uuid) | null | — |
nonCompliantAt | string (date-time) | null | — |
notApplicableReason | string | null | — |
notApplicableBy | string (uuid) | null | — |
notApplicableAt | string (date-time) | null | — |
evidenceCount | integer | — |
createdAt | string (date-time) | — |
updatedAt | string (date-time) | — |
PATCH /api/v1/entities/{entityId}/controls/{id}
- Accès
-
Permission contrôles : écriture
(Controls.Write), 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) | — |
id requis | chemin | string (uuid) | — |
Corps de la requête
application/json, requis
Schéma UpdateControlRequest
| Champ | Type | Contraintes |
|---|---|---|
status | string | null | max. 100 caractères |
ownerUserId | string (uuid) | null | — |
dueDate | string (date-time) | null | — |
implementationNote | string | null | max. 2000 caractères |
nonCompliantReason | string | null | max. 2000 caractères |
notApplicableReason | string | null | max. 2000 caractères |
Réponse
200 · application/json
Schéma ControlDetailResponse
| Champ | Type | Contraintes |
|---|---|---|
id | string (uuid) | — |
controlDefinition | ControlDefinitionSummary | — |
status | string | — |
owner | OwnerSummary | null | — |
dueDate | string (date-time) | null | — |
implementationNote | string | null | — |
nonCompliantReason | string | null | — |
nonCompliantBy | string (uuid) | null | — |
nonCompliantAt | string (date-time) | null | — |
notApplicableReason | string | null | — |
notApplicableBy | string (uuid) | null | — |
notApplicableAt | string (date-time) | null | — |
evidenceCount | integer | — |
createdAt | string (date-time) | — |
updatedAt | string (date-time) | — |
GET /api/v1/entities/{entityId}/controls/by-domain
- Accès
-
Permission contrôles : lecture
(Controls.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) | — |
Status | requête | string | max. 100 caractères |
FrameworkType | requête | string | max. 100 caractères |
Domain | requête | string | max. 100 caractères |
OwnerUserId | requête | string (uuid) | — |
DueDateLte | requête | string (date-time) | — |
DueDateGte | requête | string (date-time) | — |
Q | requête | string | max. 200 caractères |
Limit | requête | integer | ≥ 1 · ≤ 100 |
Offset | requête | integer | ≥ 0 |
Réponse
200 · application/json
Type ControlDomainGroup[]
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.
ControlListResponse
| Champ | Type | Contraintes |
|---|---|---|
data | ControlListItem[] | — |
totalCount | integer | — |
ControlListItem
| Champ | Type | Contraintes |
|---|---|---|
id | string (uuid) | — |
controlDefinition | ControlDefinitionSummary | — |
status | string | — |
owner | OwnerSummary | null | — |
dueDate | string (date-time) | null | — |
evidenceCount | integer | — |
createdAt | string (date-time) | — |
updatedAt | string (date-time) | — |
ControlDefinitionSummary
| Champ | Type | Contraintes |
|---|---|---|
id | string (uuid) | — |
code | string | — |
title | string | — |
description | string | — |
regulatoryReference | string | — |
domain | string | — |
domainOrder | integer | — |
subDomain | string | null | — |
criticality | string | — |
weight | integer (int16) | — |
isCustom | boolean | — |
frameworkId | string (uuid) | null | — |
frameworkCode | string | null | — |
frameworks | FrameworkMappingSummary[] | — |
orgInternalNote | string | null | — |
orgRegulatoryReferenceOverride | string | null | — |
FrameworkMappingSummary
| Champ | Type | Contraintes |
|---|---|---|
type | string | — |
code | string | — |
isPrimary | boolean | — |
OwnerSummary
| Champ | Type | Contraintes |
|---|---|---|
id | string (uuid) | — |
firstName | string | — |
lastName | string | — |
fullName | string | — |
ControlDetailResponse
| Champ | Type | Contraintes |
|---|---|---|
id | string (uuid) | — |
controlDefinition | ControlDefinitionSummary | — |
status | string | — |
owner | OwnerSummary | null | — |
dueDate | string (date-time) | null | — |
implementationNote | string | null | — |
nonCompliantReason | string | null | — |
nonCompliantBy | string (uuid) | null | — |
nonCompliantAt | string (date-time) | null | — |
notApplicableReason | string | null | — |
notApplicableBy | string (uuid) | null | — |
notApplicableAt | string (date-time) | null | — |
evidenceCount | integer | — |
createdAt | string (date-time) | — |
updatedAt | string (date-time) | — |
UpdateControlRequest
| Champ | Type | Contraintes |
|---|---|---|
status | string | null | max. 100 caractères |
ownerUserId | string (uuid) | null | — |
dueDate | string (date-time) | null | — |
implementationNote | string | null | max. 2000 caractères |
nonCompliantReason | string | null | max. 2000 caractères |
notApplicableReason | string | null | max. 2000 caractères |
ControlDomainGroup
| Champ | Type | Contraintes |
|---|---|---|
domain | string | — |
domainOrder | integer | — |
total | integer | — |
implemented | integer | — |
inProgress | integer | — |
notStarted | integer | — |
nonCompliant | integer | — |
notApplicable | integer | — |
progressPercent | number | — |
subDomains | ControlSubDomainGroup[] | — |
ControlSubDomainGroup
| Champ | Type | Contraintes |
|---|---|---|
subDomain | string | null | — |
total | integer | — |
implemented | integer | — |
inProgress | integer | — |
notStarted | integer | — |
nonCompliant | integer | — |
notApplicable | integer | — |
progressPercent | number | — |
controls | ControlListItem[] | — |
Mise à jour : 10 octobre 2026. Signaler une inexactitude