Entités
Arborescence des entités (siège, filiales…), activation des référentiels par entité, archivage.
/api/v1/entities POST /api/v1/entities GET /api/v1/entities/{entityId} PATCH /api/v1/entities/{entityId} POST /api/v1/entities/{entityId}/archive POST /api/v1/entities/{entityId}/frameworks DELETE /api/v1/entities/{entityId}/frameworks/{frameworkType} GET /api/v1/entities/{entityId}/members GET /api/v1/entities
- Accès
-
Permission entités : lecture
(Entity.Read), accordée par un rôle sur au moins une entité de l’organisation. - Limite de débit
- aucune (les lectures ne sont pas limitées)
Paramètres
| Nom | Où | Type | Contraintes |
|---|---|---|---|
status | requête | string | — |
search | requête | string | — |
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
- Accès
-
Permission entités : création
(Entity.Create), 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)
Corps de la requête
application/json, requis
Schéma CreateEntityRequest
| Champ | Type | Contraintes |
|---|---|---|
name requis | string | — |
type requis | string | — |
country requis | string | — |
sector | string | null | — |
parentEntityId | string (uuid) | null | — |
headcount | integer | null | — |
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}
- Accès
-
Permission entités : lecture
(Entity.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
Réponse non décrite dans le document OpenAPI (le code de l’action ne déclare pas son type de retour).
PATCH /api/v1/entities/{entityId}
- Accès
-
Permission entités : modification
(Entity.Update), 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 UpdateEntityRequest
| Champ | Type | Contraintes |
|---|---|---|
name | string | null | — |
type | string | null | — |
country | string | null | — |
sector | string | null | — |
parentEntityId | string (uuid) | null | — |
headcount | integer | null | — |
nis2Classification | string | null | — |
doraType | string | null | — |
nis2Sector | string | null | — |
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}/archive
- Accès
-
Permission entités : archivage
(Entity.Archive), 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).
POST /api/v1/entities/{entityId}/frameworks
- Accès
-
Permission entités : modification
(Entity.Update), 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 ActivateFrameworkRequest
| Champ | Type | Contraintes |
|---|---|---|
frameworkType requis | string | — |
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).
DELETE /api/v1/entities/{entityId}/frameworks/{frameworkType}
- Accès
-
Permission entités : modification
(Entity.Update), 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) | — |
frameworkType requis | chemin | string | — |
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}/members
- Accès
-
Permission utilisateurs : lecture
(Users.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
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.
CreateEntityRequest
| Champ | Type | Contraintes |
|---|---|---|
name requis | string | — |
type requis | string | — |
country requis | string | — |
sector | string | null | — |
parentEntityId | string (uuid) | null | — |
headcount | integer | null | — |
UpdateEntityRequest
| Champ | Type | Contraintes |
|---|---|---|
name | string | null | — |
type | string | null | — |
country | string | null | — |
sector | string | null | — |
parentEntityId | string (uuid) | null | — |
headcount | integer | null | — |
nis2Classification | string | null | — |
doraType | string | null | — |
nis2Sector | string | null | — |
ActivateFrameworkRequest
| Champ | Type | Contraintes |
|---|---|---|
frameworkType requis | string | — |
Mise à jour : 10 octobre 2026. Signaler une inexactitude