Créer et gérer les espaces

Conteneurs, chiffrement, activation et paramètres hérités par les futurs dépôts.

Un espace est un conteneur de documents appartenant à une organisation. Il peut représenter une famille documentaire, un usage ou un processus métier. La création et la gestion des espaces nécessitent CCFN_ADMIN.

Créer un espace

POST /api/ccfn/v1/space accepte les champs suivants :

ChampFormat et comportement
labelObligatoire ; chaîne de 255 caractères maximum
external_idRéférence facultative, unique pour les espaces de l’organisation ; 255 caractères maximum
is_encryptedBooléen ; false par défaut. Choisissez explicitement true pour un espace chiffré
lifecycle_durationDurée de rétention par défaut en jours, entier supérieur ou égal à 1 ; facultatif
signature_validation_policyPolitique partielle de validation des signatures ; facultative
{
  "label": "Contrats signés",
  "external_id": "CONTRATS",
  "is_encrypted": true,
  "lifecycle_duration": 3650,
  "signature_validation_policy": {
    "require_qualified": true,
    "require_qscd": true,
    "sign_type": "sign"
  }
}

L’espace est créé actif et reçoit un UUID. Une politique de signature définie sur l’espace ne déclenche pas à elle seule une validation : le dépôt doit aussi demander signature_validation="required".

Choisir l’espace lors d’un dépôt

SituationComportement si space_id est omis
Aucun espace actuellement configuréDépôt possible sans espace, donc sans chiffrement d’espace
Un seul espace actifSélection automatique de cet espace
Plusieurs espaces actifsRejet 422 ; transmettre le UUID voulu
Des espaces existent, mais aucun n’est actifRejet 422

Transmettre un space_id explicite est préférable pour une intégration stable, notamment si l’organisation crée plus tard un deuxième espace. Un espace inexistant, étranger à l’organisation ou désactivé entraîne un rejet.

Modifier ou désactiver

PATCH /api/ccfn/v1/space/{space} permet de modifier les paramètres acceptés, dont label, external_id, is_active, lifecycle_duration et la politique de signature. is_encrypted ne peut être envoyé qu’avec la valeur true pour activer le chiffrement ; l’API refuse sa désactivation.

{"is_active": false}

La désactivation bloque les nouveaux dépôts dans cet espace. Les utilisateurs autorisés peuvent continuer à consulter, contrôler ou détruire les objets déjà conservés, sous réserve des règles de rétention.

La modification de la durée ou de la politique d’un espace ne réécrit pas les décisions des dépôts existants. L’activation ultérieure du chiffrement concerne les nouveaux objets auxquels une clé est affectée ; elle ne constitue pas une migration automatique de tous les anciens documents. Vérifiez le champ encrypted de chaque objet.

Lister et supprimer

GET /space retourne une liste paginée ; GET /space/{space} retourne le détail. La liste accepte page, per_page, external_id et is_active. DELETE /space/{space} refuse un espace contenant encore des objets (409). Un espace vide peut être supprimé.

À lire ensuite : Déposer un document, Rétention.


Did this page help you?