API-Vitam - Access API documentation version v1

https://api.vitam.gouv.fr/access-external/{version}

  • version: required (v1)

Avertissements

Cette version d'API présente des fonctionnalités sous différents statuts :

  • Supportées : rien n'est spécifié, la fonctionnalité ou la donnée est supportée

Pour le détail du modèle de chaque collection, se référer à la documentation du modèle de données.

Licence

Ce document est distribué sous les termes de la Licence Ouverte V2.0

API Access

L'API d'Accès propose les points d'entrées et les méthodes pour atteindre, requêter et récupérer les informations depuis les Units et les Objects.

Cette API est globalement reproduite dans tous les autres points d'accès lorsque l'accès à des Units et Objects est nécessaire. Les fonctionnalités offertes peuvent par contre varier (droit en modification, effacement, ...) selon le contexte.

API Access externe

Dans le projet Vitam, Les API externes supportent le POST-X-HTTP-OVERRIDE=GET. Les API internes ne supportent que le GET.

Units

Units est le point d'entrée pour toutes les descriptions d'archives. Celles-ci contiennent les métadonnées de description et les métadonnées archivistiques (métadonnées de gestion).

Une Unit peut être de 3 types :

  • "ingest" (unité archivistique classique),
  • "holding" (unité archivistique d'arbre de positionnement)

  • "filing" (unité archivistique de plan de classement). Les métadonnées de ces unités peuvent tout aussi bien décrire un dossier qu'un groupe d'objet lié. Les Units peuvent être organisées en arborescence et peuvent posséder :

    • Plusieurs racines dans l'arborescence (Unit de plus haut niveau)
    • Plusieurs parents directs (un dossier peut être rattaché à plusieurs dossiers)

    Il s'agit d'une représentation dite de "graphe dirigé sans cycle" (DAG en Anglais pour "Directed Acyclic Graph").

Pour le model SEDA, il est équivalent à l'ArchiveUnit, notamment pour les parties Content et Management. Pour l'Isad(G) / EAD, il est équivalent à Description Unit.

Au plus, un seul groupe d'objets d'archives (Objects) est attaché à une Unit. Cela signifie que si une Unit doit avoir plus d'un groupe d'objets d'archive attaché, vous devez spécifier des sous-Units à l'Unit principale, chaque sous-Unit n'ayant qu'un groupe d'objets d'archives attaché. Un même groupe d'objets d'archives peut par contre être attaché à de multiples Units.

Aucun effacement n'est autorisé, ni aucune mise à jour complète (seules les mises à jours partielles sont autorisées via la commande PUT). Les mises à jour ne sont autorisées que par Unit, il n'y a pas de mise à jour en masse.

Structuration des métadonnées

La structuration d'un Unit est la suivante :

  {
    "#id": "UnitId",
    "#tenant": "tenantId",
    "#version": 1,
    "#unitType" : "HOLDING_UNIT (arbre), FILING_UNIT (Plan) ou INGEST (ArchiveUnit standard)"
    //Métadonnées du content
    "DescriptionLevel": "Fonds",
    "Title": "titre",
    "Description": "description du Unit",
    "#Management": {
      "StorageRule": {},
      "AppraisalRule": {},
      "AccessRule": {},
      "DisseminationRule": {},
      "ReuseRule": {},
      "ClassificationRule": {},
      "NeedAuthorization": false // Accès nécessitant une autorisation explicite
    },
    "#unitups": [ "unitParentId", "unitParentId"], // liste des parents immédiats
    "#min": 1,
    "#max": 1,
    "#object": "objectId",
    "#nbunits": 1, // Nombre de Unit fils
    "#operations" : [ "id", "id" ], // liste des opérations auxquelles cette AU a participées
    "#allunitsups": [ "unitParentId", "unitParentId"], // liste de tous les parents jusqu'au sommet
    "#storage": { "#nbc": 2  } // information de stockage,
    "#originating_agency": "originationAgencyId",
    "#originating_agencies": [ "originationAgencyId" ],
    "#operations" : [ "operationId" ] // liste des opérations auxquelles cette AU a participées

Objects

/units/{idu}/objects est le point d'entrée pour :

  • tous les groupes objets, qui contiennent les métadonnées techniques (nom des objets, format, type MIME...)
  • tous les objets binaires (des fichiers) non binaires (des références à des objets d'archives physiques ou externes au système).

Un Groupe d'Objects peut posséder de 1 à N objets. Chaque objet a un usage et une version dans son groupe d'objet. Ces distinctions permettent de différencier des usages comme version de conservation, version de diffusion...

Il peut exister plusieurs versions de l'objet pour un même usage (pour l'original numérique notamment), au fur et à mesure du cycle de vie du Groupe d'Objects. Par exemple l'objet d'usage+version "BinaryMaster_1" est la version 1 de l'usage BinaryMaster, le "BinaryMaster_2" est la version 2 de l'usage BinaryMaster. Dans le modèle de données de la solution logicielle Vitam, cet usage correspond au champ "qualifier".

Pour le model SEDA, il est équivalent à un DataObjectGroup. Pour l'EAD, il est équivalent à un Digital Archive Object Group or Set.

Chaque Groupe d'Objets doit être attaché à au moins un parent Unit.

Seul l'accès est autorisé (GET/POST en override de GET).

Chaque Objet n'est lié qu'à un seul Groupe d'objets. Chaque Objet a un qualifier (spécifiable via #qualifiers dans le DSL pour l'accès métadonnées et X-Qualifier en Header pour l'accès aux objets binaires) :

  • PhysicalMaster : il s'agit de l'original papier ou physique s'il existe
  • BinaryMaster : il s'agit de l'original numérique s'il existe
  • Dissemination : il s'agit d'une version adaptée à la diffusion via le réseau et l'usage dans des navigateurs
  • Thumbnail : il s'agit d'une version adaptée à la diffusion dans une taille et une qualité correspondant à une vignette (utile lors de l'affichage d'une liste)
  • TextContent : il s'agit d'une version ne contenant que le texte du document, sans la mise en forme (son usage est en prévision du futur, par exemple pour des opérations d'analyses sémantiques)

Ces qualifiers peuvent être utilisés dans une requête GET en conjonction avec le Header Accept: application/octet-stream pour accéder en lecture à un usage particulier.

Structuration des métadonnées

A noter: la structuration va changer dans la prochaine release

La structuration d'un Object est la suivante :

  {
    "#id": "ObjectId",
    "#tenant": "tenantId",
    //Métadonnées de l'Object
    "FileInfo": {
      "Filename": "filename",
      "LastModified": "date",
      "GPS": {}
    },
    "#qualifiers": [{
      "qualifier": "PhysicalMaster",
      "#nbc": 1,
      "versions": [
        {
          "#id": "abcdef",
          "DataObjectGroupId": "abcdef",
          "DataObjectVersion": "PhysicalMaster_1",
          "PhysicalDimensions": {},
          "PhysicalId": {},
          "xxx": "" // autres informations
        }
      ]},
      {
      "qualifier": "BinaryMaster",  // Version numérique
      "#nbc": 1, // nombre de versions
      "versions": [
        {
          "#id": "abcdef",
          "#storage" : {// informations sur le stockage de l'objet}
          "DataObjectGroupId": "abcdef",
          "DataObjectVersion": "BinaryMaster_1",
          "MessageDigest": "algorithme digest", // empreinte et algorithme d'empreinte de l'objet
          "Algorithm": "SHA-512",
          "FileInfo": {// informations du fichier},
          "Size": 10, // taille de l'objet
          "Uri": "Content/uri", // uri de l'objet
          "FormatIdentification": {
            "FormatLitteral": "format Literral",
            "MimeType": "mimetype",
            "FormatId": "pronomId"
          },
          "OtherMetadata": {
            // autres métadonnées non classées
          }
        }
      ]
      },
      {
        "qualifier": "Dissemination",  // Version de diffusion
        "#nbc": 1, // nombre de versions
        "versions": [
          {//idem à BinaryMaster}
        ]
      },
      {
        "qualifier": "TextContent",  // Contenu brut
        "#nbc": 1, // nombre de versions
        "versions": [
          {//idem à BinaryMaster}
        ]
      },
      {
        "qualifier": "Thumbnail",  // Vignette
        "#nbc": 1, // nombre de versions
        "versions": [
          {//idem à BinaryMaster}
        ]
      }
    ],
    "#unitups": [ "unitParentId", "unitParentId"],
    "#nbobjects": 1, // Nombre de versions d'objets contenus pour tous les usages
    "#storage": { "#nbc": 2  }, // information de stockage,
    "#originating_agency": "originationAgencyId",
    "#originating_agencies": [ "originationAgencyId" ],
    "#operations" : [ "operationId" ] // liste des opérations auxquelles ce groupe d'objets a participées
  }

Note : A l'avenir, à l'intérieur d'une version d'usage, et pour chaque version (pour les BinaryMaster notamment), un contexte sera ajouté à la structure de l'Object afin de pouvoir y introduire des données de contexte (version du référentiel Pronom par exemple...).

DIPEXPORT

/dipexport est le point d'entrée permettant l'export sous forme de DIP (paquet d'information diffusé ou Dissemination Information Package en anglais) d'une sélection d'unités archivistiques.

Important : Deux actions sont disponibles. La première permet de lancer un processus de génération d'un DIP. La deuxième permet de télécharger le fichier généré par le processus précédent, une fois terminé.

Champs d'application sur les Units

Les principes sont les suivants :

  • Pas de POST (sauf X-Http-Method-Override: GET) car ceci relève de l'entrée
  • Le PUT est utilisé pour réaliser un update partiel
  • Pas de DELETE car ceci relève de l'élimination
  • GET correspond à la recherche ou l'accès selon la présence d'un body ou non
  • Un seul Object par Unit max
  • Une requête depuis un Unit signifie recherche relative depuis celui-ci (roots = this)
  • Accept: application/json signifie les métadonnées au format Json
  • Accept: application/octet-stream signifie le retour du contenu binaire de l'Object

Champs d'application sur les Objects

Les principes sont les suivants :

  • Object signifie ObjectGroup en masquant la complexité ObjectGroup/Object
  • Pas de POST (sauf X-Http-Method-Override: GET) car ceci relève de l'entrée
  • Pas de DELETE car ceci relève de l'élimination
  • GET correspond à la recherche ou l'accès selon la présence d'un body ou non
  • Une requête depuis un object signifie recherche relative depuis celui-ci (roots = this)
  • Accept: application/json signifie les métadonnées au format Json
  • Accept: application/octet-stream signifie le retour du contenu binaire de l'Object

ArchiveUnits

API qui définit les requêtes pour accéder aux Unités d'archives. La requête utilise le langage de requête DSL de Vitam en entrée et retourne une liste d'Unités d'archives selon le DSL Vitam en cas de succès.

get post

get

Requête qui retourne des résultats contenant des Unités d'archives. La requête utilise le langage de requête DSL de type recherche multiple (SELECT MULTIPLE) de Vitam en entrée et retourne une liste d'Unités d'archives selon le DSL Vitam en cas de succès.

Permissions requises:

  • units:read
post

Requête qui retourne des résultats contenant des Unités d'archives. La requête utilise POST avec X-Http-Method-Override: GET La requête utilise le langage de requête DSL de type recherche multiple (SELECT MULTIPLE) de Vitam en entrée et retourne une liste d'Unités d'archives selon le DSL Vitam en cas de succès. Sans le Header, le point d'API est utilisé pour mettre à jour en masse les métadonnées descriptives des unités archivistiques. Possibilité de remplacer une chaîne de caractères par une autre vià l'opération $setregex.

Permissions requises:

  • units:update

Requête qui retourne des résultats contenant des Unités d'archives. La requête utilise POST avec X-Http-Method-Override: GET La requête utilise le langage de requête DSL de type recherche multiple (SELECT MULTIPLE) de Vitam en entrée et retourne une liste d'Unités d'archives selon le DSL Vitam en cas de succès. Sans le Header, le point d'API est utilisé pour mettre à jour en masse les métadonnées descriptives des unités archivistiques. Possibilité de remplacer une chaîne de caractères par une autre vià l'opération $setregex.

Permissions requises:

  • units:update

Headers

  • X-Http-Method-Override: required (GET)
  • X-Access-Contract-Id: required (string)

    Unique Access Contract Identifier. Allow read/write access on specific archive unit.

    Example:

    Access-Contract-00001
  • X-Application-Id: (string)

    Session Identifier from client Front-Office Application

    Example:

    SESSION-ID-00001
  • X-Tenant-Id: required (number)

    Unique Tenant Identifier.

    Example:

    0
  • X-Personal-Certificate: (string)

    Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

    Example:

    MIIGfzCCBGegAwIBAgICAPcwDQYJK...
  • Accept: required (one of application/json, application/zip, application/octet-stream)

    Allow to specify if a result must contain only Metadata ('application/json') or only the Objects with a binary content ('application/octet-stream').

Body

Media type: application/json

Type: DslTypes.DslMultipleQuery

Examples:

UnitsBatchUpdate:

{
  "$roots": [],
  "$query": [ { "$eq": { "#id": "{{guid}}" } }
  ],
  "$action": [
    {
      "$setregex": {
        "$target": "Title",
        "$controlPattern": "Dessert placé",
        "$updatePattern": "Dessert glacé"
      }
    }
  ]
}

BatchUpdateObject:

{
  "$roots": [],
  "$query": [
    {
      "$in": {
        "#id": [
          "MY-AU-GUID"
        ]
      }
    }
  ],
  "$threshold": 10000,
  "$action": [
    {
      "$set": {
        "Gps": {
          "GpsLatitude": "lat is here",
          "GpsLongitude": "long is here"
        }
      }
    }
  ]
}

BatchRemove:

{
  "$roots": [],
  "$query": [
    {
      "$in": {
        "#id": [
          "MY-AU-GUID"
        ]
      }
    }
  ],
  "$threshold": 10000,
  "$action": [
    {
      "$unset": [
        "Description"
      ]
    }
  ]
}
{
  "$roots": [ "id0" ],
  "$query": [
    { "$match": { "title": "titre" }, "$depth": 4 }
  ],
  "$filter": { "$limit": 1000, "$offset": 10 },
  "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#sector": 1, "#parents": 1, "#object": 1 } }
}

HTTP status code 200

Renvoie la liste des résultats d'Unités d'archives correspondant à la requête DSL

Headers

  • X-Request-Id: required (string)

    Unique Request Identifier

    Example:

    AbDUh67jj
  • FullApiVersion: (string)

    Complete Version of the API.

    Example:

    V1.25
  • X-Application-Id: (string)

    Session Identifier from client Front-Office Application

    Example:

    SESSION-ID-00001
  • X-Tenant-Id: required (number)

    Unique Tenant Identifier

    Example:

    0

Body

Media type: application/json

Type: DslTypes.DslMultipeResponse

Example:

{
  "httpCode": 200,
  "$hits": {
    "total": 13,
    "size": 3,
    "offset": 10,
    "limit": 1000
  },
  "$context": {
    "$roots": [ "id0" ],
    "$query": [
      { "$match": { "title": "titre" }, "$depth": 4 }
    ],
    "$filter": { "$limit": 1000, "$offset": 10 },
    "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#sector": 1, "#parents": 1, "#object": 1 } }
  },
  "$results": [
    {
      "#id": "id1", "title": "titre 1", "#type": "DemandeCongés",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés" } ],
      "#object": { "#id": "id101", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id2", "title": "titre 2", "#type": "DemandeCongés",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés" } ],
      "#object": { "#id": "id102", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id3", "title": "titre 3", "#type": "DemandeCongés",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés" } ],
      "#object": { "#id": "id103", "#type": "Image",
        "#qualifiers": { "BinaryMaster": 3, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    }
  ]
}

HTTP status code 202

Renvoie le statut de l'opération de mise à jour

Body

Media type: application/json

Type: object

HTTP status code 400

Bad Request, syntax might be erroneous

Headers

  • X-Request-Id: required (string)

    Unique Request Identifier

    Example:

    AbDUh67jj
  • FullApiVersion: (string)

    Complete Version of the API.

    Example:

    V1.25
  • X-Application-Id: (string)

    Session Identifier from client Front-Office Application

    Example:

    SESSION-ID-00001
  • X-Tenant-Id: required (number)

    Unique Tenant Identifier

    Example:

    0

HTTP status code 401

Unauthorized (restricted operation), authentication in error

Headers

  • X-Request-Id: required (string)

    Unique Request Identifier

    Example:

    AbDUh67jj
  • FullApiVersion: (string)

    Complete Version of the API.

    Example:

    V1.25
  • X-Application-Id: (string)

    Session Identifier from client Front-Office Application

    Example:

    SESSION-ID-00001
  • X-Tenant-Id: required (number)

    Unique Tenant Identifier

    Example:

    0

HTTP status code 403

Forbidden, requested action is forbidden

Headers

  • X-Request-Id: required (string)

    Unique Request Identifier

    Example:

    AbDUh67jj
  • FullApiVersion: (string)

    Complete Version of the API.

    Example:

    V1.25
  • X-Application-Id: (string)

    Session Identifier from client Front-Office Application

    Example:

    SESSION-ID-00001
  • X-Tenant-Id: required (number)

    Unique Tenant Identifier

    Example:

    0

HTTP status code 404

Not Found, requested resource does not exist

Headers

  • X-Request-Id: required (string)

    Unique Request Identifier

    Example:

    AbDUh67jj
  • FullApiVersion: (string)

    Complete Version of the API.

    Example:

    V1.25
  • X-Application-Id: (string)

    Session Identifier from client Front-Office Application

    Example:

    SESSION-ID-00001
  • X-Tenant-Id: required (number)

    Unique Tenant Identifier

    Example:

    0

HTTP status code 412

Precondition Failed, some predicates are incorrect, therefore the operation is not possible

Headers

  • X-Request-Id: required (string)

    Unique Request Identifier

    Example:

    AbDUh67jj
  • FullApiVersion: (string)

    Complete Version of the API.

    Example:

    V1.25
  • X-Application-Id: (string)

    Session Identifier from client Front-Office Application

    Example:

    SESSION-ID-00001
  • X-Tenant-Id: required (number)

    Unique Tenant Identifier

    Example:

    0

HTTP status code 500

Renvoie le statut final de l'opération en KO

Body

Media type: application/json

Type: object

post

post

Requête qui déclanche la mise à jour de masse des métadonnées de gestion d'unités d'archives. La requête utilise un POJO spécifique pour effectuer la mise à jour des éléments de gestion.

Permissions requises:

  • units:rules:update

Requête qui déclanche la mise à jour de masse des métadonnées de gestion d'unités d'archives. La requête utilise un POJO spécifique pour effectuer la mise à jour des éléments de gestion.

Permissions requises:

  • units:rules:update

Headers

  • X-Application-Id: (string)

    Session Identifier from client Front-Office Application

    Example:

    SESSION-ID-00001
  • X-Tenant-Id: required (number)

    Unique Tenant Identifier.

    Example:

    0
  • X-Access-Contract-Id: required (string)

    Unique Access Contract Identifier. Allow read/write access on specific archive unit.

    Example:

    Access-Contract-00001
  • X-Personal-Certificate: (string)

    Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

    Example:

    MIIGfzCCBGegAwIBAgICAPcwDQYJK...

Body

Media type: application/json

Type: object

Properties
  • dslRequest: required (object)

    Contient la requête de recherche

    • ruleActions: required (object)

      Contient le POJO de mise à jour des métadonnées de gestion (Voir exemple).

      Il est possible d'ajouter (add), mettre à jour (update) ou supprimer (delete) des catégories de règles de gestion (règles et propriétés), ainsi que de mettre à jour les métadonnées de gestion hors catégories de règles (addOrUpdateMetadata/deleteMetadata).

      Pour les catégories de règles de gestion, voici les champs autorisés à la racine des catégories (règles et propriétés):

      ChampCatégorie spécifiqueCommentaire
      RulesToutesPermet de définir les modifications sur les règles de gestion de l'unité archivistique
      PreventInheritanceToutesPermet de définir si la catégorie hérite (false) ou non (true) des règles de l'unité archivistique parente
      PreventRulesIdToutesPermet de définir une liste de règles qui ne seront pas hérités de l'unité archivistique parente
      FinalActionStorageRule, AppraisalRulePermet de définir le sort final de la catégorie (valeurs spécifiques selon la catégorie)
      ClassificationLevelClassificationRulePermet de définir le niveau de classification
      ClassificationOwnerClassificationRulePermet de définir le service émetteur
      ClassificationAudienceClassificationRulePermet de définir le champ de diffusion
      ClassificationReassessingDateClassificationRulePermet de définir la date de réévaluation
      NeedReassessingAuthorizationClassificationRulePermet de définir si les modifications sont soumises (true) ou non (false) à validation humaine

      Pour les règles de gestion, voici les champs autorisés dans le tableau de règles (champ Rules) d'une catégorie

      ChampContraintesCommentaire
      OldRuleupdate, obligatoirePermet de définir l'identifiant de règle que l'on veut modifier
      Ruleadd/delete, obligatoire; update, facultatifPermet de définir l'identifiant de la règle que l'ont veut ajouter/supprimer ou de celle remplacant l'ancienne règle
      StartDateadd/update, facultatifPermet de définir la date de début de la règle ajoutée/modifiée
      DeleteStartDateupdate, facultatifPermet de supprimer (true) la date de début de la règle à mettre à jour

      Example:

      {
  "dslRequest": {
    "$roots": [ "id1" ],
    "$query": [
      {
        "$match": { "title": "titre" },
        "$depth": 4
      }
    ],
    "$threshold": 10000
  },
  "ruleActions": {
    "add": [
      {
        "AccessRule": {
          "PreventInheritance": false,
          "Rules": [
            {
              "Rule": "ACC-00003",
              "StartDate": "2018-11-14T00:00:00.000Z"
            }
          ]
        }
      },
      {
        "StorageRule": {
          "FinalAction": "Copy"
        }
      }
    ],
    "update": [
      {
        "AccessRule": {
          "Rules": [
            {
              "OldRule": "ACC-00001",
              "Rule": "ACC-00002"
            },
            {
              "OldRule": "ACC-00003",
              "DeleteStartDate": true
            }
          ]
        }
      }
    ],
    "delete": [
      {
        "ReuseRule": {
          "Rules": [
            {
              "Rule": "REU-00001"
            }
          ]
        }
      }
    ],
    "addOrUpdateMetadata": { },
    "deleteMetadata": {
      "ArchiveUnitProfile": ""
    }
  }
}

      HTTP status code 202

      Renvoie le statut de l'opération de mise à jour

      Headers

      • X-Request-Id: required (string)

        Unique Request Identifier

        Example:

        AbDUh67jj
      • FullApiVersion: (string)

        Complete Version of the API.

        Example:

        V1.25
      • X-Application-Id: (string)

        Session Identifier from client Front-Office Application

        Example:

        SESSION-ID-00001
      • X-Tenant-Id: required (number)

        Unique Tenant Identifier

        Example:

        0

      Body

      Media type: application/json

      Type: object

      HTTP status code 500

      Renvoie le statut final de l'opération en KO

      Body

      Media type: application/json

      Type: object

      post delete

      Request Calcule/Supprime les règles héritées pour les unités archivistiques répondant aux critères de la requête DSL.

      post

      Request that will launch the computation

      Permissions requises:

      • computeInheritedRules:action
      delete

      Request that will delete the computation

      Permissions requises:

      • computeInheritedRules:delete

      Request that will launch the computation

      Permissions requises:

      • computeInheritedRules:action

      Headers

      • X-Tenant-Id: required (number)

        Unique Tenant Identifier.

        Example:

        0
      • X-Access-Contract-Id: required (string)

        Unique Access Contract Identifier. Allow read/write access on specific archive unit.

        Example:

        Access-Contract-00001
      • X-Application-Id: (string)

        Session Identifier from client Front-Office Application

        Example:

        SESSION-ID-00001
      • X-Personal-Certificate: (string)

        Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

        Example:

        MIIGfzCCBGegAwIBAgICAPcwDQYJK...

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "$query": [
    {
      "$eq": {
        "#opi": "aeeaaaaaagfex4j4aaqcqalmjv7flpiaaaaq"
      }
    }
  ]
}

      HTTP status code 202

      Renvoie le statut de l'opération de mise à jour

      Headers

      • X-Request-Id: required (string)

        Unique Request Identifier

        Example:

        AbDUh67jj
      • FullApiVersion: (string)

        Complete Version of the API.

        Example:

        V1.25
      • X-Application-Id: (string)

        Session Identifier from client Front-Office Application

        Example:

        SESSION-ID-00001
      • X-Tenant-Id: required (number)

        Unique Tenant Identifier

        Example:

        0

      Body

      Media type: application/json

      Type: object

      HTTP status code 500

      Renvoie le statut final de l'opération en KO

      Body

      Media type: application/json

      Type: object

      get put

      API qui définit les requêtes pour accéder à une Unité d'archive. La requête utilise le langage de requête DSL de Vitam en entrée et retourne une liste d'Unités d'archives selon le DSL Vitam en cas de succès.

      get

      Requête qui retourne une Unité d'archive. La requête utilise le langage de requête DSL de type recherche unitaire (GET BY ID) de Vitam en entrée et retourne une liste d'Unités d'archives contenant 1 seul résultat selon le DSL Vitam en cas de succès.

      Permissions requises :

      • units:id:read:json
      put

      Requête qui modifie une Unité d'archive. La requête utilise le langage de requête DSL de type modification unitaire (UPDATE BY ID) de Vitam en entrée et retourne le statut de la mise à jour en résultat selon le DSL Vitam en cas de succès.

      Permissions requises:

      • units:id:update

      Requête qui retourne une Unité d'archive. La requête utilise le langage de requête DSL de type recherche unitaire (GET BY ID) de Vitam en entrée et retourne une liste d'Unités d'archives contenant 1 seul résultat selon le DSL Vitam en cas de succès.

      Permissions requises :

      • units:id:read:json

      URI Parameters

      • idu: required (string)

        Identifiant de l'unité d'archive.

      Headers

      • X-Access-Contract-Id: required (string)

        Unique Access Contract Identifier. Allow read/write access on specific archive unit.

        Example:

        Access-Contract-00001
      • X-Application-Id: (string)

        Session Identifier from client Front-Office Application

        Example:

        SESSION-ID-00001
      • X-Tenant-Id: required (number)

        Unique Tenant Identifier.

        Example:

        0
      • X-Personal-Certificate: (string)

        Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

        Example:

        MIIGfzCCBGegAwIBAgICAPcwDQYJK...
      • Accept: required (one of application/json, application/zip, application/octet-stream)

        Allow to specify if a result must contain only Metadata ('application/json') or only the Objects with a binary content ('application/octet-stream').

      Body

      Media type: application/json

      Type: object

      Properties
      • $projection: (object)

        Contient la projection à appliquer

        • $fields: (object)

        Examples:

        {
  "$projection": {
    "$fields": {
      "myField1": 1,
      "myField2.mySubField": 1
    }
  }
}
        {
  "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#parents": 1, "#object": 1 } }
}

        {
  "$projection": { "$fields": { "#id": 1, "#qualifiers": 1, "#type": 1, "#parents": 1 } }
}

        {
  "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#parents": 1, "#object": 1 } }
}

        HTTP status code 200

        Renvoie la liste de résultats contenant 1 Unité d'archive correspondant à la requête DSL

        Headers

        • X-Request-Id: required (string)

          Unique Request Identifier

          Example:

          AbDUh67jj
        • FullApiVersion: (string)

          Complete Version of the API.

          Example:

          V1.25
        • X-Application-Id: (string)

          Session Identifier from client Front-Office Application

          Example:

          SESSION-ID-00001
        • X-Tenant-Id: required (number)

          Unique Tenant Identifier

          Example:

          0

        Body

        Media type: application/json

        Type: DslTypes.DslGetByIdResponse

        Example:

        {
  "httpCode": 200,
  "$hits": {
    "total": 1,
    "size": 1,
    "offset": 0,
    "limit": 10000
  },
  "$context": {
    "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#parents": 1, "#object": 1 } }
  },
  "$results": [
    {
      "#id": "id1", "title": "titre 1", "#type": "DemandeCongés",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés" } ],
      "#object": { "#id": "id101", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    }
  ]
}

        HTTP status code 400

        Bad Request, syntax might be erroneous

        Headers

        • X-Request-Id: required (string)

          Unique Request Identifier

          Example:

          AbDUh67jj
        • FullApiVersion: (string)

          Complete Version of the API.

          Example:

          V1.25
        • X-Application-Id: (string)

          Session Identifier from client Front-Office Application

          Example:

          SESSION-ID-00001
        • X-Tenant-Id: required (number)

          Unique Tenant Identifier

          Example:

          0

        HTTP status code 401

        Unauthorized (restricted operation), authentication in error

        Headers

        • X-Request-Id: required (string)

          Unique Request Identifier

          Example:

          AbDUh67jj
        • FullApiVersion: (string)

          Complete Version of the API.

          Example:

          V1.25
        • X-Application-Id: (string)

          Session Identifier from client Front-Office Application

          Example:

          SESSION-ID-00001
        • X-Tenant-Id: required (number)

          Unique Tenant Identifier

          Example:

          0

        HTTP status code 403

        Forbidden, requested action is forbidden

        Headers

        • X-Request-Id: required (string)

          Unique Request Identifier

          Example:

          AbDUh67jj
        • FullApiVersion: (string)

          Complete Version of the API.

          Example:

          V1.25
        • X-Application-Id: (string)

          Session Identifier from client Front-Office Application

          Example:

          SESSION-ID-00001
        • X-Tenant-Id: required (number)

          Unique Tenant Identifier

          Example:

          0

        HTTP status code 404

        Not Found, requested resource does not exist

        Headers

        • X-Request-Id: required (string)

          Unique Request Identifier

          Example:

          AbDUh67jj
        • FullApiVersion: (string)

          Complete Version of the API.

          Example:

          V1.25
        • X-Application-Id: (string)

          Session Identifier from client Front-Office Application

          Example:

          SESSION-ID-00001
        • X-Tenant-Id: required (number)

          Unique Tenant Identifier

          Example:

          0

        HTTP status code 412

        Precondition Failed, some predicates are incorrect, therefore the operation is not possible

        Headers

        • X-Request-Id: required (string)

          Unique Request Identifier

          Example:

          AbDUh67jj
        • FullApiVersion: (string)

          Complete Version of the API.

          Example:

          V1.25
        • X-Application-Id: (string)

          Session Identifier from client Front-Office Application

          Example:

          SESSION-ID-00001
        • X-Tenant-Id: required (number)

          Unique Tenant Identifier

          Example:

          0

        Requête qui modifie une Unité d'archive. La requête utilise le langage de requête DSL de type modification unitaire (UPDATE BY ID) de Vitam en entrée et retourne le statut de la mise à jour en résultat selon le DSL Vitam en cas de succès.

        Permissions requises:

        • units:id:update

        URI Parameters

        • idu: required (string)

          Identifiant de l'unité d'archive.

        Headers

        • X-Access-Contract-Id: required (string)

          Unique Access Contract Identifier. Allow read/write access on specific archive unit.

          Example:

          Access-Contract-00001
        • X-Application-Id: (string)

          Session Identifier from client Front-Office Application

          Example:

          SESSION-ID-00001
        • X-Tenant-Id: required (number)

          Unique Tenant Identifier.

          Example:

          0
        • X-Personal-Certificate: (string)

          Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

          Example:

          MIIGfzCCBGegAwIBAgICAPcwDQYJK...

        Body

        Media type: application/json

        Type: DslTypes.DslUpdateByIdQuery

        Example:

        {
  "$action": [ { "$set": { "NewField": "New value" } } ]
}

        HTTP status code 200

        Renvoie l'état d'execution de la modification correspondant à la requête DSL

        Headers

        • X-Request-Id: required (string)

          Unique Request Identifier

          Example:

          AbDUh67jj
        • FullApiVersion: (string)

          Complete Version of the API.

          Example:

          V1.25
        • X-Application-Id: (string)

          Session Identifier from client Front-Office Application

          Example:

          SESSION-ID-00001
        • X-Tenant-Id: required (number)

          Unique Tenant Identifier

          Example:

          0

        Body

        Media type: application/json

        Type: DslTypes.DslUpdateByIdResponse

        Example:

        {
  "httpCode": 200,
  "$hits": {
    "total": 0,
    "size": 0,
    "offset": 0,
    "limit": 0
  },
  "$context": {
    "$action": [{ "$set": { "NewField": "New value" } }]
  },
  "$results": []
}

        HTTP status code 400

        Bad Request, syntax might be erroneous

        Headers

        • X-Request-Id: required (string)

          Unique Request Identifier

          Example:

          AbDUh67jj
        • FullApiVersion: (string)

          Complete Version of the API.

          Example:

          V1.25
        • X-Application-Id: (string)

          Session Identifier from client Front-Office Application

          Example:

          SESSION-ID-00001
        • X-Tenant-Id: required (number)

          Unique Tenant Identifier

          Example:

          0

        HTTP status code 401

        Unauthorized (restricted operation), authentication in error

        Headers

        • X-Request-Id: required (string)

          Unique Request Identifier

          Example:

          AbDUh67jj
        • FullApiVersion: (string)

          Complete Version of the API.

          Example:

          V1.25
        • X-Application-Id: (string)

          Session Identifier from client Front-Office Application

          Example:

          SESSION-ID-00001
        • X-Tenant-Id: required (number)

          Unique Tenant Identifier

          Example:

          0

        HTTP status code 403

        Forbidden, requested action is forbidden

        Headers

        • X-Request-Id: required (string)

          Unique Request Identifier

          Example:

          AbDUh67jj
        • FullApiVersion: (string)

          Complete Version of the API.

          Example:

          V1.25
        • X-Application-Id: (string)

          Session Identifier from client Front-Office Application

          Example:

          SESSION-ID-00001
        • X-Tenant-Id: required (number)

          Unique Tenant Identifier

          Example:

          0

        HTTP status code 404

        Not Found, requested resource does not exist

        Headers

        • X-Request-Id: required (string)

          Unique Request Identifier

          Example:

          AbDUh67jj
        • FullApiVersion: (string)

          Complete Version of the API.

          Example:

          V1.25
        • X-Application-Id: (string)

          Session Identifier from client Front-Office Application

          Example:

          SESSION-ID-00001
        • X-Tenant-Id: required (number)

          Unique Tenant Identifier

          Example:

          0

        HTTP status code 405

        Method Not Allowed, requested resource is not allowed

        Headers

        • X-Request-Id: required (string)

          Unique Request Identifier

          Example:

          AbDUh67jj
        • FullApiVersion: (string)

          Complete Version of the API.

          Example:

          V1.25
        • X-Application-Id: (string)

          Session Identifier from client Front-Office Application

          Example:

          SESSION-ID-00001
        • X-Tenant-Id: required (number)

          Unique Tenant Identifier

          Example:

          0

        HTTP status code 412

        Precondition Failed, some predicates are incorrect, therefore the operation is not possible

        Headers

        • X-Request-Id: required (string)

          Unique Request Identifier

          Example:

          AbDUh67jj
        • FullApiVersion: (string)

          Complete Version of the API.

          Example:

          V1.25
        • X-Application-Id: (string)

          Session Identifier from client Front-Office Application

          Example:

          SESSION-ID-00001
        • X-Tenant-Id: required (number)

          Unique Tenant Identifier

          Example:

          0

        get post

        API qui définit les requêtes pour accéder à l'Objet d'archives associé à l'Unité d'archives s'il existe. La requête utilise le langage de requête (DSL) de Vitam en entrée et retourne l'objet d'archives selon le DSL Vitam en cas de succès.

        get

        Requête qui retourne le résultat contenant un Object d'archives : ses métadonnées ou un de ses objets binaires. Dans le cas des métadonnées, la requête utilise le langage de requête DSL de type recherche unitaire (GET BY ID) de Vitam en entrée. 'Accept' header est 'application/octet-stream' (objet binaire) ou 'application/json' (métadonnées)

        Permissions requises:

        • units:id:objects:read:json

          ou

        • units:id:objects:read:binary
        post

        Requête qui retourne le résultat contenant un Object d'archives : ses métadonnées ou un de ses objets binaires. Dans le cas des métadonnées, la requête utilise le langage de requête DSL de type recherche unitaire (GET BY ID) de Vitam en entrée. 'Accept' header est 'application/octet-stream' (objet binaire) ou 'application/json' (métadonnées) La requête utilise POST avec X-Http-Method-Override: GET.

        Requête qui retourne le résultat contenant un Object d'archives : ses métadonnées ou un de ses objets binaires. Dans le cas des métadonnées, la requête utilise le langage de requête DSL de type recherche unitaire (GET BY ID) de Vitam en entrée. 'Accept' header est 'application/octet-stream' (objet binaire) ou 'application/json' (métadonnées)

        Permissions requises:

        • units:id:objects:read:json

          ou

        • units:id:objects:read:binary

        URI Parameters

        • idu: required (string)

          Identifiant de l'unité d'archive.

        Headers

        • Accept: required (one of application/octet-stream, application/json, application/zip)

          Allow to specify if a result must contain only Metadata ('application/json') or only the Objects with a binary content ('application/octet-stream').

        • X-Qualifier: (one of PhysicalMaster, BinaryMaster, Dissemination, Thumbnail, TextContent)

          L'usage est utilisée et obligatoire uniquement en présence de Accept: application/octet-stream. ONLY VALID with Accept application/octet-stream

        • X-Version: (integer)

          La version est utilisée et obligatoire uniquement en présence de Accept: application/octet-stream. ONLY VALID with Accept application/octet-stream

        • X-Access-Contract-Id: required (string)

          Unique Access Contract Identifier. Allow read/write access on specific archive unit.

          Example:

          Access-Contract-00001
        • X-Application-Id: (string)

          Session Identifier from client Front-Office Application

          Example:

          SESSION-ID-00001
        • X-Tenant-Id: required (number)

          Unique Tenant Identifier.

          Example:

          0
        • X-Personal-Certificate: (string)

          Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

          Example:

          MIIGfzCCBGegAwIBAgICAPcwDQYJK...

        Body

        Media type: application/json

        Type: object

        Properties
        • $projection: (object)

          Contient la projection à appliquer

          • $fields: (object)

          Examples:

          {
  "$projection": {
    "$fields": {
      "myField1": 1,
      "myField2.mySubField": 1
    }
  }
}
          {
  "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#parents": 1, "#object": 1 } }
}

          {
  "$projection": { "$fields": { "#id": 1, "#qualifiers": 1, "#type": 1, "#parents": 1 } }
}

          {
  "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#parents": 1, "#object": 1 } }
}

          {
  "$projection": { "$fields": { "#id": 1, "#qualifiers": 1, "#type": 1, "#parents": 1 } }
}

          HTTP status code 200

          Renvoie l'objet binaire (Returns the list of 1 Object matching the DSL query)

          Headers

          • X-Qualifier: (one of PhysicalMaster, BinaryMaster, Dissemination, Thumbnail, TextContent)

            L'usage est utilisée et obligatoire uniquement en présence de Accept: application/octet-stream. ONLY VALID with Accept application/octet-stream

          • X-Version: (integer)

            La version est utilisée et obligatoire uniquement en présence de Accept: application/octet-stream. ONLY VALID with Accept application/octet-stream

          • X-Request-Id: required (string)

            Unique Request Identifier

            Example:

            AbDUh67jj
          • FullApiVersion: (string)

            Complete Version of the API.

            Example:

            V1.25
          • X-Application-Id: (string)

            Session Identifier from client Front-Office Application

            Example:

            SESSION-ID-00001
          • X-Tenant-Id: required (number)

            Unique Tenant Identifier

            Example:

            0

          Body

          Media type: application/octet-stream

          Type: object

          Media type: application/json

          Type: DslTypes.DslGetByIdResponse

          Example:

          {
  "httpCode": 200,
  "$hits": {
    "total": 1,
    "size": 1,
    "offset": 0,
    "limit": 10000
  },
  "$context": {
    "$projection": { "$fields": { "#id": 1, "#qualifiers": 1, "#type": 1, "#parents": 1 } }
  },
  "$results": [
    {
      "#id": "id101", "#type": "Document",
      "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 },
      "#parents": [ { "#id": "id1", "#type": "DemandeCongés", "#sector": "RessourcesHumaines" } ]
    }
  ]
}

          HTTP status code 400

          Bad Request, syntax might be erroneous

          Headers

          • X-Request-Id: required (string)

            Unique Request Identifier

            Example:

            AbDUh67jj
          • FullApiVersion: (string)

            Complete Version of the API.

            Example:

            V1.25
          • X-Application-Id: (string)

            Session Identifier from client Front-Office Application

            Example:

            SESSION-ID-00001
          • X-Tenant-Id: required (number)

            Unique Tenant Identifier

            Example:

            0

          HTTP status code 401

          Unauthorized (restricted operation), authentication in error

          Headers

          • X-Request-Id: required (string)

            Unique Request Identifier

            Example:

            AbDUh67jj
          • FullApiVersion: (string)

            Complete Version of the API.

            Example:

            V1.25
          • X-Application-Id: (string)

            Session Identifier from client Front-Office Application

            Example:

            SESSION-ID-00001
          • X-Tenant-Id: required (number)

            Unique Tenant Identifier

            Example:

            0

          HTTP status code 403

          Forbidden, requested action is forbidden

          Headers

          • X-Request-Id: required (string)

            Unique Request Identifier

            Example:

            AbDUh67jj
          • FullApiVersion: (string)

            Complete Version of the API.

            Example:

            V1.25
          • X-Application-Id: (string)

            Session Identifier from client Front-Office Application

            Example:

            SESSION-ID-00001
          • X-Tenant-Id: required (number)

            Unique Tenant Identifier

            Example:

            0

          HTTP status code 404

          Not Found, requested resource does not exist

          Headers

          • X-Request-Id: required (string)

            Unique Request Identifier

            Example:

            AbDUh67jj
          • FullApiVersion: (string)

            Complete Version of the API.

            Example:

            V1.25
          • X-Application-Id: (string)

            Session Identifier from client Front-Office Application

            Example:

            SESSION-ID-00001
          • X-Tenant-Id: required (number)

            Unique Tenant Identifier

            Example:

            0

          HTTP status code 412

          Precondition Failed, some predicates are incorrect, therefore the operation is not possible

          Headers

          • X-Request-Id: required (string)

            Unique Request Identifier

            Example:

            AbDUh67jj
          • FullApiVersion: (string)

            Complete Version of the API.

            Example:

            V1.25
          • X-Application-Id: (string)

            Session Identifier from client Front-Office Application

            Example:

            SESSION-ID-00001
          • X-Tenant-Id: required (number)

            Unique Tenant Identifier

            Example:

            0

          Requête qui retourne le résultat contenant un Object d'archives : ses métadonnées ou un de ses objets binaires. Dans le cas des métadonnées, la requête utilise le langage de requête DSL de type recherche unitaire (GET BY ID) de Vitam en entrée. 'Accept' header est 'application/octet-stream' (objet binaire) ou 'application/json' (métadonnées) La requête utilise POST avec X-Http-Method-Override: GET.

          URI Parameters

          • idu: required (string)

            Identifiant de l'unité d'archive.

          Headers

          • X-Http-Method-Override: required (GET)
          • Accept: required (one of application/octet-stream, application/json, application/zip)

            Allow to specify if a result must contain only Metadata ('application/json') or only the Objects with a binary content ('application/octet-stream').

          • X-Qualifier: (one of PhysicalMaster, BinaryMaster, Dissemination, Thumbnail, TextContent)

            L'usage est utilisée et obligatoire uniquement en présence de Accept: application/octet-stream. ONLY VALID with Accept application/octet-stream

          • X-Version: (integer)

            La version est utilisée et obligatoire uniquement en présence de Accept: application/octet-stream. ONLY VALID with Accept application/octet-stream

          • X-Access-Contract-Id: required (string)

            Unique Access Contract Identifier. Allow read/write access on specific archive unit.

            Example:

            Access-Contract-00001
          • X-Application-Id: (string)

            Session Identifier from client Front-Office Application

            Example:

            SESSION-ID-00001
          • X-Tenant-Id: required (number)

            Unique Tenant Identifier.

            Example:

            0
          • X-Personal-Certificate: (string)

            Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

            Example:

            MIIGfzCCBGegAwIBAgICAPcwDQYJK...

          Body

          Media type: application/json

          Type: object

          Properties
          • $projection: (object)

            Contient la projection à appliquer

            • $fields: (object)

            Examples:

            {
  "$projection": {
    "$fields": {
      "myField1": 1,
      "myField2.mySubField": 1
    }
  }
}
            {
  "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#parents": 1, "#object": 1 } }
}

            {
  "$projection": { "$fields": { "#id": 1, "#qualifiers": 1, "#type": 1, "#parents": 1 } }
}

            {
  "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#parents": 1, "#object": 1 } }
}

            {
  "$projection": { "$fields": { "#id": 1, "#qualifiers": 1, "#type": 1, "#parents": 1 } }
}

            {
  "$projection": { "$fields": { "#id": 1, "#qualifiers": 1, "#type": 1, "#parents": 1 } }
}

            HTTP status code 200

            Renvoie l'objet binaire (Returns the list of 1 Object matching the DSL query)

            Headers

            • X-Qualifier: (one of PhysicalMaster, BinaryMaster, Dissemination, Thumbnail, TextContent)

              L'usage est utilisée et obligatoire uniquement en présence de Accept: application/octet-stream. ONLY VALID with Accept application/octet-stream

            • X-Version: (integer)

              La version est utilisée et obligatoire uniquement en présence de Accept: application/octet-stream. ONLY VALID with Accept application/octet-stream

            • X-Request-Id: required (string)

              Unique Request Identifier

              Example:

              AbDUh67jj
            • FullApiVersion: (string)

              Complete Version of the API.

              Example:

              V1.25
            • X-Application-Id: (string)

              Session Identifier from client Front-Office Application

              Example:

              SESSION-ID-00001
            • X-Tenant-Id: required (number)

              Unique Tenant Identifier

              Example:

              0

            Body

            Media type: application/octet-stream

            Type: object

            Media type: application/json

            Type: DslTypes.DslGetByIdResponse

            Example:

            {
  "httpCode": 200,
  "$hits": {
    "total": 1,
    "size": 1,
    "offset": 0,
    "limit": 10000
  },
  "$context": {
    "$projection": { "$fields": { "#id": 1, "#qualifiers": 1, "#type": 1, "#parents": 1 } }
  },
  "$results": [
    {
      "#id": "id101", "#type": "Document",
      "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 },
      "#parents": [ { "#id": "id1", "#type": "DemandeCongés", "#sector": "RessourcesHumaines" } ]
    }
  ]
}

            HTTP status code 400

            Bad Request, syntax might be erroneous

            Headers

            • X-Request-Id: required (string)

              Unique Request Identifier

              Example:

              AbDUh67jj
            • FullApiVersion: (string)

              Complete Version of the API.

              Example:

              V1.25
            • X-Application-Id: (string)

              Session Identifier from client Front-Office Application

              Example:

              SESSION-ID-00001
            • X-Tenant-Id: required (number)

              Unique Tenant Identifier

              Example:

              0

            HTTP status code 401

            Unauthorized (restricted operation), authentication in error

            Headers

            • X-Request-Id: required (string)

              Unique Request Identifier

              Example:

              AbDUh67jj
            • FullApiVersion: (string)

              Complete Version of the API.

              Example:

              V1.25
            • X-Application-Id: (string)

              Session Identifier from client Front-Office Application

              Example:

              SESSION-ID-00001
            • X-Tenant-Id: required (number)

              Unique Tenant Identifier

              Example:

              0

            HTTP status code 403

            Forbidden, requested action is forbidden

            Headers

            • X-Request-Id: required (string)

              Unique Request Identifier

              Example:

              AbDUh67jj
            • FullApiVersion: (string)

              Complete Version of the API.

              Example:

              V1.25
            • X-Application-Id: (string)

              Session Identifier from client Front-Office Application

              Example:

              SESSION-ID-00001
            • X-Tenant-Id: required (number)

              Unique Tenant Identifier

              Example:

              0

            HTTP status code 404

            Not Found, requested resource does not exist

            Headers

            • X-Request-Id: required (string)

              Unique Request Identifier

              Example:

              AbDUh67jj
            • FullApiVersion: (string)

              Complete Version of the API.

              Example:

              V1.25
            • X-Application-Id: (string)

              Session Identifier from client Front-Office Application

              Example:

              SESSION-ID-00001
            • X-Tenant-Id: required (number)

              Unique Tenant Identifier

              Example:

              0

            HTTP status code 412

            Precondition Failed, some predicates are incorrect, therefore the operation is not possible

            Headers

            • X-Request-Id: required (string)

              Unique Request Identifier

              Example:

              AbDUh67jj
            • FullApiVersion: (string)

              Complete Version of the API.

              Example:

              V1.25
            • X-Application-Id: (string)

              Session Identifier from client Front-Office Application

              Example:

              SESSION-ID-00001
            • X-Tenant-Id: required (number)

              Unique Tenant Identifier

              Example:

              0

            ArchiveUnits with inherited rules

            API qui définit les requêtes pour accéder aux Unités d'archives avec leurs règles de gestion héritées. La requête utilise le langage de requête DSL de Vitam en entrée et retourne une liste d'Unités d'archives avec leurs règles de gestion selon le DSL Vitam en cas de succès.

            get

            get

            Requête qui retourne des résultats contenant des Unités d'archives ainsi que leurs règles de gestion héritées. La requête utilise le langage de requête DSL de type recherche multiple (SELECT MULTIPLE) de Vitam en entrée et retourne une liste d'Unités d'archives avec leurs règles de gestion selon le DSL Vitam en cas de succès.

            Permissions requises:

            • unitsWithInheritedRules:read

            DIP Export

            API qui définit les requêtes pour générer un DIP (Dissemination Information Package : ZIP contenant les métadonnées et les objets) pour une sélection d'Unités d'archives. La requête utilise le langage de requête (DSL) de Vitam en entrée et va lancer un processus générant le DIP selon le DSL passé. Une autre requête pourra être exécutée par la suite pour télécharger le fichier Zip généré.

            post

            post

            response : JSON asynchronous state / HTTP CODE 202 or 500 for Internal Server Error La requête utilise le langage de requête DSL de type recherche multiple (SELECT MULTIPLE) de Vitam en entrée.

            Permissions requises:

            • dipexport:create

            response : JSON asynchronous state / HTTP CODE 202 or 500 for Internal Server Error La requête utilise le langage de requête DSL de type recherche multiple (SELECT MULTIPLE) de Vitam en entrée.

            Permissions requises:

            • dipexport:create

            Headers

            • X-Application-Id: (string)

              Session Identifier from client Front-Office Application

              Example:

              SESSION-ID-00001
            • X-Tenant-Id: required (number)

              Unique Tenant Identifier.

              Example:

              0
            • X-Access-Contract-Id: required (string)

              Unique Access Contract Identifier. Allow read/write access on specific archive unit.

              Example:

              Access-Contract-00001
            • X-Personal-Certificate: (string)

              Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

              Example:

              MIIGfzCCBGegAwIBAgICAPcwDQYJK...

            Body

            Media type: application/json

            Type: DslTypes.DslMultipleQuery

            Example:

            {
  "$roots": [ "id0" ],
  "$query": [
    { "$match": { "title": "titre" }, "$depth": 4 }
  ],
  "$filter": { "$limit": 1000, "$offset": 10 },
  "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#sector": 1, "#parents": 1, "#object": 1 } }
}

            HTTP status code 202

            Renvoie le statut de l'opération de DIP

            Headers

            • X-Request-Id: required (string)

              Unique Request Identifier

              Example:

              AbDUh67jj
            • FullApiVersion: (string)

              Complete Version of the API.

              Example:

              V1.25
            • X-Application-Id: (string)

              Session Identifier from client Front-Office Application

              Example:

              SESSION-ID-00001
            • X-Tenant-Id: required (number)

              Unique Tenant Identifier

              Example:

              0

            Body

            Media type: application/json

            Type: StandardTypes.ErrorMultiple

            Properties
            • #id: required (string)

              Id of the Operation accessible through the corresponding collection specified in "context"

            • start_date: required (datetime)

              Start date of the operation

            Examples:

            {
  "#id": "idIngests",
  "httpCode": 200,
  "code": "VitamCode",
  "context": "ingest",
  "state": "Done",
  "message": "The ingest is done, the report can be downloaded",
  "description": "The application 'Xxxx' requested an ingest operation and this operation is done.",
  "start_date": "2014-01-10T03:06:17.396Z"
}
            {
  "#id": "idDip",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Running",
  "message": "The DIP is in progress",
  "description": "The application 'Xxxx' requested a DIP operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}

            {
  "#id": "idDip",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Running",
  "message": "The DIP is in progress",
  "description": "The application 'Xxxx' requested a DIP operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}

            {
  "#id": "idTransfer",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Completed",
  "message": "The Transfer is in progress",
  "description": "The application 'Xxxx' requested a Transfer operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}
            {
  "#id": "idTransfer",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Completed",
  "message": "The Transfer is in progress",
  "description": "The application 'Xxxx' requested a Transfer operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}
            {
  "#id": "idDip",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Running",
  "message": "The DIP is in progress",
  "description": "The application 'Xxxx' requested a DIP operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}

            HTTP status code 500

            Renvoie ce statut en cas d'erreur interne

            Body

            Media type: application/json

            Type: object

            get

            Télécharger le DIP généré par l'opération passée en paramètre

            get

            Requête qui retourne les résultats composés des métadonnées et des objets binaires dans un fichier zip 'Accept' header est 'application/octet-stream'

            Permissions requises:

            • dipexport:id:dip:read

            Requête qui retourne les résultats composés des métadonnées et des objets binaires dans un fichier zip 'Accept' header est 'application/octet-stream'

            Permissions requises:

            • dipexport:id:dip:read

            URI Parameters

            • id: required (string)

              Identifiant de l'opération d'export DIP.

            Headers

            • Accept: required (application/octet-stream)

            HTTP status code 202

            Returns the generated zip file

            Body

            Media type: application/octet-stream

            Type: object

            HTTP status code 412

            Precondition Failed, some predicates are incorrect, therefore the operation is not possible

            Body

            Media type: application/json

            Type: object

            DIP Export V2

            API qui définit les requêtes pour générer un DIP (Dissemination Information Package : ZIP contenant les métadonnées et les objets) pour une sélection d'Unités d'archives. La requête est composée d'une dslRequest (DSL) et d'autres paramètres nécessaires pour le service. Un processus générant le DIP V2 selon le DSL passé sera lancé. Une autre requête pourra être exécutée par la suite pour télécharger le fichier Zip généré.

            post

            post

            response : JSON asynchronous state / HTTP CODE 202 or 500 for internal error La requête utilise le langage de requête DSL de type recherche multiple (SELECT MULTIPLE) de Vitam en entrée.

            response : JSON asynchronous state / HTTP CODE 202 or 500 for internal error La requête utilise le langage de requête DSL de type recherche multiple (SELECT MULTIPLE) de Vitam en entrée.

            Headers

            • X-Application-Id: (string)

              Session Identifier from client Front-Office Application

              Example:

              SESSION-ID-00001
            • X-Tenant-Id: required (number)

              Unique Tenant Identifier.

              Example:

              0
            • X-Access-Contract-Id: required (string)

              Unique Access Contract Identifier. Allow read/write access on specific archive unit.

              Example:

              Access-Contract-00001
            • X-Personal-Certificate: (string)

              Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

              Example:

              MIIGfzCCBGegAwIBAgICAPcwDQYJK...

            Body

            Media type: application/json

            Type: object

            Properties
            • dipExportType: required (one of MINIMAL, FULL)

              Le type d'export DIP

            • exportWithLogBookLFC: (boolean)

              True pour inclure les logbook de cycle de vie des unités archivistiques et groupes d'objets

            • dslRequest: required (object)

              Contient la requête de recherche

              • $roots: required (array of items)

                Contient les racines de la recherche

              • $query: required (array of items)

                Contient plusieurs requêtes

              • $filter: (object)

                Contient les filtres à appliquer

                • $offset: (integer - minimum: 1 - maximum: 100000)
                • $limit: (integer - minimum: 1 - maximum: 100000)
                • $orderby: (object)
                • $projection: (object)

                  Contient la projection à appliquer

                  • $fields: (object)

                  Example:

                  {
  "$roots": [
    "guid1",
    "guid2"
  ],
  "$query": [
    {
      "$eq": {
        "myField1": "myValue"
      },
      "$depth": 4
    }
  ],
  "$filter": {
    "$limit": 100,
    "$offset": 50
  },
  "$projection": {
    "$fields": {
      "myField1": 1,
      "myField2.mySubField": 1
    }
  }
}
                • dataObjectVersionToExport: (object)

                  L'identifiant du scénario de préservation

                  • dataObjectVersions: required (array of items)

                    Liste des versions d'objets à inclure dans l'export

                • dipRequestParameters: (object)

                  Les paramètres nécessaires pour faire un export DIP, ce champs est obligatoire quand le dipExportType est FULL

                  • archivalAgreement: (string)

                    Contrat d'entrée

                  • originatingAgencyIdentifier: (string)

                    Identifiant du service producteur

                  • comment: (string)

                    Intitulé

                  • submissionAgencyIdentifier: (string)

                    Identifiant du service versant

                  • archivalAgencyIdentifier: required (string)

                    Identifiant du service d'archives. Si Vitam trouve un seul service d'archives pour la selection d'unités archivistiques, ce service sera utilisé par défaut.

                  • messageRequestIdentifier: required (string)

                    Identifiant de la demande

                  • requesterIdentifier: required (string)

                    Identifiant du demandeur

                  • authorizationRequestReplyIdentifier: (string)

                    Identifiant de la réponse à une demande d'autorisation

                Example:

                {
  "dipExportType": "FULL",
  "dataObjectVersionToExport": {
    "dataObjectVersions": [
      "BinaryMaster"
    ]
  },
  "transferWithLogBookLFC": true,
  "dipRequestParameters": {
    "archivalAgreement": "ArchivalAgreement",
    "originatingAgencyIdentifier": "OriginatingAgencyIdentifier",
    "comment": "Comment",
    "submissionAgencyIdentifier": "SubmissionAgencyIdentifier",
    "messageRequestIdentifier": "MessageRequestIdentifier",
    "authorizationRequestReplyIdentifier": "AuthorizationRequestReplyIdentifier",
    "archivalAgencyIdentifier": "ArchivalAgencyIdentifier",
    "requesterIdentifier": "RequesterIdentifier"
  },
  "dslRequest": {
    "$roots": [
      "id0"
    ],
    "$query": [
      {
        "$match": {
          "title": "titre"
        },
        "$depth": 4
      }
    ],
    "$filter": {
      "$limit": 1000,
      "$offset": 10
    },
    "$projection": {
      "$fields": {
        "#id": 1,
        "title": 1,
        "#type": 1,
        "#sector": 1,
        "#parents": 1,
        "#object": 1
      }
    }
  }
}

                HTTP status code 202

                Renvoie le statut de l'opération de DIP V2

                Headers

                • X-Request-Id: required (string)

                  Unique Request Identifier

                  Example:

                  AbDUh67jj
                • FullApiVersion: (string)

                  Complete Version of the API.

                  Example:

                  V1.25
                • X-Application-Id: (string)

                  Session Identifier from client Front-Office Application

                  Example:

                  SESSION-ID-00001
                • X-Tenant-Id: required (number)

                  Unique Tenant Identifier

                  Example:

                  0

                Body

                Media type: application/json

                Type: StandardTypes.ErrorMultiple

                Properties
                • #id: required (string)

                  Id of the Operation accessible through the corresponding collection specified in "context"

                • start_date: required (datetime)

                  Start date of the operation

                Examples:

                {
  "#id": "idIngests",
  "httpCode": 200,
  "code": "VitamCode",
  "context": "ingest",
  "state": "Done",
  "message": "The ingest is done, the report can be downloaded",
  "description": "The application 'Xxxx' requested an ingest operation and this operation is done.",
  "start_date": "2014-01-10T03:06:17.396Z"
}
                {
  "#id": "idDip",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Running",
  "message": "The DIP is in progress",
  "description": "The application 'Xxxx' requested a DIP operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}

                {
  "#id": "idDip",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Running",
  "message": "The DIP is in progress",
  "description": "The application 'Xxxx' requested a DIP operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}

                {
  "#id": "idTransfer",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Completed",
  "message": "The Transfer is in progress",
  "description": "The application 'Xxxx' requested a Transfer operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}
                {
  "#id": "idTransfer",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Completed",
  "message": "The Transfer is in progress",
  "description": "The application 'Xxxx' requested a Transfer operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}
                {
  "#id": "idDip",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Running",
  "message": "The DIP is in progress",
  "description": "The application 'Xxxx' requested a DIP operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}

                {
  "#id": "idDip",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Running",
  "message": "The DIP is in progress",
  "description": "The application 'Xxxx' requested a DIP operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}

                HTTP status code 500

                Renvoie ce statut en cas d'erreur interne

                Body

                Media type: application/json

                Type: object

                get

                Télécharger le DIP généré par l'opération passée en paramètre

                get

                Requête qui retourne les résultats composés des métadonnées et des objets binaires dans un fichier zip 'Accept' header est 'application/octet-stream'

                Requête qui retourne les résultats composés des métadonnées et des objets binaires dans un fichier zip 'Accept' header est 'application/octet-stream'

                URI Parameters

                • id: required (string)

                  Identifiant de l'opération d'export DIP V2.

                Headers

                • Accept: required (application/octet-stream)

                HTTP status code 202

                Returns the generated zip file

                Body

                Media type: application/octet-stream

                Type: object

                HTTP status code 412

                Precondition Failed, some predicates are incorrect, therefore the operation is not possible

                Body

                Media type: application/json

                Type: object

                Transfert d'archives

                API qui définit les requêtes pour générer un transfert d'une sélection d'unités d'archives. La requête est composée d'une dslRequest (DSL) et d'autres paramètres nécessaires pour le service. Un processus générant le SIP selon le DSL passé sera lancé. Une autre requête pourra être exécutée par la suite pour télécharger le fichier Zip généré.

                post

                post

                response : JSON asynchronous state / HTTP CODE (202, 200) or (412, 500 else) La requête utilise le langage de requête DSL de type recherche multiple (SELECT MULTIPLE) de Vitam en entrée.

                Permissions requises:

                • transfers:create

                response : JSON asynchronous state / HTTP CODE (202, 200) or (412, 500 else) La requête utilise le langage de requête DSL de type recherche multiple (SELECT MULTIPLE) de Vitam en entrée.

                Permissions requises:

                • transfers:create

                Headers

                • X-Application-Id: (string)

                  Session Identifier from client Front-Office Application

                  Example:

                  SESSION-ID-00001
                • X-Tenant-Id: required (number)

                  Unique Tenant Identifier.

                  Example:

                  0
                • X-Access-Contract-Id: required (string)

                  Unique Access Contract Identifier. Allow read/write access on specific archive unit.

                  Example:

                  Access-Contract-00001
                • X-Personal-Certificate: (string)

                  Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

                  Example:

                  MIIGfzCCBGegAwIBAgICAPcwDQYJK...

                Body

                Media type: application/json

                Type: object

                Properties
                • exportWithLogBookLFC: (boolean)

                  True pour inclure les logbook de cycle de vie des unités archivistiques et groupes d'objets pour le DIP

                • transferWithLogBookLFC: (boolean)

                  True pour inclure les logbook de cycle de vie des unités archivistiques et groupes d'objets pour le transfert

                • dslRequest: required (object)

                  Contient la requête de recherche

                  • $roots: required (array of items)

                    Contient les racines de la recherche

                  • $query: required (array of items)

                    Contient plusieurs requêtes

                  • $filter: (object)

                    Contient les filtres à appliquer

                    • $offset: (integer - minimum: 1 - maximum: 100000)
                    • $limit: (integer - minimum: 1 - maximum: 100000)
                    • $orderby: (object)
                    • $projection: (object)

                      Contient la projection à appliquer

                      • $fields: (object)

                      Example:

                      {
  "$roots": [
    "guid1",
    "guid2"
  ],
  "$query": [
    {
      "$eq": {
        "myField1": "myValue"
      },
      "$depth": 4
    }
  ],
  "$filter": {
    "$limit": 100,
    "$offset": 50
  },
  "$projection": {
    "$fields": {
      "myField1": 1,
      "myField2.mySubField": 1
    }
  }
}
                    • dataObjectVersionToExport: (object)

                      L'identifiant du scénario de préservation

                      • dataObjectVersions: required (array of items)

                        Liste des versions d'objets à inclure dans l'export

                    • transferRequestParameters: required (object)

                      Les paramètres nécessaires pour faire un transfert d'unités archivistiques

                      • archivalAgreement: required (string)

                        Contrat d'entrée

                      • originatingAgencyIdentifier: required (string)

                        Identifiant du service producteur

                      • archivalAgencyIdentifier: required (string)

                        Identifiant du service d'archives

                      • comment: (string)

                        Intitulé

                      • submissionAgencyIdentifier: (string)

                        Identifiant du service versant

                      • transferringAgency: (string)

                        Service versant

                      • transferRequestReplyIdentifier: (string)

                        Identifiant de la réponse à une demande de transfert

                      • relatedTransferReference: (array of items)

                        Référence à un transfert d'archives lié

                    Example:

                    {
  "dataObjectVersionToExport": {
    "dataObjectVersions": [
      "BinaryMaster"
    ]
  },
  "transferWithLogBookLFC": true,
  "transferRequestParameters": {
    "archivalAgreement": "ArchivalAgreement",
    "originatingAgencyIdentifier": "OriginatingAgencyIdentifier",
    "comment": "Comment",
    "submissionAgencyIdentifier": "SubmissionAgencyIdentifier",
    "relatedTransferReference": [
      "RelatedTransferReference"
    ],
    "transferRequestReplyIdentifier": "TransferRequestReplyIdentifier",
    "archivalAgencyIdentifier": "ArchivalAgencyIdentifier",
    "transferringAgency": "TransferringAgency"
  },
  "dslRequest": {
    "$roots": [
      "id0"
    ],
    "$query": [
      {
        "$match": {
          "title": "titre"
        },
        "$depth": 4
      }
    ],
    "$filter": {
      "$limit": 1000,
      "$offset": 10
    },
    "$projection": {
      "$fields": {
        "#id": 1,
        "title": 1,
        "#type": 1,
        "#sector": 1,
        "#parents": 1,
        "#object": 1
      }
    }
  }
}

                    HTTP status code 202

                    Renvoie le statut de l'opération de Transfer

                    Headers

                    • X-Request-Id: required (string)

                      Unique Request Identifier

                      Example:

                      AbDUh67jj
                    • FullApiVersion: (string)

                      Complete Version of the API.

                      Example:

                      V1.25
                    • X-Application-Id: (string)

                      Session Identifier from client Front-Office Application

                      Example:

                      SESSION-ID-00001
                    • X-Tenant-Id: required (number)

                      Unique Tenant Identifier

                      Example:

                      0

                    Body

                    Media type: application/json

                    Type: StandardTypes.ErrorMultiple

                    Properties
                    • #id: required (string)

                      Id of the Operation accessible through the corresponding collection specified in "context"

                    • start_date: required (datetime)

                      Start date of the operation

                    Examples:

                    {
  "#id": "idIngests",
  "httpCode": 200,
  "code": "VitamCode",
  "context": "ingest",
  "state": "Done",
  "message": "The ingest is done, the report can be downloaded",
  "description": "The application 'Xxxx' requested an ingest operation and this operation is done.",
  "start_date": "2014-01-10T03:06:17.396Z"
}
                    {
  "#id": "idDip",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Running",
  "message": "The DIP is in progress",
  "description": "The application 'Xxxx' requested a DIP operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}

                    {
  "#id": "idDip",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Running",
  "message": "The DIP is in progress",
  "description": "The application 'Xxxx' requested a DIP operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}

                    {
  "#id": "idTransfer",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Completed",
  "message": "The Transfer is in progress",
  "description": "The application 'Xxxx' requested a Transfer operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}
                    {
  "#id": "idTransfer",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Completed",
  "message": "The Transfer is in progress",
  "description": "The application 'Xxxx' requested a Transfer operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}
                    {
  "#id": "idDip",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Running",
  "message": "The DIP is in progress",
  "description": "The application 'Xxxx' requested a DIP operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}

                    {
  "#id": "idDip",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Running",
  "message": "The DIP is in progress",
  "description": "The application 'Xxxx' requested a DIP operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}

                    {
  "#id": "idTransfer",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Completed",
  "message": "The Transfer is in progress",
  "description": "The application 'Xxxx' requested a Transfer operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}

                    HTTP status code 500

                    Renvoie ce statut en cas d'erreur interne

                    Body

                    Media type: application/json

                    Type: object

                    get

                    Télécharger le SIP généré par l'opération passée en paramètre.

                    get

                    Requête qui retourne un SIP au format ZIP 'Accept' header est 'application/octet-stream'.

                    Permissions requises:

                    • transfers:id:sip:read

                    Requête qui retourne un SIP au format ZIP 'Accept' header est 'application/octet-stream'.

                    Permissions requises:

                    • transfers:id:sip:read

                    URI Parameters

                    • id: required (string)

                      Identifiant de l'opération du transfert d'archives.

                    Headers

                    • Accept: required (application/octet-stream)

                    HTTP status code 202

                    Returns the generated SIP file

                    Body

                    Media type: application/octet-stream

                    Type: object

                    HTTP status code 412

                    Precondition Failed, some predicates are incorrect, therefore the operation is not possible

                    Body

                    Media type: application/json

                    Type: object

                    Groupe d'objet

                    API qui définit l'ensemble des requêtes sur les groupes d'objets.

                    get post

                    get

                    Requête qui retourne des résultats contenant des Groupes d'objets. La requête utilise le langage de requête DSL de type recherche multiple (SELECT MULTIPLE) de Vitam et peut utiliser l'opérateur $subobject (Voir documentation DSL) en entrée et retourne une liste d'Unités d'archives selon le DSL Vitam en cas de succès.

                    Permissions requises:

                    • objects:read
                    post

                    Requête qui retourne des résultats contenant des Groupes d'objets en utilisant le verbe POST et le header X-Http-Method-Override: GET. La requête utilise le langage de requête DSL de type recherche multiple (SELECT MULTIPLE) de Vitam et peut utiliser l'opérateur $subobject (Voir documentation DSL) en entrée et retourne une liste d'Unités d'archives selon le DSL Vitam en cas de succès.

                    Requête qui retourne des résultats contenant des Groupes d'objets en utilisant le verbe POST et le header X-Http-Method-Override: GET. La requête utilise le langage de requête DSL de type recherche multiple (SELECT MULTIPLE) de Vitam et peut utiliser l'opérateur $subobject (Voir documentation DSL) en entrée et retourne une liste d'Unités d'archives selon le DSL Vitam en cas de succès.

                    Headers

                    • X-Http-Method-Override: required (GET)
                    • X-Application-Id: (string)

                      Session Identifier from client Front-Office Application

                      Example:

                      SESSION-ID-00001
                    • X-Tenant-Id: required (number)

                      Unique Tenant Identifier.

                      Example:

                      0
                    • X-Access-Contract-Id: required (string)

                      Unique Access Contract Identifier. Allow read/write access on specific archive unit.

                      Example:

                      Access-Contract-00001
                    • X-Personal-Certificate: (string)

                      Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

                      Example:

                      MIIGfzCCBGegAwIBAgICAPcwDQYJK...
                    • Accept: required (one of application/json, application/zip, application/octet-stream)

                      Allow to specify if a result must contain only Metadata ('application/json') or only the Objects with a binary content ('application/octet-stream').

                    Body

                    Media type: application/json

                    Type: object

                    Example:

                    {
 "$query": [
   {
     "$and": [
       {
     "$match": {
       "FileInfo.FileName": "FileName.txt"
     }
       },
       {
     "$subobject": {
       "#qualifiers.versions": {
         "$and": [
           {
         "$eq": {
           "#qualifiers.versions.FormatIdentification.MimeType": "text/plain"
         }
           },
           {
         "$lte": {
           "#qualifiers.versions.Size": 20000
         }
           }
         ]
       }
     }
       }
     ]
   }
 ],
 "$projection": {},
 "$filter": {}
}

                    HTTP status code 200

                    Renvoie la liste de résultats correspondant à la requête DSL

                    Headers

                    • X-Request-Id: required (string)

                      Unique Request Identifier

                      Example:

                      AbDUh67jj
                    • FullApiVersion: (string)

                      Complete Version of the API.

                      Example:

                      V1.25
                    • X-Application-Id: (string)

                      Session Identifier from client Front-Office Application

                      Example:

                      SESSION-ID-00001
                    • X-Tenant-Id: required (number)

                      Unique Tenant Identifier

                      Example:

                      0

                    Body

                    Media type: application/json

                    Type: object

                    HTTP status code 400

                    Bad Request, syntax might be erroneous

                    Headers

                    • X-Request-Id: required (string)

                      Unique Request Identifier

                      Example:

                      AbDUh67jj
                    • FullApiVersion: (string)

                      Complete Version of the API.

                      Example:

                      V1.25
                    • X-Application-Id: (string)

                      Session Identifier from client Front-Office Application

                      Example:

                      SESSION-ID-00001
                    • X-Tenant-Id: required (number)

                      Unique Tenant Identifier

                      Example:

                      0

                    HTTP status code 401

                    Unauthorized (restricted operation), authentication in error

                    Headers

                    • X-Request-Id: required (string)

                      Unique Request Identifier

                      Example:

                      AbDUh67jj
                    • FullApiVersion: (string)

                      Complete Version of the API.

                      Example:

                      V1.25
                    • X-Application-Id: (string)

                      Session Identifier from client Front-Office Application

                      Example:

                      SESSION-ID-00001
                    • X-Tenant-Id: required (number)

                      Unique Tenant Identifier

                      Example:

                      0

                    HTTP status code 403

                    Forbidden, requested action is forbidden

                    Headers

                    • X-Request-Id: required (string)

                      Unique Request Identifier

                      Example:

                      AbDUh67jj
                    • FullApiVersion: (string)

                      Complete Version of the API.

                      Example:

                      V1.25
                    • X-Application-Id: (string)

                      Session Identifier from client Front-Office Application

                      Example:

                      SESSION-ID-00001
                    • X-Tenant-Id: required (number)

                      Unique Tenant Identifier

                      Example:

                      0

                    HTTP status code 404

                    Not Found, requested resource does not exist

                    Headers

                    • X-Request-Id: required (string)

                      Unique Request Identifier

                      Example:

                      AbDUh67jj
                    • FullApiVersion: (string)

                      Complete Version of the API.

                      Example:

                      V1.25
                    • X-Application-Id: (string)

                      Session Identifier from client Front-Office Application

                      Example:

                      SESSION-ID-00001
                    • X-Tenant-Id: required (number)

                      Unique Tenant Identifier

                      Example:

                      0

                    HTTP status code 412

                    Precondition Failed, some predicates are incorrect, therefore the operation is not possible

                    Headers

                    • X-Request-Id: required (string)

                      Unique Request Identifier

                      Example:

                      AbDUh67jj
                    • FullApiVersion: (string)

                      Complete Version of the API.

                      Example:

                      V1.25
                    • X-Application-Id: (string)

                      Session Identifier from client Front-Office Application

                      Example:

                      SESSION-ID-00001
                    • X-Tenant-Id: required (number)

                      Unique Tenant Identifier

                      Example:

                      0

                    Elimination

                    API qui définit les requêtes pour l'élimination des unités archivistiques.

                    post

                    Opération d'analyse des unités archivistiques éliminables.

                    post

                    Exécute une opération d'analyse d'élimination des unités archivistiques.

                    Permissions requises :

                    • elimination:analysis

                    Exécute une opération d'analyse d'élimination des unités archivistiques.

                    Permissions requises :

                    • elimination:analysis

                    Headers

                    • Accept: required (application/json)
                    • X-Application-Id: (string)

                      Session Identifier from client Front-Office Application

                      Example:

                      SESSION-ID-00001
                    • X-Tenant-Id: required (number)

                      Unique Tenant Identifier.

                      Example:

                      0
                    • X-Access-Contract-Id: required (string)

                      Unique Access Contract Identifier. Allow read/write access on specific archive unit.

                      Example:

                      Access-Contract-00001
                    • X-Personal-Certificate: (string)

                      Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

                      Example:

                      MIIGfzCCBGegAwIBAgICAPcwDQYJK...

                    Body

                    Media type: application/json

                    Type: object

                    Properties
                    • dslRequest: required (object)

                      Contient la requête de recherche

                      • $roots: required (array of string)

                        Contient les racines de la recherche

                      • $query: required (array of object)

                        Contient plusieurs requêtes

                      • $threshold: (integer - minimum: 1 - maximum: 100000000)

                        Contient le seuil du traitement de masse (optionnel)

                      Example:

                      {
  "$roots": [
    "guid1",
    "guid2"
  ],
  "$query": [
    {
      "$eq": {
        "myField1": "myValue"
      },
      "$depth": 4
    }
  ],
  "$threshold": 1000
}
                    • date: required (string)

                      La date d'élimination

                    Examples:

                    {
  "dslRequest": {
    "$roots": [
      "id0"
    ],
    "$query": [
      {
        "$match": {
          "title": "titre"
        },
        "$depth": 4
      }
    ],
    "$threshold": 10000
  },
  "date": "2018-01-23"
}
                    {
  "dslRequest": {
    "$roots": [ "id0" ],
    "$query": [
      {
        "$match": { "title": "titre" },
        "$depth": 4
      }
    ],
    "$threshold": 10000
  },
  "date": "2018-01-23"
}

                    {
  "dslRequest": {
    "$roots": [ "id0" ],
    "$query": [
      {
        "$match": { "title": "titre" },
        "$depth": 4
      }
    ],
    "$threshold": 10000
  },
  "date": "2018-01-23"
}

                    HTTP status code 200

                    Success

                    Body

                    Media type: application/json

                    Type: object

                    HTTP status code 202

                    Renvoie le statut de l'opération de l'élimination

                    Headers

                    • X-Request-Id: required (string)

                      Unique Request Identifier

                      Example:

                      AbDUh67jj
                    • FullApiVersion: (string)

                      Complete Version of the API.

                      Example:

                      V1.25
                    • X-Application-Id: (string)

                      Session Identifier from client Front-Office Application

                      Example:

                      SESSION-ID-00001
                    • X-Tenant-Id: required (number)

                      Unique Tenant Identifier

                      Example:

                      0

                    Body

                    Media type: application/json

                    Type: object

                    Properties
                    • httpCode: required (integer)

                      Http status code la reponse

                    Examples:

                    {
  "httpCode": 202
}
                    {
  "httpCode" : 202
}

                    {
  "httpCode" : 202
}

                    HTTP status code 412

                    Precondition Failed, some predicates are incorrect, therefore the operation is not possible

                    Body

                    Media type: application/json

                    Type: object

                    HTTP status code 500

                    Renvoie le statut final de l'opération d'élimination en KO

                    Body

                    Media type: application/json

                    Type: object

                    post

                    Opération d'élimination définitive des unités archivistiques éliminables.

                    post

                    Exécute une opération d'élimination définitive des unités archivistiques.

                    Permissions requises:

                    • elimination:action

                    Exécute une opération d'élimination définitive des unités archivistiques.

                    Permissions requises:

                    • elimination:action

                    Headers

                    • Accept: required (application/json)
                    • X-Application-Id: (string)

                      Session Identifier from client Front-Office Application

                      Example:

                      SESSION-ID-00001
                    • X-Tenant-Id: required (number)

                      Unique Tenant Identifier.

                      Example:

                      0
                    • X-Access-Contract-Id: required (string)

                      Unique Access Contract Identifier. Allow read/write access on specific archive unit.

                      Example:

                      Access-Contract-00001
                    • X-Personal-Certificate: (string)

                      Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

                      Example:

                      MIIGfzCCBGegAwIBAgICAPcwDQYJK...

                    Body

                    Media type: application/json

                    Type: object

                    Properties
                    • dslRequest: required (object)

                      Contient la requête de recherche

                      • $roots: required (array of string)

                        Contient les racines de la recherche

                      • $query: required (array of object)

                        Contient plusieurs requêtes

                      • $threshold: (integer - minimum: 1 - maximum: 100000000)

                        Contient le seuil du traitement de masse (optionnel)

                      Example:

                      {
  "$roots": [
    "guid1",
    "guid2"
  ],
  "$query": [
    {
      "$eq": {
        "myField1": "myValue"
      },
      "$depth": 4
    }
  ],
  "$threshold": 1000
}
                    • date: required (string)

                      La date d'élimination

                    Examples:

                    {
  "dslRequest": {
    "$roots": [
      "id0"
    ],
    "$query": [
      {
        "$match": {
          "title": "titre"
        },
        "$depth": 4
      }
    ],
    "$threshold": 10000
  },
  "date": "2018-01-23"
}
                    {
  "dslRequest": {
    "$roots": [ "id0" ],
    "$query": [
      {
        "$match": { "title": "titre" },
        "$depth": 4
      }
    ],
    "$threshold": 10000
  },
  "date": "2018-01-23"
}

                    {
  "dslRequest": {
    "$roots": [ "id0" ],
    "$query": [
      {
        "$match": { "title": "titre" },
        "$depth": 4
      }
    ],
    "$threshold": 10000
  },
  "date": "2018-01-23"
}

                    {
  "dslRequest": {
    "$roots": [ "id0" ],
    "$query": [
      {
        "$match": { "title": "titre" },
        "$depth": 4
      }
    ],
    "$threshold": 10000
  },
  "date": "2018-01-23"
}

                    HTTP status code 200

                    Success

                    Body

                    Media type: application/json

                    Type: object

                    HTTP status code 202

                    Renvoie le statut de l'opération de l'élimination

                    Headers

                    • X-Request-Id: required (string)

                      Unique Request Identifier

                      Example:

                      AbDUh67jj
                    • FullApiVersion: (string)

                      Complete Version of the API.

                      Example:

                      V1.25
                    • X-Application-Id: (string)

                      Session Identifier from client Front-Office Application

                      Example:

                      SESSION-ID-00001
                    • X-Tenant-Id: required (number)

                      Unique Tenant Identifier

                      Example:

                      0

                    Body

                    Media type: application/json

                    Type: object

                    Properties
                    • httpCode: required (integer)

                      Http status code la reponse

                    Examples:

                    {
  "httpCode": 202
}
                    {
  "httpCode" : 202
}

                    {
  "httpCode" : 202
}

                    {
  "httpCode" : 202
}

                    HTTP status code 412

                    Precondition Failed, some predicates are incorrect, therefore the operation is not possible

                    Body

                    Media type: application/json

                    Type: object

                    HTTP status code 500

                    Renvoie le statut final de l'opération d'élimination en KO

                    Body

                    Media type: application/json

                    Type: object

                    Journaux d'accès

                    API qui permet de lancer des actions relatives aux journaux d'accès aux objets binaires des unités archivistiques.

                    get

                    get

                    Lancer la récupération des journaux sous la forme d'un ZIP contenant des fichiers de log au format Json Lines. La requête prend en paramètre un objet Json pouvant contenir une date de début (StartDate) ou de fin (EndDate) pour filtrer les journaux.

                    Permissions requises:

                    • storageaccesslog:read:binary

                    Préservation

                    Opération de préservation des unités archivistiques.

                    post

                    post

                    Exécute une opération de préservation sur (une ou) les unités archivistiques.

                    Permissions requises:

                    • preservation:update

                    Exécute une opération de préservation sur (une ou) les unités archivistiques.

                    Permissions requises:

                    • preservation:update

                    Headers

                    • Accept: required (application/json)
                    • X-Application-Id: (string)

                      Session Identifier from client Front-Office Application

                      Example:

                      SESSION-ID-00001
                    • X-Tenant-Id: required (number)

                      Unique Tenant Identifier.

                      Example:

                      0
                    • X-Access-Contract-Id: required (string)

                      Unique Access Contract Identifier. Allow read/write access on specific archive unit.

                      Example:

                      Access-Contract-00001
                    • X-Personal-Certificate: (string)

                      Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

                      Example:

                      MIIGfzCCBGegAwIBAgICAPcwDQYJK...

                    Body

                    Media type: application/json

                    Type: object

                    Properties
                    • dslQuery: required (object)

                      Contient la requête de recherche

                      • $roots: required (array of string)

                        Contient les racines de la recherche

                      • $query: required (array of object)

                        Contient plusieurs requêtes

                      • $threshold: (integer - minimum: 1 - maximum: 100000000)

                        Contient le seuil du traitement de masse (optionnel)

                      Example:

                      {
  "$roots": [
    "guid1",
    "guid2"
  ],
  "$query": [
    {
      "$eq": {
        "myField1": "myValue"
      },
      "$depth": 4
    }
  ],
  "$threshold": 1000
}
                    • scenarioId: required (string)

                      L'identifiant du scénario de préservation

                    • targetUsage: required (string)

                      usage du binaire générer

                    • sourceUsage: required (string)

                      usage du binaire cible

                    • version: required (string)

                      La version du binaire sur lequel on veux opérer une action de préservation

                    Examples:

                    {
  "dslQuery": {
    "$roots": [],
    "$query": [
      {
        "$eq": {
          "#id": "aeaqaaaaaaezyoa6abacealifcom6xyaaaaq"
        }
      }
    ],
    "$threshold": 40
  },
  "scenarioId": "PSC-000001",
  "targetUsage": "BinaryMaster",
  "sourceUsage": "BinaryMaster",
  "version": "FIRST"
}
                    {
  "dslQuery" : {
    "$roots": [],
    "$query": [
      {
        "$eq": {
          "#id": "aeaqaaaaaaezyoa6abacealifcom6xyaaaaq"
        }
      }
    ],
    "$threshold": 40,
    "$filter": {},
    "$projection": {}
  },
  "scenarioId" : "PSC-000001",
  "targetUsage": "BinaryMaster",
  "sourceUsage": "Dissemination",
  "version": "FIRST"
}

                    {
  "dslQuery" : {
    "$roots": [],
    "$query": [
      {
        "$eq": {
          "#id": "aeaqaaaaaaezyoa6abacealifcom6xyaaaaq"
        }
      }
    ],
    "$threshold": 40,
    "$filter": {},
    "$projection": {}
  },
  "scenarioId" : "PSC-000001",
  "targetUsage": "BinaryMaster",
  "sourceUsage": "Dissemination",
  "version": "FIRST"
}

                    HTTP status code 200

                    Success

                    Body

                    Media type: application/json

                    Type: object

                    HTTP status code 202

                    Renvoie le statut de l'opération de préservation

                    Headers

                    • X-Request-Id: required (string)

                      Unique Request Identifier

                      Example:

                      AbDUh67jj
                    • FullApiVersion: (string)

                      Complete Version of the API.

                      Example:

                      V1.25
                    • X-Application-Id: (string)

                      Session Identifier from client Front-Office Application

                      Example:

                      SESSION-ID-00001
                    • X-Tenant-Id: required (number)

                      Unique Tenant Identifier

                      Example:

                      0

                    Body

                    Media type: application/json

                    Type: object

                    Properties
                    • httpCode: required (integer)

                      Http status code la reponse

                    Examples:

                    {
  "httpCode": 202
}
                    {
  "httpCode" : 202
}

                    {
  "httpCode" : 202
}

                    HTTP status code 412

                    Precondition Failed, some predicates are incorrect, therefore the operation is not possible

                    Body

                    Media type: application/json

                    Type: object

                    HTTP status code 500

                    Renvoie le statut final de l'opération de préservation en KO

                    Body

                    Media type: application/json

                    Type: object

                    Transfer Reply

                    Démarage du traitement de l'ATR adressé par le SAE cible dans le cas d'un transfert

                    post

                    post

                    Démarage du traitement de l'ATR adressé par le SAE cible dans le cas d'un transfert.

                    Permissions requises:

                    • transfers:reply

                    Démarage du traitement de l'ATR adressé par le SAE cible dans le cas d'un transfert.

                    Permissions requises:

                    • transfers:reply

                    Headers

                    • Accept: required (application/xml)
                    • Content-Type: required (application/json)
                    • X-Application-Id: (string)

                      Session Identifier from client Front-Office Application

                      Example:

                      SESSION-ID-00001
                    • X-Tenant-Id: required (number)

                      Unique Tenant Identifier.

                      Example:

                      0
                    • X-Access-Contract-Id: required (string)

                      Unique Access Contract Identifier. Allow read/write access on specific archive unit.

                      Example:

                      Access-Contract-00001
                    • X-Personal-Certificate: (string)

                      Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

                      Example:

                      MIIGfzCCBGegAwIBAgICAPcwDQYJK...

                    Body

                    Media type: application/json

                    Type: object

                    Properties
                    • exportWithLogBookLFC: (boolean)

                      True pour inclure les logbook de cycle de vie des unités archivistiques et groupes d'objets pour le DIP

                    • transferWithLogBookLFC: (boolean)

                      True pour inclure les logbook de cycle de vie des unités archivistiques et groupes d'objets pour le transfert

                    • dslRequest: required (object)

                      Contient la requête de recherche

                      • $roots: required (array of items)

                        Contient les racines de la recherche

                      • $query: required (array of items)

                        Contient plusieurs requêtes

                      • $filter: (object)

                        Contient les filtres à appliquer

                        • $offset: (integer - minimum: 1 - maximum: 100000)
                        • $limit: (integer - minimum: 1 - maximum: 100000)
                        • $orderby: (object)
                        • $projection: (object)

                          Contient la projection à appliquer

                          • $fields: (object)

                          Example:

                          {
  "$roots": [
    "guid1",
    "guid2"
  ],
  "$query": [
    {
      "$eq": {
        "myField1": "myValue"
      },
      "$depth": 4
    }
  ],
  "$filter": {
    "$limit": 100,
    "$offset": 50
  },
  "$projection": {
    "$fields": {
      "myField1": 1,
      "myField2.mySubField": 1
    }
  }
}
                        • dataObjectVersionToExport: (object)

                          L'identifiant du scénario de préservation

                          • dataObjectVersions: required (array of items)

                            Liste des versions d'objets à inclure dans l'export

                        • transferRequestParameters: required (object)

                          Les paramètres nécessaires pour faire un transfert d'unités archivistiques

                          • archivalAgreement: required (string)

                            Contrat d'entrée

                          • originatingAgencyIdentifier: required (string)

                            Identifiant du service producteur

                          • archivalAgencyIdentifier: required (string)

                            Identifiant du service d'archives

                          • comment: (string)

                            Intitulé

                          • submissionAgencyIdentifier: (string)

                            Identifiant du service versant

                          • transferringAgency: (string)

                            Service versant

                          • transferRequestReplyIdentifier: (string)

                            Identifiant de la réponse à une demande de transfert

                          • relatedTransferReference: (array of items)

                            Référence à un transfert d'archives lié

                        Example:

                        {
  "dataObjectVersionToExport": {
    "dataObjectVersions": [
      "BinaryMaster"
    ]
  },
  "transferWithLogBookLFC": true,
  "transferRequestParameters": {
    "archivalAgreement": "ArchivalAgreement",
    "originatingAgencyIdentifier": "OriginatingAgencyIdentifier",
    "comment": "Comment",
    "submissionAgencyIdentifier": "SubmissionAgencyIdentifier",
    "relatedTransferReference": [
      "RelatedTransferReference"
    ],
    "transferRequestReplyIdentifier": "TransferRequestReplyIdentifier",
    "archivalAgencyIdentifier": "ArchivalAgencyIdentifier",
    "transferringAgency": "TransferringAgency"
  },
  "dslRequest": {
    "$roots": [
      "id0"
    ],
    "$query": [
      {
        "$match": {
          "title": "titre"
        },
        "$depth": 4
      }
    ],
    "$filter": {
      "$limit": 1000,
      "$offset": 10
    },
    "$projection": {
      "$fields": {
        "#id": 1,
        "title": 1,
        "#type": 1,
        "#sector": 1,
        "#parents": 1,
        "#object": 1
      }
    }
  }
}

                        HTTP status code 200

                        Lancement du traitement

                        Body

                        Media type: application/json

                        Type: object

                        HTTP status code 202

                        Renvoie le statut de l'opération de Transfer

                        Headers

                        • X-Request-Id: required (string)

                          Unique Request Identifier

                          Example:

                          AbDUh67jj
                        • FullApiVersion: (string)

                          Complete Version of the API.

                          Example:

                          V1.25
                        • X-Application-Id: (string)

                          Session Identifier from client Front-Office Application

                          Example:

                          SESSION-ID-00001
                        • X-Tenant-Id: required (number)

                          Unique Tenant Identifier

                          Example:

                          0

                        Body

                        Media type: application/json

                        Type: StandardTypes.ErrorMultiple

                        Properties
                        • #id: required (string)

                          Id of the Operation accessible through the corresponding collection specified in "context"

                        • start_date: required (datetime)

                          Start date of the operation

                        Examples:

                        {
  "#id": "idIngests",
  "httpCode": 200,
  "code": "VitamCode",
  "context": "ingest",
  "state": "Done",
  "message": "The ingest is done, the report can be downloaded",
  "description": "The application 'Xxxx' requested an ingest operation and this operation is done.",
  "start_date": "2014-01-10T03:06:17.396Z"
}
                        {
  "#id": "idDip",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Running",
  "message": "The DIP is in progress",
  "description": "The application 'Xxxx' requested a DIP operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}

                        {
  "#id": "idDip",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Running",
  "message": "The DIP is in progress",
  "description": "The application 'Xxxx' requested a DIP operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}

                        {
  "#id": "idTransfer",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Completed",
  "message": "The Transfer is in progress",
  "description": "The application 'Xxxx' requested a Transfer operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}
                        {
  "#id": "idTransfer",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Completed",
  "message": "The Transfer is in progress",
  "description": "The application 'Xxxx' requested a Transfer operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}
                        {
  "#id": "idDip",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Running",
  "message": "The DIP is in progress",
  "description": "The application 'Xxxx' requested a DIP operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}

                        {
  "#id": "idDip",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Running",
  "message": "The DIP is in progress",
  "description": "The application 'Xxxx' requested a DIP operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}

                        {
  "#id": "idTransfer",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Completed",
  "message": "The Transfer is in progress",
  "description": "The application 'Xxxx' requested a Transfer operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}
                        {
  "#id": "idTransfer",
  "httpCode" : 202,
  "code" : "vitamcode",
  "context": "access",
  "state": "Completed",
  "message": "The Transfer is in progress",
  "description": "The application 'Xxxx' requested a Transfer operation and this operation is in progress.",
  "start_date": "2014-01-10T03:06:17.396Z"
}

                        HTTP status code 500

                        Des erreurs interne

                        Body

                        Media type: application/json

                        Type: object

                        Endpoints

                        API qui liste les endpoints de la ressource /access-external/{version}.

                        options

                        options

                        Requête qui retourne la liste des endpoints

                        Requête qui retourne la liste des endpoints

                        HTTP status code 200

                        OK, operation in success

                        Headers

                        • X-Request-Id: required (string)

                          Unique Request Identifier

                          Example:

                          AbDUh67jj
                        • FullApiVersion: (string)

                          Complete Version of the API.

                          Example:

                          V1.25
                        • X-Application-Id: (string)

                          Session Identifier from client Front-Office Application

                          Example:

                          SESSION-ID-00001
                        • X-Tenant-Id: required (number)

                          Unique Tenant Identifier

                          Example:

                          0

                        HTTP status code 404

                        Not Found, requested resource does not exist

                        Headers

                        • X-Request-Id: required (string)

                          Unique Request Identifier

                          Example:

                          AbDUh67jj
                        • FullApiVersion: (string)

                          Complete Version of the API.

                          Example:

                          V1.25
                        • X-Application-Id: (string)

                          Session Identifier from client Front-Office Application

                          Example:

                          SESSION-ID-00001
                        • X-Tenant-Id: required (number)

                          Unique Tenant Identifier

                          Example:

                          0

                        HTTP status code 503

                        Service Unavailable, the requested service is unavailable

                        /status

                        get

                        get

                        Mise à jour d'arborescence

                        API qui définit les requêtes liées à la mise à jour d'arborescence des unités archivistiques

                        post

                        post

                        Lancement d'une ou plusieurs modifications d'arborescence d'unité archivistiques

                        Lancement d'une ou plusieurs modifications d'arborescence d'unité archivistiques

                        Headers

                        • Accept: required (application/json)
                        • Content-Type: required (application/json)
                        • X-Application-Id: (string)

                          Session Identifier from client Front-Office Application

                          Example:

                          SESSION-ID-00001
                        • X-Tenant-Id: required (number)

                          Unique Tenant Identifier.

                          Example:

                          0
                        • X-Access-Contract-Id: required (string)

                          Unique Access Contract Identifier. Allow read/write access on specific archive unit.

                          Example:

                          Access-Contract-00001
                        • X-Personal-Certificate: (string)

                          Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

                          Example:

                          MIIGfzCCBGegAwIBAgICAPcwDQYJK...

                        Body

                        Media type: application/json

                        Type: array

                        Example:

                        [
  {
    "$roots": [],
    "$query": [{ "$match": { "Title": "XYZ" } }],
    "$action": [
      {
        "$pull": {
          "#unitups": [ "aeaqaaaaaafnrnfpabijualehokvjliaaaaq" ]
        },
        "$add": {
          "#unitups": [ "aeaqaaaaaafnrnfpabijualehok5n5iaaabq" ]
        }
      }
    ]
  },
  {
    "$roots": [],
    "$query": [{ "$eq": { "#id": "aeaqaaaaaafnrnfpabijualehok5n6yaaaaq" } }],
    "$action": [
      {
        "$add": {
          "#unitups": [ "aeaqaaaaaafnrnfpabijualehokvjliaaaaq" ]
        }
      }
    ]
  }
]

                        HTTP status code 202

                        Succès