# API-Vitam Version Alpha - Espace de travail interne version v1

http://workspace.internal.vitam.gouv.fr/{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
- 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

### Containers

Le principe proposé serait le suivant:

- Le Container indique une Opération (id de l'opération):
  - POST /containers
- Les clients sont responsables d'assurer la logique des Folders et des Objects c'est à dire l'arborescence
- Même si c'est autorisé, il est à réfléchir si la céation d'Objets sous un container est une bonne praitque

Questions ou remarques:

- Le /status pourrait être étendu pour avoir des informations statistiques.

### Containers

Administration des Containers (Dossiers de plus haut niveau)

#### /containers get post

get

Lecture d'items dans la collection containers.

post

Lecture d'items dans la collection containers.

#### get /containers

Lecture d'items dans la collection containers.

Secured by VitamPlatform

Based on Platform Secret

### 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: object

Example:

    {
      "query": "name='abcdef*'&since>'2015-07-14'"
    }

## 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: object

Example:

    {
      "hits": {
        "total": 10,
        "size": 3,
        "offset": 0,
        "limit": 100,
        "time_out": false,
        "next": "async_id_next"
      },
      "context": {
        "query": "name='abcdef*'&since>'2015-07-14'"
      },
      "results": [ "id1", "id2", "id3" ]
    }

## 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

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key

#### post /containers

Lecture d'items dans la collection containers.

Secured by VitamPlatform

Based on Platform Secret

### Headers

- X-Http-Method-Override: (GET)
- 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: object

Example:

    {
      "query": "name='abcdef*'&since>'2015-07-14'"
    }

## 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: object

Example:

    {
      "hits": {
        "total": 10,
        "size": 3,
        "offset": 0,
        "limit": 100,
        "time_out": false,
        "next": "async_id_next"
      },
      "context": {
        "query": "name='abcdef*'&since>'2015-07-14'"
      },
      "results": [ "id1", "id2", "id3" ]
    }

## 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

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key

#### /containers/{cid} get post head delete put

API de gestion d'un Container (Dossier).

get

Permet d'accéder aux informations d'un container

post

Permet de créer un nouveau container

head

Permet de tester l'existence du Container

delete

Permet d'effacer un Container (selon l'argument peut être récursif)

put

Permet d'uploader un ZIP ou TAR avec un unzip/untar automatique à la racine du container, incluant la création de sous-folders

#### get /containers/{cid}

Permet d'accéder aux informations d'un container

Secured by VitamPlatform

Based on Platform Secret

### URI Parameters

- cid: 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: object

Example:

    {
      "query": "name='abcdef*'&since>'2015-07-14'"
    }

## 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: object

Example:

    {
      "hits": {
        "total": 10,
        "size": 3,
        "offset": 0,
        "limit": 100,
        "time_out": false,
        "next": "async_id_next"
      },
      "context": {
        "query": "name='abcdef*'&since>'2015-07-14'"
      },
      "results": [ "id1", "id2", "id3" ]
    }

## 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

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key

#### post /containers/{cid}

Permet de créer un nouveau container

Secured by VitamPlatform

Based on Platform Secret

### URI Parameters

- cid: 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

- X-Http-Method-Override: (GET)

### Body

Media type: application/json

Type: object

Properties

- id: required(string)

  Container Id

- info: required(string)

  Associated free text information

- creation_time: required(datetime)
- last_access_time: required(datetime)
- last_modified_time: required(datetime)

Example:

    {
      "id": "abcdef",
      "info": "container description - optional",
      "creation_time": "2016-02-28T16:41:41.090Z",
      "last_access_time": "2016-02-28T16:41:41.090Z",
      "last_modified_time": "2016-02-28T16:41:41.090Z"
    }

## 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

## HTTP status code 201

Created, creation 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: object

Properties

- id: required(string)

  Container Id

- info: required(string)

  Associated free text information

- creation_time: required(datetime)
- last_access_time: required(datetime)
- last_modified_time: required(datetime)

Example:

    {
      "id": "abcdef",
      "info": "container description - optional",
      "creation_time": "2016-02-28T16:41:41.090Z",
      "last_access_time": "2016-02-28T16:41:41.090Z",
      "last_modified_time": "2016-02-28T16:41:41.090Z"
    }

## 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

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key

