API-Vitam Version Alpha - Storage interne version v1

http://storage.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:

Accès principal au travers d'un Container = Tenant
3 types sous-jacents:
- Objects: pour les éléments binaires (non modifiable = WORM)
- Logbooks: pour les journaux (tous) (non modifiable = WORM)
- Metadatas: pour les Units et ObjectGroups (modifiable = WMRM => PUT)

Questions ou remarques:

Le moteur de stockage est responsable de mettre le "Folder" sous-jacent nécessaire pour séparer les types.

Tenants as Containers

Administration des Containers (Dossiers pour un Tenant)

/containers get post

get

Lecture d'items dans la collection containers.

post

Lecture d'items dans la collection containers.

Secured by VitamPlatform

Based on Platform Secret

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

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

Lecture d'items dans la collection containers.

Secured by VitamPlatform

Based on Platform Secret

Headers

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

API de gestion d'un Container (Tenant).

get

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

post

Permet de créer un nouveau container (nouveau tenant)

head

Permet de tester l'existence du Container

delete

Permet d'effacer un Container (si vide)

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

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

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

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

Permet de créer un nouveau container (nouveau tenant)

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

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

Permet de tester l'existence du Container

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

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

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

Permet d'effacer un Container (si vide)

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

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

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 get post

Pour gérer la création de nouveaux Objects, sur la base d'une stratégie de stockage à appliquer

get

Liste du contenu binaire pour ce tenant.

post

Lecture d'items dans la collection objects.

Liste du contenu binaire pour ce tenant.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

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

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

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-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: 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} get post head delete

get

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

post

Permet de créer un nouveau object.

head

Permet d'obtenir des informations sur un object

delete

Permet de détruire un 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

Permet de créer un 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: 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

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

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

/containers/{cid}/reports get post

Pour gérer la création de nouveaux Rapports (exemple : ArchiveTransferReply), sur la base d'une stratégie de stockage à appliquer

get

Liste du contenu binaire pour ce tenant.

post

Lecture d'items dans la collection reports.

Liste du contenu binaire pour ce tenant.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

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

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

Lecture d'items dans la collection reports.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)

Headers

X-Http-Method-Override: (GET)
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: 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}/reports/{id_logbook} get post head delete

get

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

post

Permet de créer un nouveau report.

head

Permet d'obtenir des informations sur un report

delete

Permet de détruire un report

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

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_logbook: 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

Permet de créer un nouveau report.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_logbook: 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

Permet d'obtenir des informations sur un report

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_logbook: 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

Permet de détruire un report

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_logbook: 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

/containers/{cid}/logbooks get post

Pour gérer la création de nouveaux Journaux, sur la base d'une stratégie de stockage à appliquer

get

Liste du contenu binaire pour ce tenant.

post

Lecture d'items dans la collection logbooks.

Liste du contenu binaire pour ce tenant.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

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

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

Lecture d'items dans la collection logbooks.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)

Headers

X-Http-Method-Override: (GET)
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: 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}/logbooks/{id_logbook} get post head delete

get

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

post

Permet de créer un nouveau logbook.

head

Permet d'obtenir des informations sur un logbook

delete

Permet de détruire un logbook

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

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_logbook: 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

Permet de créer un nouveau logbook.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_logbook: 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

Permet d'obtenir des informations sur un logbook

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_logbook: 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

Permet de détruire un logbook

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_logbook: 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

/containers/{cid}/lifecycleunits get post

Pour gérer la création de nouveaux Journaux, sur la base d'une stratégie de stockage à appliquer

get

Liste du contenu binaire pour ce tenant.

post

Lecture d'items dans la collection lifecycleunits.

Liste du contenu binaire pour ce tenant.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

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

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

Lecture d'items dans la collection lifecycleunits.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)

Headers

X-Http-Method-Override: (GET)
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: 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}/lifecycleunits/{id_logbook} get post put head delete

get

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

post

Permet de créer un nouveau lifecycleunit.

put

Permet de mettre à jour un lifecycleunit.

head

Permet d'obtenir des informations sur un lifecycleunit

delete

Permet de détruire un lifecycleunit

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

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_logbook: 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

Permet de créer un nouveau lifecycleunit.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_logbook: 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

Permet de mettre à jour un lifecycleunit.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_logbook: 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

Permet d'obtenir des informations sur un lifecycleunit

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_logbook: 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

Permet de détruire un lifecycleunit

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_logbook: 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

/containers/{cid}/lifecycleobjects get post

Pour gérer la création de nouveaux Journaux, sur la base d'une stratégie de stockage à appliquer

get

Liste du contenu binaire pour ce tenant.

post

Lecture d'items dans la collection lifecycleobjects.

Liste du contenu binaire pour ce tenant.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

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

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

Lecture d'items dans la collection lifecycleobjects.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)

Headers

X-Http-Method-Override: (GET)
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: 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}/lifecycleobjects/{id_logbook} get post put head delete

get

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

post

Permet de créer un nouveau lifecycleobject.

put

Permet de mettre à jour un lifecycleobject.

head

Permet d'obtenir des informations sur un lifecycleobject

delete

Permet de détruire un lifecycleobject

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

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_logbook: 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

Permet de créer un nouveau lifecycleobject.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_logbook: 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

Permet de mettre à jour un lifecycleobject.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_logbook: 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

Permet d'obtenir des informations sur un lifecycleobject

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_logbook: 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

Permet de détruire un lifecycleobject

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_logbook: 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

/containers/{cid}/units get post

Pour gérer la création de nouvelles Units, sur la base d'une stratégie de stockage à appliquer

get

Liste du contenu binaire pour ce tenant.

post

Lecture d'items dans la collection units.

Liste du contenu binaire pour ce tenant.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

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

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

