Référentiels personnalisés : contrôles
Contrôles d’une version brouillon d’un référentiel personnalisé.
GET
/api/v1/frameworks/custom/{frameworkCode}/versions/{versionId}/control-definitions POST /api/v1/frameworks/custom/{frameworkCode}/versions/{versionId}/control-definitions GET /api/v1/frameworks/custom/{frameworkCode}/versions/{versionId}/control-definitions/{controlDefinitionId} PATCH /api/v1/frameworks/custom/{frameworkCode}/versions/{versionId}/control-definitions/{controlDefinitionId} DELETE /api/v1/frameworks/custom/{frameworkCode}/versions/{versionId}/control-definitions/{controlDefinitionId} GET /api/v1/frameworks/custom/{frameworkCode}/versions/{versionId}/control-definitions
- Accès
-
Permission référentiels : lecture
(Frameworks.Read), accordée par un rôle sur au moins une entité de l’organisation. - Limite de débit
- aucune
Paramètres
| Nom | Où | Type | Contraintes |
|---|---|---|---|
frameworkCode requis | chemin | string | — |
versionId requis | chemin | string (uuid) | — |
Réponse
200 · application/json
POST /api/v1/frameworks/custom/{frameworkCode}/versions/{versionId}/control-definitions
- Accès
-
Permissions référentiels : lecture
(Frameworks.Read)et référentiels : écriture(Frameworks.Write), accordée par un rôle sur au moins une entité de l’organisation. - 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 |
|---|---|---|---|
frameworkCode requis | chemin | string | — |
versionId requis | chemin | string (uuid) | — |
Corps de la requête
application/json, requis
Schéma CreateControlDefinitionRequest
| Champ | Type | Contraintes |
|---|---|---|
code requis | string | motif : ^[A-Z][A-Z0-9-]{1,49}$ |
title requis | string | min. 1 caractères · max. 300 caractères |
description requis | string | min. 1 caractères · max. 4000 caractères |
regulatoryReference | string | min. 0 caractères · max. 500 caractères |
domain requis | string | min. 1 caractères · max. 200 caractères |
domainOrder | integer | ≥ 0 · ≤ 1000 |
subDomain | string | null | min. 0 caractères · max. 200 caractères |
criticality requis | Criticality | — |
weight | integer (int16) | null | ≥ 1 · ≤ 10 |
Réponse
200 · application/json
Schéma PlatformControlDefinitionDetail
| Champ | Type | Contraintes |
|---|---|---|
id requis | string (uuid) | — |
frameworkVersionId requis | string (uuid) | — |
code requis | string | — |
title requis | string | — |
description requis | string | — |
regulatoryReference requis | string | — |
domain requis | string | — |
domainOrder requis | integer | — |
subDomain requis | string | null | — |
criticality requis | string | — |
weight requis | integer (int16) | — |
createdAt requis | string (date-time) | — |
GET /api/v1/frameworks/custom/{frameworkCode}/versions/{versionId}/control-definitions/{controlDefinitionId}
- Accès
-
Permission référentiels : lecture
(Frameworks.Read), accordée par un rôle sur au moins une entité de l’organisation. - Limite de débit
- aucune
Paramètres
| Nom | Où | Type | Contraintes |
|---|---|---|---|
frameworkCode requis | chemin | string | — |
versionId requis | chemin | string (uuid) | — |
controlDefinitionId requis | chemin | string (uuid) | — |
Réponse
200 · application/json
Schéma PlatformControlDefinitionDetail
| Champ | Type | Contraintes |
|---|---|---|
id requis | string (uuid) | — |
frameworkVersionId requis | string (uuid) | — |
code requis | string | — |
title requis | string | — |
description requis | string | — |
regulatoryReference requis | string | — |
domain requis | string | — |
domainOrder requis | integer | — |
subDomain requis | string | null | — |
criticality requis | string | — |
weight requis | integer (int16) | — |
createdAt requis | string (date-time) | — |
PATCH /api/v1/frameworks/custom/{frameworkCode}/versions/{versionId}/control-definitions/{controlDefinitionId}
- Accès
-
Permissions référentiels : lecture
(Frameworks.Read)et référentiels : écriture(Frameworks.Write), accordée par un rôle sur au moins une entité de l’organisation. - 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 |
|---|---|---|---|
frameworkCode requis | chemin | string | — |
versionId requis | chemin | string (uuid) | — |
controlDefinitionId requis | chemin | string (uuid) | — |
Corps de la requête
application/json, requis
Schéma UpdateControlDefinitionRequest
| Champ | Type | Contraintes |
|---|---|---|
title | string | null | min. 1 caractères · max. 300 caractères |
description | string | null | min. 1 caractères · max. 4000 caractères |
regulatoryReference | string | null | min. 0 caractères · max. 500 caractères |
domain | string | null | min. 1 caractères · max. 200 caractères |
domainOrder | integer | null | ≥ 0 · ≤ 1000 |
subDomain | string | null | min. 0 caractères · max. 200 caractères |
criticality | Criticality | null | — |
weight | integer (int16) | null | ≥ 1 · ≤ 10 |
Réponse
200 · application/json
Schéma PlatformControlDefinitionDetail
| Champ | Type | Contraintes |
|---|---|---|
id requis | string (uuid) | — |
frameworkVersionId requis | string (uuid) | — |
code requis | string | — |
title requis | string | — |
description requis | string | — |
regulatoryReference requis | string | — |
domain requis | string | — |
domainOrder requis | integer | — |
subDomain requis | string | null | — |
criticality requis | string | — |
weight requis | integer (int16) | — |
createdAt requis | string (date-time) | — |
DELETE /api/v1/frameworks/custom/{frameworkCode}/versions/{versionId}/control-definitions/{controlDefinitionId}
- Accès
-
Permissions référentiels : lecture
(Frameworks.Read)et référentiels : écriture(Frameworks.Write), accordée par un rôle sur au moins une entité de l’organisation. - 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 |
|---|---|---|---|
frameworkCode requis | chemin | string | — |
versionId requis | chemin | string (uuid) | — |
controlDefinitionId 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).
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.
PlatformControlDefinitionDetail
| Champ | Type | Contraintes |
|---|---|---|
id requis | string (uuid) | — |
frameworkVersionId requis | string (uuid) | — |
code requis | string | — |
title requis | string | — |
description requis | string | — |
regulatoryReference requis | string | — |
domain requis | string | — |
domainOrder requis | integer | — |
subDomain requis | string | null | — |
criticality requis | string | — |
weight requis | integer (int16) | — |
createdAt requis | string (date-time) | — |
CreateControlDefinitionRequest
| Champ | Type | Contraintes |
|---|---|---|
code requis | string | motif : ^[A-Z][A-Z0-9-]{1,49}$ |
title requis | string | min. 1 caractères · max. 300 caractères |
description requis | string | min. 1 caractères · max. 4000 caractères |
regulatoryReference | string | min. 0 caractères · max. 500 caractères |
domain requis | string | min. 1 caractères · max. 200 caractères |
domainOrder | integer | ≥ 0 · ≤ 1000 |
subDomain | string | null | min. 0 caractères · max. 200 caractères |
criticality requis | Criticality | — |
weight | integer (int16) | null | ≥ 1 · ≤ 10 |
Criticality
Énumération (chaîne) : Critical, Important, Standard
UpdateControlDefinitionRequest
| Champ | Type | Contraintes |
|---|---|---|
title | string | null | min. 1 caractères · max. 300 caractères |
description | string | null | min. 1 caractères · max. 4000 caractères |
regulatoryReference | string | null | min. 0 caractères · max. 500 caractères |
domain | string | null | min. 1 caractères · max. 200 caractères |
domainOrder | integer | null | ≥ 0 · ≤ 1000 |
subDomain | string | null | min. 0 caractères · max. 200 caractères |
criticality | Criticality | null | — |
weight | integer (int16) | null | ≥ 1 · ≤ 10 |
Mise à jour : 10 octobre 2026. Signaler une inexactitude