#### head /containers/{cid}

Permet de tester l'existence du Container

Secured by VitamPlatform

Based on Platform Secret

### URI Parameters

- cid: 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 204

No Content, Used to test existence

### 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

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key

#### delete /containers/{cid}

Permet d'effacer un Container (selon l'argument peut être récursif)

Secured by VitamPlatform

Based on Platform Secret

### URI Parameters

- cid: required(string)

### Headers

- X-Recursive: required(boolean)

  Si Vrai la destruction est récursive, sinon si non vide retourne une erreur

- 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: object

Example:

    {
      "query": "name='abcdef*'&since>'2015-07-14'"
    }

## 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: object

Example:

    {
      "hits": {
        "total": 10,
        "size": 3,
        "offset": 0,
        "limit": 100,
        "time_out": false,
        "next": "async_id_next"
      },
      "context": {
        "query": "name='abcdef*'&since>'2015-07-14'"
      },
      "results": [ "id1", "id2", "id3" ]
    }

## 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

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key

#### put /containers/{cid}

Permet d'uploader un ZIP ou TAR avec un unzip/untar automatique à la racine du container, incluant la création de sous-folders

Secured by VitamPlatform

Based on Platform Secret

### URI Parameters

- cid: required(string)

### Body

Media type: application/zip

Type: any

Media type: application/x-tar

Type: any

## HTTP status code 201

L'archive - au sens informatique - est décompressée

### Body

Media type: application/json

Type: object

Example:

    {
      "hits": {
        "total": 10,
        "size": 3,
        "offset": 0,
        "limit": 100,
        "time_out": false,
        "next": "async_id_next"
      },
      "context": {
        "query": "name='abcdef*'&since>'2015-07-14'"
      },
      "results": [ "id1", "id2", "id3" ]
    }

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key

#### /containers/{cid}/count get

Pour compter le nombre d'objets d'un container (hors dossiers)

get

Nombre d'objets binaires pour le container.

#### get /containers/{cid}/count

Nombre d'objets binaires pour le container.

Secured by VitamPlatform

Based on Platform Secret

### URI Parameters

- cid: 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

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: object

Example:

    {
      "objectNumber": 2
    }

## HTTP status code 400

Bad Request, syntax might be erroneous

### 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

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key

#### /containers/{cid}/folders get post

Pour gérer la création de sous-dossiers

get

Liste du contenu binaire pour ce container.

post

Lecture d'items dans la collection folders.

#### get /containers/{cid}/folders

Liste du contenu binaire pour ce container.

Secured by VitamPlatform

Based on Platform Secret

### URI Parameters

- cid: 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: object

Example:

    {
      "query": "name='abcdef*'&since>'2015-07-14'"
    }

## 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: object

Example:

    {
      "hits": {
        "total": 10,
        "size": 3,
        "offset": 0,
        "limit": 100,
        "time_out": false,
        "next": "async_id_next"
      },
      "context": {
        "query": "name='abcdef*'&since>'2015-07-14'"
      },
      "results": [ "id1", "id2", "id3" ]
    }

## 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

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key

#### post /containers/{cid}/folders

Lecture d'items dans la collection folders.

Secured by VitamPlatform

Based on Platform Secret

### URI Parameters

- cid: required(string)

### Headers

- X-Http-Method-Override: (GET)
- 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: object

Example:

    {
      "query": "name='abcdef*'&since>'2015-07-14'"
    }

## 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: object

Example:

    {
      "hits": {
        "total": 10,
        "size": 3,
        "offset": 0,
        "limit": 100,
        "time_out": false,
        "next": "async_id_next"
      },
      "context": {
        "query": "name='abcdef*'&since>'2015-07-14'"
      },
      "results": [ "id1", "id2", "id3" ]
    }

## 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

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key

#### /containers/{cid}/folders/{idf} get delete put post head

get

Permet d'accéder aux informations d'un folder

delete

Permet de détruire un folder

put

Permet d'uploader un ZIP ou TAR avec un unzip/untar automatique sous ce folder, incluant la création de sous-folders

post

Permet de créer un nouveau folder.

head

Permet d'obtenir des informations sur un folder

#### get /containers/{cid}/folders/{idf}

Permet d'accéder aux informations d'un folder

Secured by VitamPlatform

