# API-Vitam Version Alpha - Internal Offer version v1

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

### Objects operations

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

#### /objects/{type} get

API de gestion des objects.

get

Pour obtenir les informations sur la collection des objets

#### get /objects/{type}

Pour obtenir les informations sur la collection des objets

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

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

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

#### /objects/{type}/logs get

Logs de l'offre définis par le conteneur

get

Recherche de logs de l'offre définis par le conteneur.

#### get /objects/{type}/logs

Recherche de logs de l'offre définis par le conteneur.

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

#### /objects/{type}/count get

Compte le nombre d'objets

get

Compte le nombre d'objets pour ce tenant.

#### get /objects/{type}/count

Compte le nombre d'objets pour ce tenant.

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

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

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

#### /objects/{type}/{id_object} head get post put delete

head

Vérifie l'existance et la cohérence d'un objet.

get

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

post

Permet de créer un nouveau object.

put

Permet de mettre à jour un object.

delete

Permet de détruire un object

#### head /objects/{type}/{id_object}

Vérifie l'existance et la cohérence d'un objet.

Secured by VitamPlatform

Based on Platform Secret

### URI Parameters

- type: required(string)
- id_object: required(string)

### Headers

- X-digest-algorithm: (string)

  Digest Algorithm

- X-Tenant-Id: required(number)

  Identifiant unique du tenant

  Example:

      0

- X-digest: (string)

  Empreinte du digest - Requis pour la validation digest

- X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

      SESSION-ID-00001

- X-Strategy-Id: required(string)

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

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

#### get /objects/{type}/{id_object}

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

Secured by VitamPlatform

Based on Platform Secret

### URI Parameters

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

#### post /objects/{type}/{id_object}

Permet de créer un nouveau object.

Secured by VitamPlatform

Based on Platform Secret

### URI Parameters

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

#### put /objects/{type}/{id_object}

Permet de mettre à jour un object.

Secured by VitamPlatform

Based on Platform Secret

### URI Parameters

- type: required(string)
- id_object: required(string)

### Headers

- X-Strategy-Id: required(string)

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

- X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

      SESSION-ID-00001

- X-Tenant-Id: (number)

  Unique Tenant Identifier

  Example:

      0

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

### Body

Media type: multipart/form-data

Type: object

Properties

- fileUri: required(string)

  The file URI to be uploaded

## HTTP status code 200

OK, operation in success

### Headers

- X-Request-Id: required(string)

  Unique Request Identifier

  Example:

      AbDUh67jj

- FullApiVersion: required(string)

  Complete Version of the API.

  Example:

      V1.25

- X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

      SESSION-ID-00001

- X-Tenant-Id: (number)

  Unique Tenant Identifier

  Example:

      0

## HTTP status code 201

Created, creation operation in success

### Headers

- X-Request-Id: required(string)

  Unique Request Identifier

  Example:

      AbDUh67jj

- FullApiVersion: required(string)

  Complete Version of the API.

  Example:

      V1.25

- X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

      SESSION-ID-00001

- X-Tenant-Id: (number)

  Unique Tenant Identifier

  Example:

      0

### Body

Media type: application/json

Type: object

Properties

- id: required(string)

  Container Id

- info: required(string)

  Associated free text information

- objectGroupId: required(string)

  Id of ObjectGroup for Object only

- unitIds: required(array of string)

  Ids of Units for ObjectGroup and Object only

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

Example:

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

## HTTP status code 401

Unauthorized, authentication in error

### Headers

- X-Request-Id: required(string)

  Unique Request Identifier

  Example:

      AbDUh67jj

- FullApiVersion: required(string)

  Complete Version of the API.

  Example:

      V1.25

- X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

      SESSION-ID-00001

- X-Tenant-Id: (number)

  Unique Tenant Identifier

  Example:

      0

## HTTP status code 404

Not Found, requested resource does not exist

### Headers

- X-Request-Id: required(string)

  Unique Request Identifier

  Example:

      AbDUh67jj

- FullApiVersion: required(string)

  Complete Version of the API.

  Example:

      V1.25

- X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

      SESSION-ID-00001

- X-Tenant-Id: (number)

  Unique Tenant Identifier

  Example:

      0

## HTTP status code 412

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

### Headers

- X-Request-Id: required(string)

  Unique Request Identifier

  Example:

      AbDUh67jj

- FullApiVersion: required(string)

  Complete Version of the API.

  Example:

      V1.25

