# API-Vitam Version Alpha - Administration Technique version v1

http://internal.vitam.gouv.fr/

### 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
- Non supportées : le mot clef UNSUPPORTED est indiqué et précise que cette fonctionnalité ou donnée n'est pas supportée par l'implémentaton courante

Cette version d'API présente des fonctionnalités sous différentes versions :

- Alpha : l'API est dans une première version, susceptible d'évoluer fortement
- Beta : l'API est proche de sa version stable
- Production : l'API est considérée comme "production ready"
- Deprecated : l'API est considérée comme obsolète et devrait disparaître dans une version majeure prochaine

Pour le moment, la partie /containers/{cid} des paths n'est pas encore pris en compte mais doit être ajoutée à terme.

### Licence

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

### Logbook

API des services d'administration technique fournis par le module logbook.

#### /logbook/{version}/reconstruction/operations post

Reconstruction des bases LogbookOperation, AccessionRegisterDetail et AccessionRegisterSummary à partir des sauvegardes des opérations dans les offres de stockage.

post

Exécute la reconstruction des bases LogbookOperation, AccessionRegisterDetail et AccessionRegisterSummary définies par la requête à partir des sauvegardes des opérations dans les offres de stockage.

#### post /logbook/{version}/reconstruction/operations

Exécute la reconstruction des bases LogbookOperation, AccessionRegisterDetail et AccessionRegisterSummary définies par la requête à partir des sauvegardes des opérations dans les offres de stockage.

### URI Parameters

- version: required(string)

### Headers

- X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

      SESSION-ID-00001

- X-Tenant-Id: (number)

  Unique Tenant Identifier

  Example:

      0

### Body

Media type: application/json

Type: any

Example:

    [
        {
            "tenant":0,
            "limit":500
        },
        {
            "tenant":2,
            "limit":50
        },
        {
            "tenant":9,
            "limit":100
        }
    ]

## HTTP status code 200

OK, operation in success

### Headers

- X-Request-Id: required(string)

  Unique Request Identifier

  Example:

      AbDUh67jj

- FullApiVersion: required(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: (number)

  Unique Tenant Identifier

  Example:

      0

### Body

Media type: application/json

Type: any

Example:

    [
        {
            "tenant":0,
            "status":"OK"
        },
        {
            "tenant":2,
            "status":"OK"
        },
        {
            "tenant":9,
            "status":"KO"
        }
    ]

## HTTP status code 206

Partial Content, pagination involved

### Headers

- X-Request-Id: required(string)

  Unique Request Identifier

  Example:

      AbDUh67jj

- FullApiVersion: required(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: (number)

  Unique Tenant Identifier

  Example:

      0

## HTTP status code 401

Unauthorized, authentication in error

### Headers

- X-Request-Id: required(string)

  Unique Request Identifier

  Example:

      AbDUh67jj

- FullApiVersion: required(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: (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: required(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: (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: required(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: (number)

  Unique Tenant Identifier

  Example:

      0

#### /logbook/{version}/checklogbook post

Contrôle de cohérence des journaux sur un tenant donné.

post

Vérifie la cohérence des journaux (opérations et LFC) sur un tenant donné.

#### post /logbook/{version}/checklogbook

Vérifie la cohérence des journaux (opérations et LFC) sur un tenant donné.

### URI Parameters

- version: required(string)

### Headers

- X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

      SESSION-ID-00001

- X-Tenant-Id: (number)

  Unique Tenant Identifier

  Example:

      0

## HTTP status code 200

Retourne OK en cas de succès de la cohérence

### Headers

- X-Request-Id: required(string)

  Unique Request Identifier

  Example:

      AbDUh67jj

- FullApiVersion: required(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: (number)

  Unique Tenant Identifier

  Example:

      0

## HTTP status code 206

Partial Content, pagination involved

### Headers

- X-Request-Id: required(string)

  Unique Request Identifier

  Example:

      AbDUh67jj

- FullApiVersion: required(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: (number)

  Unique Tenant Identifier

  Example:

      0

## HTTP status code 401

Unauthorized, authentication in error

### Headers

- X-Request-Id: required(string)

  Unique Request Identifier

  Example:

      AbDUh67jj

- FullApiVersion: required(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: (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: required(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: (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: required(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: (number)

  Unique Tenant Identifier

  Example:

      0

## HTTP status code 500

Retourne Internal Server Error en cas d'échec de la cohérence

### Metadata

API des services d'administration technique fournis par le module metadata.

#### /metadata/{version}/reconstruction post

Reconstruction des bases Unit, ObjectGroup, LogbookLifecycleUnit, LogbookLifecycleObjectGroup à partir des sauvegardes des Units et des ObjectGroups dans les offres de stockage.

post

Exécute la reconstruction bases Unit, ObjectGroup, LogbookLifecycleUnit, LogbookLifecycleObjectGroup définies par la requête à partir des sauvegardes des Units et des ObjectGroups dans les offres de stockage.

#### post /metadata/{version}/reconstruction

Exécute la reconstruction bases Unit, ObjectGroup, LogbookLifecycleUnit, LogbookLifecycleObjectGroup définies par la requête à partir des sauvegardes des Units et des ObjectGroups dans les offres de stockage.

### URI Parameters

- version: required(string)

### Headers

- X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

      SESSION-ID-00001

- X-Tenant-Id: (number)

  Unique Tenant Identifier

  Example:

      0

### Body

Media type: application/json

Type: any

Example:

    [
        {
            "collection":"UNIT",
            "tenant":0,
            "limit":100
        },
        {
            "collection":"OBJECTGROUP",
            "tenant":0,
            "limit":100
        },
        {
            "collection":"UNIT",
            "tenant":1,
            "limit":100
        },
        {
            "collection":"UNIT",
            "tenant":2,
            "limit":100
        },
        {
            "collection":"OBJECTGROUP",
            "tenant":2,
            "limit":100
        }
    ]

## HTTP status code 200

OK, operation in success

### Headers

- X-Request-Id: required(string)

  Unique Request Identifier

  Example:

      AbDUh67jj

- FullApiVersion: required(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: (number)

  Unique Tenant Identifier

  Example:

      0

### Body

Media type: application/json

Type: any

Example:

    [
        {
            "collection":"UNIT",
            "tenant":0,
            "status":"OK"
        },
        {
            "collection":"OBJECTGROUP",
            "tenant":0,
            "status":"OK"
        },
        {
            "collection":"UNIT",
            "tenant":1,
            "status":"KO"
        },
        {
            "collection":"UNIT",
            "tenant":2,
            "status":"OK"
        },
        {
            "collection":"OBJECTGROUP",
            "tenant":2,
            "status":"OK"
        }
    ]

## HTTP status code 206

Partial Content, pagination involved

### Headers

- X-Request-Id: required(string)

  Unique Request Identifier

  Example:

      AbDUh67jj

- FullApiVersion: required(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: (number)

  Unique Tenant Identifier

  Example:

      0

## HTTP status code 401

Unauthorized, authentication in error

### Headers

- X-Request-Id: required(string)

  Unique Request Identifier

  Example:

      AbDUh67jj

- FullApiVersion: required(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: (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: required(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: (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: required(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: (number)

  Unique Tenant Identifier

  Example:

      0