Aller au contenu

Archivage

Ces routes administrent les règles de conservation et les propriétés d'archivage des courriers. Elles exigent l'authentification REST.

Pour le processus complet, consultez le guide d'archivage.

Lister les règles de conservation

GET /rest/archival/retentionRules

Le privilège admin_architecture est obligatoire. La réponse 200 OK contient retentionRules, tableau de couples id et label.

{
  "retentionRules": [
    {
      "id": "DUA-10A",
      "label": "Conservation dix ans"
    }
  ]
}

Sans SAE configuré, la liste est vide. Pour Maarch RM, le contrôleur interroge le référentiel distant et une erreur technique ou une réponse non 200 du SAE produit 400 Bad Request.

Définir le caractère engageant

PUT /rest/archival/binding
Content-Type: application/json

Le privilège set_binding_document est obligatoire.

Propriété Type Obligatoire Description
resources array non vide oui Identifiants de courriers, seuls les 500 premiers sont traités
binding boolean ou null oui true engageant, false non engageant, null réinitialise
{
  "resources": [42, 43],
  "binding": true
}

Tous les courriers doivent appartenir au périmètre de l'utilisateur. Chaque modification est historisée. Le succès retourne 204 No Content.

Geler ou dégeler la règle de conservation

PUT /rest/archival/freezeRetentionRule
Content-Type: application/json

Le privilège freeze_retention_rule est obligatoire.

Propriété Type Obligatoire Description
resources array non vide oui Identifiants de courriers et seuls les 500 premiers sont traités
freeze boolean oui true gèle, false dégèle
{
  "resources": [42, 43],
  "freeze": true
}

Tous les courriers doivent appartenir au périmètre. Chaque modification est historisée. Le succès retourne 204 No Content.

Erreurs communes

Code Description
400 Bad Request Body invalide ou erreur du SAE pour la liste
403 Forbidden Privilège ou périmètre insuffisant