Based on Platform Secret

### URI Parameters

- cid: required(string)
- idf: required(string)

### Headers

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

  Seul application/json est autorisé

- X-Strategy-Id: required(string)

  Identifiant de la Stratégie pour Offres de stockage et Copies (conservation)

- 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: object

Example:

    {
      "query": "name='abcdef*'&since>'2015-07-14'"
    }

## 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: binary/octet-stream

Type: any

Example:

    Binary Sample Object File

Media type: application/json

Type: object

Properties

- id: required(string)

  Container Id

- info: required(string)

  Associated free text information

- objectGroupId: required(string)

  Id of ObjectGroup for Object only

- unitIds: required(array of string)

  Ids of Units for ObjectGroup and Object only

- creation_time: required(datetime)
- last_access_time: required(datetime)
- last_modified_time: required(datetime)
- last_checked_time: required(datetime)

Example:

    {
      "id": "abcdef",
      "info": "stored description - optional",
      "objectGroupId": "for Object",
      "unitIds": [ "for Object and ObjectGroup", "id2" ],
      "creation_time": "2016-02-28T16:41:41.090Z",
      "last_access_time": "2016-02-28T16:41:41.090Z",
      "last_modified_time": "2016-02-28T16:41:41.090Z",
      "last_checked_time": "2016-02-28T16:41:41.090Z"
    }

## 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

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key

#### delete /containers/{cid}/folders/{idf}

Permet de détruire un folder

Secured by VitamPlatform

Based on Platform Secret

### URI Parameters

- cid: required(string)
- idf: required(string)

### Headers

- X-Recursive: required(boolean)

  Si Vrai la destruction est récursive, sinon si non vide retourne une erreur

- X-digest: required(string)

  Digests value in order of Strategy, comma separated

- X-digest-algorithm: required(string)

  Digest Algorithm

- X-Strategy-Id: required(string)

  Identifiant de la Stratégie pour Offres de stockage et Copies (conservation)

- 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: object

Example:

    {
      "query": "name='abcdef*'&since>'2015-07-14'"
    }

## HTTP status code 200

OK, operation in success

### Headers

- X-Strategy: required(string)

  Strategie pour Offres de stockage et Copies (conservation)

- 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: object

Properties

- id: required(string)

  Container Id

- info: required(string)

  Associated free text information

- objectGroupId: required(string)

  Id of ObjectGroup for Object only

- unitIds: required(array of string)

  Ids of Units for ObjectGroup and Object only

- creation_time: required(datetime)
- last_access_time: required(datetime)
- last_modified_time: required(datetime)
- last_checked_time: required(datetime)

Example:

    {
      "id": "abcdef",
      "info": "stored description - optional",
      "objectGroupId": "for Object",
      "unitIds": [ "for Object and ObjectGroup", "id2" ],
      "creation_time": "2016-02-28T16:41:41.090Z",
      "last_access_time": "2016-02-28T16:41:41.090Z",
      "last_modified_time": "2016-02-28T16:41:41.090Z",
      "last_checked_time": "2016-02-28T16:41:41.090Z"
    }

## 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

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key

#### put /containers/{cid}/folders/{idf}

Permet d'uploader un ZIP ou TAR avec un unzip/untar automatique sous ce folder, incluant la création de sous-folders

Secured by VitamPlatform

Based on Platform Secret

### URI Parameters

- cid: required(string)
- idf: required(string)

### Headers

- X-Strategy-Id: required(string)

  Identifiant de la Stratégie pour Offres de stockage et Copies (conservation)

- X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

      SESSION-ID-00001

- X-Tenant-Id: (number)

  Unique Tenant Identifier

  Example:

      0

- X-Http-Method-Override: (GET)

### Body

Media type: application/zip

Type: any

Media type: application/x-tar

Type: any

Media type: multipart/form-data

Type: object

Properties

- fileUri: required(string)

  The file URI to be uploaded

## 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

## HTTP status code 201

L'archive - au sens informatique - est décompressée

### 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: object

Properties

- id: required(string)

  Container Id

- info: required(string)

  Associated free text information

- objectGroupId: required(string)

  Id of ObjectGroup for Object only

- unitIds: required(array of string)

  Ids of Units for ObjectGroup and Object only