- X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

      SESSION-ID-00001

- X-Tenant-Id: (number)

  Unique Tenant Identifier

  Example:

      0

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key

#### delete /objects/{type}/{id_object}

Permet de détruire un object

Secured by VitamPlatform

Based on Platform Secret

### URI Parameters

- type: required(string)
- id_object: required(string)

### Headers

- X-digest: required(string)

  Digests value in order of Strategy, comma separated

- X-digest-algorithm: required(string)

  Digest Algorithm

- X-Strategy-Id: required(string)

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

- X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

      SESSION-ID-00001

- X-Tenant-Id: (number)

  Unique Tenant Identifier

  Example:

      0

### Body

Media type: application/json

Type: object

Example:

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

## HTTP status code 200

OK, operation in success

### Headers

- X-Strategy: required(string)

  Strategie pour Offres de stockage et Copies (conservation)

- X-Request-Id: required(string)

  Unique Request Identifier

  Example:

      AbDUh67jj

- FullApiVersion: required(string)

  Complete Version of the API.

  Example:

      V1.25

- X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

      SESSION-ID-00001

- X-Tenant-Id: (number)

  Unique Tenant Identifier

  Example:

      0

### Body

Media type: application/json

Type: object

Properties

- id: required(string)

  Container Id

- info: required(string)

  Associated free text information

- objectGroupId: required(string)

  Id of ObjectGroup for Object only

- unitIds: required(array of string)

  Ids of Units for ObjectGroup and Object only

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

Example:

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

## HTTP status code 401

Unauthorized, authentication in error

### Headers

- X-Request-Id: required(string)

  Unique Request Identifier

  Example:

      AbDUh67jj

- FullApiVersion: required(string)

  Complete Version of the API.

  Example:

      V1.25

- X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

      SESSION-ID-00001

- X-Tenant-Id: (number)

  Unique Tenant Identifier

  Example:

      0

## HTTP status code 404

Not Found, requested resource does not exist

### Headers

- X-Request-Id: required(string)

  Unique Request Identifier

  Example:

      AbDUh67jj

- FullApiVersion: required(string)

  Complete Version of the API.

  Example:

      V1.25

- X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

      SESSION-ID-00001

- X-Tenant-Id: (number)

  Unique Tenant Identifier

  Example:

      0

## HTTP status code 412

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

### Headers

- X-Request-Id: required(string)

  Unique Request Identifier

  Example:

      AbDUh67jj

- FullApiVersion: required(string)

  Complete Version of the API.

  Example:

      V1.25

- X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

      SESSION-ID-00001

- X-Tenant-Id: (number)

  Unique Tenant Identifier

  Example:

      0

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key

### /status

#### /status get

get

#### get /status

Secured by VitamPlatform

Based on Platform Secret

## HTTP status code 200

OK, operation in success

### Headers

- X-Request-Id: required(string)

  Unique Request Identifier

  Example:

      AbDUh67jj

- FullApiVersion: required(string)

  Complete Version of the API.

  Example:

      V1.25

- X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

      SESSION-ID-00001

- X-Tenant-Id: (number)

  Unique Tenant Identifier

  Example:

      0

### Body

Media type: application/json

Type: object

Properties

- id: required(string)

  Id of the instance

- service: required(string)

  Service Name for this instance

- startDate: required(datetime)

  Date time for the start of this instance

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

  Status of this instance

Example:

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

## HTTP status code 401

Unauthorized, authentication in error

### Headers

- X-Request-Id: required(string)

  Unique Request Identifier

  Example:

      AbDUh67jj

- FullApiVersion: required(string)

  Complete Version of the API.

  Example:

      V1.25

- X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

      SESSION-ID-00001

- X-Tenant-Id: (number)

  Unique Tenant Identifier

  Example:

      0

## HTTP status code 404

Not Found, requested resource does not exist

### Headers

- X-Request-Id: required(string)

  Unique Request Identifier

  Example:

      AbDUh67jj

- FullApiVersion: required(string)

  Complete Version of the API.

  Example:

      V1.25

- X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

      SESSION-ID-00001

- X-Tenant-Id: (number)

  Unique Tenant Identifier

  Example:

      0

## HTTP status code 503

Service Unavailable, the requested service is unavailable

# Secured by VitamPlatform

### Headers

- X-Vitam-Key: required(string)

  Vitam Platform Key