Lecture d'items dans la collection units.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)

Headers

X-Http-Method-Override: (GET)
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: 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}/units/{id_md} get post put head delete

get

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

post

Permet de créer un nouveau unit.

put

Permet de mettre à jour un unit.

head

Permet d'obtenir des informations sur un unit

delete

Permet de détruire un unit

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

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_md: 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

Permet de créer un nouveau unit.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_md: 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

Permet de mettre à jour un unit.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_md: 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

Permet d'obtenir des informations sur un unit

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_md: 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

Permet de détruire un unit

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_md: 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

/containers/{cid}/objectgroups get post

Pour gérer la création de nouveaux ObjectGroup, sur la base d'une stratégie de stockage à appliquer

get

Liste du contenu binaire pour ce tenant.

post

Lecture d'items dans la collection objectgroups.

Liste du contenu binaire pour ce tenant.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

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

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

Lecture d'items dans la collection objectgroups.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)

Headers

X-Http-Method-Override: (GET)
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: 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}/objectgroups/{id_md} get post put head delete

get

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

post

Permet de créer un nouveau objectgroup.

put

Permet de mettre à jour un objectgroup.

head

Permet d'obtenir des informations sur un objectgroup

delete

Permet de détruire un objectgroup

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

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_md: 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

Permet de créer un nouveau objectgroup.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_md: 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

Permet de mettre à jour un objectgroup.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_md: 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

Permet d'obtenir des informations sur un objectgroup

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_md: 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

Permet de détruire un objectgroup

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_md: 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

/containers/{cid}/manifests get post

Pour gérer la création de nouveaux fichiers manifest, sur la base d'une stratégie de stockage à appliquer

get

Liste du contenu binaire pour ce tenant.

post

Lecture d'items dans la collection manifests.

Liste du contenu binaire pour ce tenant.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

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

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

Lecture d'items dans la collection manifests.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)

Headers

X-Http-Method-Override: (GET)
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: 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}/manifests/{id_md} get post head delete

get

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

post

Permet de créer un nouveau manifest.

head

Permet d'obtenir des informations sur un manifest

delete

Permet de détruire un manifest

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

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_md: 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

Permet de créer un nouveau manifest.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_md: 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

Permet d'obtenir des informations sur un manifest

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_md: 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

Permet de détruire un manifest

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

cid: required(string)
id_md: 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

Sauvegarde des logs du storage par tenant

Sert à sauvegarder les logs d'accès au moteur de stokage

/storage/backup post

post

Sauvegarder les fichiers de logs par tenant. Les logs sont archivés puis stockés à travers le moteur de stockage

Secured by VitamPlatform

Based on Platform Secret

Headers

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

Sécurisation (traçabilité) des logs du storage par tenant

Sert à sécuriser les logs d'accès au moteur de stokage

/storage/traceability post

post

Sécuriser les fichiers de logs du storage archivés par tenant.

Secured by VitamPlatform

Based on Platform Secret

Headers

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

Offer logs

Accès au logs de l'offre de stockage référente d'une stratégie

/{type}/logs get

get

Recherche des logs de l'offre de stockage reférente pour la stratégie

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

type: 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
```

Body

Media type: application/json

Type: object

Properties

offset: (number)
Offset
limit: (number)
Limit
order: required(string)
Order

Example:

{
    "offset":0,
    "limit":3,
    "order":"ASC"
}

HTTP status code 200

Storage logs

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": 3,
      "size": 3,
      "offset": 0,
      "limit": 3
    },
    "$context": {},
    "$results": [
        {
            "Sequence": 3,
            "Time": "2018-02-26T09:26:39.665",
            "Container": "1_backup_operation",
            "FileName": "aecaaaaaaggem7dyaa7hgalb2fxxdtaaaaaq",
            "Action": "write"
        },{
            "Sequence": 4,
            "Time": "2018-02-26T09:28:39.665",
            "Container": "1_backup_operation",
            "FileName": "aecaaaaaaggem7dyaa7hgalb2fxxdtaaaaaq",
            "Action": "write"
        },{
            "Sequence": 9,
            "Time": "2018-02-26T09:29:24.869",
            "Container": "1_backup_operation",
            "FileName": "aecaaaaaaggem7dyaa7hgalb2fy76bqaaaaq",
            "Action": "write"
        }
    ]
  }

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

Secured by VitamPlatform

Based on Platform Secret

Response
Security

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

API-Vitam Version Alpha - Storage interne version v1

Avertissements

Licence

Containers

Tenants as Containers

/containers get post

get /containers

Headers

Body

HTTP status code 200

Headers

Body

HTTP status code 401

Headers

HTTP status code 404

Headers

HTTP status code 412

Headers

Secured by VitamPlatform

Headers

post /containers

Headers

Body

HTTP status code 200

Headers

Body

HTTP status code 401

Headers

HTTP status code 404

Headers

HTTP status code 412

Headers

Secured by VitamPlatform

Headers

/containers/{cid} get post head delete

get /containers/{cid}

URI Parameters

Headers

Body

HTTP status code 200

Headers

Body

HTTP status code 401

Headers

HTTP status code 404

Headers

HTTP status code 412

Headers

Secured by VitamPlatform

Headers

post /containers/{cid}

URI Parameters

Headers

Body

HTTP status code 200

Headers

HTTP status code 201

Headers

Body

HTTP status code 401

Headers

HTTP status code 404

Headers

HTTP status code 412

Headers

Secured by VitamPlatform

Headers

head /containers/{cid}

URI Parameters

Headers

HTTP status code 204

Headers

HTTP status code 401

Headers

HTTP status code 404

Headers

HTTP status code 412

Headers

Secured by VitamPlatform

Headers