- creation_time: required(datetime)
- last_access_time: required(datetime)
- last_modified_time: required(datetime)
- last_checked_time: required(datetime)

Example:

    {
      "id": "abcdef",
      "info": "stored description - optional",
      "objectGroupId": "for Object",
      "unitIds": [ "for Object and ObjectGroup", "id2" ],
      "creation_time": "2016-02-28T16:41:41.090Z",
      "last_access_time": "2016-02-28T16:41:41.090Z",
      "last_modified_time": "2016-02-28T16:41:41.090Z",
      "last_checked_time": "2016-02-28T16:41:41.090Z"
    }

## 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

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key

#### post /containers/{cid}/folders/{idf}

Permet de créer un nouveau folder.

Secured by VitamPlatform

Based on Platform Secret

### URI Parameters

- cid: required(string)
- idf: required(string)

### Headers

- X-Strategy-Id: required(string)

  Identifiant de la Stratégie pour Offres de stockage et Copies (conservation)

- X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

      SESSION-ID-00001

- X-Tenant-Id: (number)

  Unique Tenant Identifier

  Example:

      0

- X-Http-Method-Override: (GET)

### Body

Media type: multipart/form-data

Type: object

Properties

- objectGroupId: required(string)

  Id of the parent ObjectGroup

- unitIds: required(string)

  Ids of the parent Units, comma separated

- fileUri: required(string)

  The file URI to be uploaded

## 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

## HTTP status code 201

Created, creation 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: object

Properties

- id: required(string)

  Container Id

- info: required(string)

  Associated free text information

- objectGroupId: required(string)

  Id of ObjectGroup for Object only

- unitIds: required(array of string)

  Ids of Units for ObjectGroup and Object only

- creation_time: required(datetime)
- last_access_time: required(datetime)
- last_modified_time: required(datetime)
- last_checked_time: required(datetime)

Example:

    {
      "id": "abcdef",
      "info": "stored description - optional",
      "objectGroupId": "for Object",
      "unitIds": [ "for Object and ObjectGroup", "id2" ],
      "creation_time": "2016-02-28T16:41:41.090Z",
      "last_access_time": "2016-02-28T16:41:41.090Z",
      "last_modified_time": "2016-02-28T16:41:41.090Z",
      "last_checked_time": "2016-02-28T16:41:41.090Z"
    }

## 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

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key

#### head /containers/{cid}/folders/{idf}

Permet d'obtenir des informations sur un folder

Secured by VitamPlatform

Based on Platform Secret

### URI Parameters

- cid: required(string)
- idf: required(string)

### Headers

- X-digest-algorithm: required(string)

  Digest Algorithm

- X-Strategy-Id: required(string)

  Identifiant de la Stratégie pour Offres de stockage et Copies (conservation)

- 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

### Headers

- X-digest: required(string)

  Digests value in order of Strategy, comma separated

- X-digest-algorithm: required(string)

  Digest Algorithm

- X-Strategy: required(string)

  Strategie pour Offres de stockage et Copies (conservation)

## HTTP status code 204

No Content, Used to test existence

### 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

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key

#### /containers/{cid}/objects get post

Pour gérer la création de nouveaux Objects

get

Liste du contenu binaire pour ce container.

post

Lecture d'items dans la collection objects.

#### get /containers/{cid}/objects

Liste du contenu binaire pour ce container.

Secured by VitamPlatform

Based on Platform Secret

### URI Parameters

- cid: 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: object

Example:

    {
      "query": "name='abcdef*'&since>'2015-07-14'"
    }

## 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: object

Example:

    {
      "hits": {
        "total": 10,
        "size": 3,
        "offset": 0,
        "limit": 100,
        "time_out": false,
        "next": "async_id_next"
      },
      "context": {
        "query": "name='abcdef*'&since>'2015-07-14'"
      },
      "results": [ "id1", "id2", "id3" ]
    }

## 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

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key

#### post /containers/{cid}/objects

Lecture d'items dans la collection objects.

Secured by VitamPlatform

Based on Platform Secret

### URI Parameters

- cid: required(string)

### Headers

- X-Http-Method-Override: (GET)
- 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: object

Example:

    {
      "query": "name='abcdef*'&since>'2015-07-14'"
    }

## 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: object

Example:

    {
      "hits": {
        "total": 10,
        "size": 3,
        "offset": 0,
        "limit": 100,
        "time_out": false,
        "next": "async_id_next"
      },
      "context": {
        "query": "name='abcdef*'&since>'2015-07-14'"
      },
      "results": [ "id1", "id2", "id3" ]
    }

## 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

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key

#### /containers/{cid}/objects/{id_object} post get put head delete

post

Permet de créer une nouveau Object.

get

Permet d'accéder aux informations d'un object

put

Permet de mettre à jour un object.

head

Permet d'obtenir des informations sur un object

delete

Permet de détruire un object

#### post /containers/{cid}/objects/{id_object}

Permet de créer une nouveau Object.

Secured by VitamPlatform

Based on Platform Secret

### URI Parameters

- cid: required(string)
- id_object: required(string)

### Headers

- X-Strategy-Id: required(string)

  Identifiant de la Stratégie pour Offres de stockage et Copies (conservation)

- X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

      SESSION-ID-00001

- X-Tenant-Id: (number)

  Unique Tenant Identifier

  Example:

      0

- X-Http-Method-Override: (GET)

### Body

Media type: binary/octet-stream

Type: any

Media type: multipart/form-data

Type: object

Properties

- objectGroupId: required(string)

  Id of the parent ObjectGroup

- unitIds: required(string)

  Ids of the parent Units, comma separated

- fileUri: required(string)

  The file URI to be uploaded

## 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

## HTTP status code 201

Created, creation 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: object

Properties

- id: required(string)

  Container Id

- info: required(string)

  Associated free text information

- objectGroupId: required(string)

  Id of ObjectGroup for Object only

- unitIds: required(array of string)

  Ids of Units for ObjectGroup and Object only

- creation_time: required(datetime)
- last_access_time: required(datetime)
- last_modified_time: required(datetime)
- last_checked_time: required(datetime)

Example:

    {
      "id": "abcdef",
      "info": "stored description - optional",
      "objectGroupId": "for Object",
      "unitIds": [ "for Object and ObjectGroup", "id2" ],
      "creation_time": "2016-02-28T16:41:41.090Z",
      "last_access_time": "2016-02-28T16:41:41.090Z",
      "last_modified_time": "2016-02-28T16:41:41.090Z",
      "last_checked_time": "2016-02-28T16:41:41.090Z"
    }

## 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

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key

#### get /containers/{cid}/objects/{id_object}

Permet d'accéder aux informations d'un object

Secured by VitamPlatform

Based on Platform Secret

### URI Parameters

- cid: required(string)
- id_object: required(string)

### Headers

- X-Strategy-Id: required(string)

  Identifiant de la Stratégie pour Offres de stockage et Copies (conservation)

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

  Allow to specify if a result must contain only Metadata ('application/json'), or a complete DIP (one ZIP or TAR containing both Metadata and Binary object) ('application/zip' or 'application/x-tar') or only the Objects with a binary content ('application/octet-stream').

- 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: object

Example:

    {
      "query": "name='abcdef*'&since>'2015-07-14'"
    }

## 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: binary/octet-stream

Type: any

Example:

    Binary Sample Object File

Media type: application/json

Type: object

Properties

- id: required(string)

  Container Id

- info: required(string)

  Associated free text information

- objectGroupId: required(string)

  Id of ObjectGroup for Object only

- unitIds: required(array of string)

  Ids of Units for ObjectGroup and Object only

- creation_time: required(datetime)
- last_access_time: required(datetime)
- last_modified_time: required(datetime)
- last_checked_time: required(datetime)

Example:

    {
      "id": "abcdef",
      "info": "stored description - optional",
      "objectGroupId": "for Object",
      "unitIds": [ "for Object and ObjectGroup", "id2" ],
      "creation_time": "2016-02-28T16:41:41.090Z",
      "last_access_time": "2016-02-28T16:41:41.090Z",
      "last_modified_time": "2016-02-28T16:41:41.090Z",
      "last_checked_time": "2016-02-28T16:41:41.090Z"
    }

## 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

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key

#### put /containers/{cid}/objects/{id_object}

Permet de mettre à jour un object.

Secured by VitamPlatform

Based on Platform Secret

### URI Parameters

- cid: required(string)
- id_object: required(string)

### Headers

- X-Strategy-Id: required(string)

  Identifiant de la Stratégie pour Offres de stockage et Copies (conservation)

- X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

      SESSION-ID-00001

- X-Tenant-Id: (number)

  Unique Tenant Identifier

  Example:

      0

- X-Http-Method-Override: (GET)

### Body

Media type: multipart/form-data

Type: object

Properties

- fileUri: required(string)

  The file URI to be uploaded

## 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

## HTTP status code 201

Created, creation 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: object

Properties

- id: required(string)

  Container Id

- info: required(string)

  Associated free text information

- objectGroupId: required(string)

  Id of ObjectGroup for Object only

- unitIds: required(array of string)

  Ids of Units for ObjectGroup and Object only

- creation_time: required(datetime)
- last_access_time: required(datetime)
- last_modified_time: required(datetime)
- last_checked_time: required(datetime)

Example:

    {
      "id": "abcdef",
      "info": "stored description - optional",
      "objectGroupId": "for Object",
      "unitIds": [ "for Object and ObjectGroup", "id2" ],
      "creation_time": "2016-02-28T16:41:41.090Z",
      "last_access_time": "2016-02-28T16:41:41.090Z",
      "last_modified_time": "2016-02-28T16:41:41.090Z",
      "last_checked_time": "2016-02-28T16:41:41.090Z"
    }

## 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

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key

#### head /containers/{cid}/objects/{id_object}

Permet d'obtenir des informations sur un object

Secured by VitamPlatform

Based on Platform Secret

### URI Parameters

- cid: required(string)
- id_object: required(string)

### Headers

- X-digest-algorithm: required(string)

  Digest Algorithm

- X-Strategy-Id: required(string)

  Identifiant de la Stratégie pour Offres de stockage et Copies (conservation)

- 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

### Headers

- X-digest: required(string)

  Digests value in order of Strategy, comma separated

- X-digest-algorithm: required(string)

  Digest Algorithm

- X-Strategy: required(string)

  Strategie pour Offres de stockage et Copies (conservation)

## HTTP status code 204

No Content, Used to test existence

### 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

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key

#### delete /containers/{cid}/objects/{id_object}

Permet de détruire un object

Secured by VitamPlatform

Based on Platform Secret

### URI Parameters

- cid: required(string)
- id_object: required(string)

### Headers

- X-digest: required(string)

  Digests value in order of Strategy, comma separated

- X-digest-algorithm: required(string)

  Digest Algorithm

- X-Strategy-Id: required(string)

  Identifiant de la Stratégie pour Offres de stockage et Copies (conservation)

- 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: object

Example:

    {
      "query": "name='abcdef*'&since>'2015-07-14'"
    }

## HTTP status code 200

OK, operation in success

### Headers

- X-Strategy: required(string)

  Strategie pour Offres de stockage et Copies (conservation)

- 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: object

Properties

- id: required(string)

  Container Id

- info: required(string)

  Associated free text information

- objectGroupId: required(string)

  Id of ObjectGroup for Object only

- unitIds: required(array of string)

  Ids of Units for ObjectGroup and Object only

- creation_time: required(datetime)
- last_access_time: required(datetime)
- last_modified_time: required(datetime)
- last_checked_time: required(datetime)

Example:

    {
      "id": "abcdef",
      "info": "stored description - optional",
      "objectGroupId": "for Object",
      "unitIds": [ "for Object and ObjectGroup", "id2" ],
      "creation_time": "2016-02-28T16:41:41.090Z",
      "last_access_time": "2016-02-28T16:41:41.090Z",
      "last_modified_time": "2016-02-28T16:41:41.090Z",
      "last_checked_time": "2016-02-28T16:41:41.090Z"
    }

## 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

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key

### /status

#### /status get

get

#### get /status

Secured by VitamPlatform

Based on Platform Secret

## 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: object

Properties

- id: required(string)

  Id of the instance

- service: required(string)

  Service Name for this instance

- startDate: required(datetime)

  Date time for the start of this instance

- status: required(one of Active, Inactive, ShutdownInProgress, Unreachable)

  Status of this instance

Example:

    {
      "id": "abcdef",
      "service": "serviceName",
      "startDate": "2015-07-14T17:07:14Z",
      "status": "Active"
    }

## 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 503

Service Unavailable, the requested service is unavailable

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key