API-Vitam Version Alpha - Administration Management interne API documentation version v1

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

API Administration

L'API d'administration fonctionnelle propose les points d'entrées et les méthodes pour requêter et récupérer les informations des collections suivantes :

Référentiel des Formats basé sur PRONOM (TNA)
Référentiel des Règles de Gestion
Registre des Fonds

Cette API est dans une étape de création, elle est donc en statut Alpha.

Référentiel des Formats

Ce référentiel est basé sur PRONOM (TNA) mais il peut être étendu.

L'extension est à ce jour non supporté (UNSUPPORTED)
Il est possible de mettre à jour ce référentiel via les API.
- Notez cependant que la mise à jour des outils utilisant ce référentiel n'est pas encore opérationnel. Il n'est donc pas recommandé de mettre à jour ce référentiel avec une autre version que celle livrée par Vitam.

Référentiel des Règles de Gestion

Il est possible de mettre à jour ce référentiel via les API.

Actuellement ce référentiel est utilisé lors du processus d'entrée mais il n'est pas encore utilisé par les accès.

Registre des Fonds

Celui-ci est alimenté automatiquement par le processus d'entrée.

Dans des versions ultérieures, il sera possible de procéder à la création de Fonds de manière anticipées, en utilisant les contrats de versements pour gérer les affectations.

FileFormats

API qui définit les requêtes pour accéder au référentiels des Formats. La requête utilise le langage de requête (DSL) de Vitam en entrée et retourne une liste de formats selon le DSL Vitam en cas de succès.

/formats get post put

get

Request that will return results composed of Formats

post

Request that will return results composed of Formats if the request is using POST with X-Http-Method-Override: GET. If there is no X-Http-Method-Override, this allow to push a new Referential from a PRONOM source file (see TNA).

put

This allow to submit a new Referential from a PRONOM source file (see TNA) to check if this could be imported.

Request that will return results composed of Formats

Secured by VitamPlatform

Based on Platform Secret

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
```
0
```
X-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
$filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $per_page: (integer - minimum: 1 - maximum: 100)
- $orderby: (object)
- $hint: (one of null, cache, nocache)
$projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
$data: (object)
Contains data to insert (for POST only)
$facetQuery: (object)
Contains facet to apply (for GET only)
$action: (array of object)
Contains actions to apply as update (for PUT only)

Examples:

{
  "$query": {
    "$path": "aaaaa"
  }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

HTTP status code 200

Returns the list of matching Formats

Headers

X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

$hits: required (object)
Contains the hits for the response
- total: required (integer)
  Total estimated possible answears
- offset: required (integer)
  Offset on possible answears
- limit: required (integer)
  Limit specified in the request (or implicit) from Offset
- size: required (integer)
  Number of currently returned answears
- time_out: (boolean)
  True means the request was too long and so only partial result could be retrieved
$context: required (object)
Contains Request related to this to reply
- $query: required (object)
  Contains one query
- $filter: (object)
  Contains filter to apply (for GET only)
  - $offset: (integer - minimum: 1 - maximum: 100000)
  - $limit: (integer - minimum: 1 - maximum: 100000)
  - $per_page: (integer - minimum: 1 - maximum: 100)
  - $orderby: (object)
  - $hint: (one of null, cache, nocache)
- $projection: (object)
  Contains projection to apply (for GET only)
  - $fields: (object)
  - $usage: (string)
- $data: (object)
  Contains data to insert (for POST only)
- $facetQuery: (object)
  Contains facet to apply (for GET only)
- $action: (array of object)
  Contains actions to apply as update (for PUT only)
Example:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array of object)
Contains list of items
$facet: (object)
Contains facet if requested

Example:

{
  "$hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$query": {
      "$path": "aaaaa"
    }
  },
  "$results": [
    {
      "#id": "id1"
    },
    {
      "#id": "id2"
    },
    {
      "#id": "id3"
    }
  ]
}

HTTP status code 206

UNSUPPORTED Returns the list of matching Formats using Cursor

Headers

X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id
X-Cursor-Timeout: (datetime)
When X-Cursor-Id is present, it specifies the date and time limit of the availability of this cursor Id
X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

$hits: required (object)
Contains the hits for the response
- total: required (integer)
  Total estimated possible answears
- offset: required (integer)
  Offset on possible answears
- limit: required (integer)
  Limit specified in the request (or implicit) from Offset
- size: required (integer)
  Number of currently returned answears
- time_out: (boolean)
  True means the request was too long and so only partial result could be retrieved
$context: required (object)
Contains Request related to this to reply
- $query: required (object)
  Contains one query
- $filter: (object)
  Contains filter to apply (for GET only)
  - $offset: (integer - minimum: 1 - maximum: 100000)
  - $limit: (integer - minimum: 1 - maximum: 100000)
  - $per_page: (integer - minimum: 1 - maximum: 100)
  - $orderby: (object)
  - $hint: (one of null, cache, nocache)
- $projection: (object)
  Contains projection to apply (for GET only)
  - $fields: (object)
  - $usage: (string)
- $data: (object)
  Contains data to insert (for POST only)
- $facetQuery: (object)
  Contains facet to apply (for GET only)
- $action: (array of object)
  Contains actions to apply as update (for PUT only)
Example:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array of object)
Contains list of items
$facet: (object)
Contains facet if requested

Example:

{
  "$hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$query": {
      "$path": "aaaaa"
    }
  },
  "$results": [
    {
      "#id": "id1"
    },
    {
      "#id": "id2"
    },
    {
      "#id": "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

Secured by VitamPlatform

Based on Platform Secret

Headers

X-Http-Method-Override: (GET)
X-Filename: (string)
Name of the file uploaded
Example:
```
Rules_v5.csv
```
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-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
$filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $per_page: (integer - minimum: 1 - maximum: 100)
- $orderby: (object)
- $hint: (one of null, cache, nocache)
$projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
$data: (object)
Contains data to insert (for POST only)
$facetQuery: (object)
Contains facet to apply (for GET only)
$action: (array of object)
Contains actions to apply as update (for PUT only)

Examples:

{
  "$query": {
    "$path": "aaaaa"
  }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

Media type: application/xml

Type: object

Media type: application/csv

Type: object

HTTP status code 200

Returns the list of matching Formats

Headers

X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

$hits: required (object)
Contains the hits for the response
- total: required (integer)
  Total estimated possible answears
- offset: required (integer)
  Offset on possible answears
- limit: required (integer)
  Limit specified in the request (or implicit) from Offset
- size: required (integer)
  Number of currently returned answears
- time_out: (boolean)
  True means the request was too long and so only partial result could be retrieved
$context: required (object)
Contains Request related to this to reply
- $query: required (object)
  Contains one query
- $filter: (object)
  Contains filter to apply (for GET only)
  - $offset: (integer - minimum: 1 - maximum: 100000)
  - $limit: (integer - minimum: 1 - maximum: 100000)
  - $per_page: (integer - minimum: 1 - maximum: 100)
  - $orderby: (object)
  - $hint: (one of null, cache, nocache)
- $projection: (object)
  Contains projection to apply (for GET only)
  - $fields: (object)
  - $usage: (string)
- $data: (object)
  Contains data to insert (for POST only)
- $facetQuery: (object)
  Contains facet to apply (for GET only)
- $action: (array of object)
  Contains actions to apply as update (for PUT only)
Example:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array of object)
Contains list of items
$facet: (object)
Contains facet if requested

Example:

{
  "$hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$query": {
      "$path": "aaaaa"
    }
  },
  "$results": [
    {
      "#id": "id1"
    },
    {
      "#id": "id2"
    },
    {
      "#id": "id3"
    }
  ]
}

HTTP status code 206

UNSUPPORTED Returns the list of matching Formats using Cursor

Headers

X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id
X-Cursor-Timeout: (datetime)
When X-Cursor-Id is present, it specifies the date and time limit of the availability of this cursor Id
X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

$hits: required (object)
Contains the hits for the response
- total: required (integer)
  Total estimated possible answears
- offset: required (integer)
  Offset on possible answears
- limit: required (integer)
  Limit specified in the request (or implicit) from Offset
- size: required (integer)
  Number of currently returned answears
- time_out: (boolean)
  True means the request was too long and so only partial result could be retrieved
$context: required (object)
Contains Request related to this to reply
- $query: required (object)
  Contains one query
- $filter: (object)
  Contains filter to apply (for GET only)
  - $offset: (integer - minimum: 1 - maximum: 100000)
  - $limit: (integer - minimum: 1 - maximum: 100000)
  - $per_page: (integer - minimum: 1 - maximum: 100)
  - $orderby: (object)
  - $hint: (one of null, cache, nocache)
- $projection: (object)
  Contains projection to apply (for GET only)
  - $fields: (object)
  - $usage: (string)
- $data: (object)
  Contains data to insert (for POST only)
- $facetQuery: (object)
  Contains facet to apply (for GET only)
- $action: (array of object)
  Contains actions to apply as update (for PUT only)
Example:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array of object)
Contains list of items
$facet: (object)
Contains facet if requested

Example:

{
  "$hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$query": {
      "$path": "aaaaa"
    }
  },
  "$results": [
    {
      "#id": "id1"
    },
    {
      "#id": "id2"
    },
    {
      "#id": "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

This allow to submit a new Referential from a PRONOM source file (see TNA) to check if this could be imported.

Secured by VitamPlatform

Based on Platform Secret

Headers

X-Http-Method-Override: (string)
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/xml

Type: object

Media type: application/csv

Type: object

HTTP status code 200

Returns if upload or check of Formats is OK

Headers

X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

/formats/{idu} get post

API qui définit les requêtes pour accéder à 1 format dans le référentiel des Formats.

get

Request that will return result composed of 1 Format

post

Request that will return result of 1 Format. The request is using POST with X-Http-Method-Override: GET

Request that will return result composed of 1 Format

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

idu: required (string)

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
```
0
```

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
$filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $per_page: (integer - minimum: 1 - maximum: 100)
- $orderby: (object)
- $hint: (one of null, cache, nocache)
$projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
$data: (object)
Contains data to insert (for POST only)
$facetQuery: (object)
Contains facet to apply (for GET only)
$action: (array of object)
Contains actions to apply as update (for PUT only)

Examples:

{
  "$query": {
    "$path": "aaaaa"
  }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

HTTP status code 200

Returns one Formats item

Headers

X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

$hits: required (object)
Contains the hits for the response
- total: required (integer)
  Total estimated possible answears
- offset: required (integer)
  Offset on possible answears
- limit: required (integer)
  Limit specified in the request (or implicit) from Offset
- size: required (integer)
  Number of currently returned answears
- time_out: (boolean)
  True means the request was too long and so only partial result could be retrieved
$context: required (object)
Contains Request related to this to reply
- $query: required (object)
  Contains one query
- $filter: (object)
  Contains filter to apply (for GET only)
  - $offset: (integer - minimum: 1 - maximum: 100000)
  - $limit: (integer - minimum: 1 - maximum: 100000)
  - $per_page: (integer - minimum: 1 - maximum: 100)
  - $orderby: (object)
  - $hint: (one of null, cache, nocache)
- $projection: (object)
  Contains projection to apply (for GET only)
  - $fields: (object)
  - $usage: (string)
- $data: (object)
  Contains data to insert (for POST only)
- $facetQuery: (object)
  Contains facet to apply (for GET only)
- $action: (array of object)
  Contains actions to apply as update (for PUT only)
Example:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array of object)
Contains list of items
$facet: (object)
Contains facet if requested

Example:

{
  "$hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$query": {
      "$path": "aaaaa"
    }
  },
  "$results": [
    {
      "#id": "id1"
    },
    {
      "#id": "id2"
    },
    {
      "#id": "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

Request that will return result of 1 Format. The request is using POST with X-Http-Method-Override: GET

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

idu: required (string)

Headers

X-Http-Method-Override: required (GET)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
```
0
```

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
$filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $per_page: (integer - minimum: 1 - maximum: 100)
- $orderby: (object)
- $hint: (one of null, cache, nocache)
$projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
$data: (object)
Contains data to insert (for POST only)
$facetQuery: (object)
Contains facet to apply (for GET only)
$action: (array of object)
Contains actions to apply as update (for PUT only)

Examples:

{
  "$query": {
    "$path": "aaaaa"
  }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

HTTP status code 200

Returns one Formats item

Headers

X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

$hits: required (object)
Contains the hits for the response
- total: required (integer)
  Total estimated possible answears
- offset: required (integer)
  Offset on possible answears
- limit: required (integer)
  Limit specified in the request (or implicit) from Offset
- size: required (integer)
  Number of currently returned answears
- time_out: (boolean)
  True means the request was too long and so only partial result could be retrieved
$context: required (object)
Contains Request related to this to reply
- $query: required (object)
  Contains one query
- $filter: (object)
  Contains filter to apply (for GET only)
  - $offset: (integer - minimum: 1 - maximum: 100000)
  - $limit: (integer - minimum: 1 - maximum: 100000)
  - $per_page: (integer - minimum: 1 - maximum: 100)
  - $orderby: (object)
  - $hint: (one of null, cache, nocache)
- $projection: (object)
  Contains projection to apply (for GET only)
  - $fields: (object)
  - $usage: (string)
- $data: (object)
  Contains data to insert (for POST only)
- $facetQuery: (object)
  Contains facet to apply (for GET only)
- $action: (array of object)
  Contains actions to apply as update (for PUT only)
Example:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array of object)
Contains list of items
$facet: (object)
Contains facet if requested

Example:

{
  "$hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$query": {
      "$path": "aaaaa"
    }
  },
  "$results": [
    {
      "#id": "id1"
    },
    {
      "#id": "id2"
    },
    {
      "#id": "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

Rules

API qui définit les requêtes pour accéder au référentiels des Règles de gestion. La requête utilise le langage de requête (DSL) de Vitam en entrée et retourne une liste de règles selon le DSL Vitam en cas de succès.

/rules get post put

get

Request that will return results composed of Rules

post

Request that will return results composed of Rules if the request is using POST with X-Http-Method-Override: GET. If there is no X-Http-Method-Override, this allow to push a new Referential from a CSV source file containing Rules definitions.

put

This allow to submit a new Referential from a CSV source file containing Rules definitions to check if this could be imported.

Request that will return results composed of Rules

Secured by VitamPlatform

Based on Platform Secret

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
```
0
```
X-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
$filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $per_page: (integer - minimum: 1 - maximum: 100)
- $orderby: (object)
- $hint: (one of null, cache, nocache)
$projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
$data: (object)
Contains data to insert (for POST only)
$facetQuery: (object)
Contains facet to apply (for GET only)
$action: (array of object)
Contains actions to apply as update (for PUT only)

Examples:

{
  "$query": {
    "$path": "aaaaa"
  }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

HTTP status code 200

Returns the list of matching Rules

Headers

X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

$hits: required (object)
Contains the hits for the response
- total: required (integer)
  Total estimated possible answears
- offset: required (integer)
  Offset on possible answears
- limit: required (integer)
  Limit specified in the request (or implicit) from Offset
- size: required (integer)
  Number of currently returned answears
- time_out: (boolean)
  True means the request was too long and so only partial result could be retrieved
$context: required (object)
Contains Request related to this to reply
- $query: required (object)
  Contains one query
- $filter: (object)
  Contains filter to apply (for GET only)
  - $offset: (integer - minimum: 1 - maximum: 100000)
  - $limit: (integer - minimum: 1 - maximum: 100000)
  - $per_page: (integer - minimum: 1 - maximum: 100)
  - $orderby: (object)
  - $hint: (one of null, cache, nocache)
- $projection: (object)
  Contains projection to apply (for GET only)
  - $fields: (object)
  - $usage: (string)
- $data: (object)
  Contains data to insert (for POST only)
- $facetQuery: (object)
  Contains facet to apply (for GET only)
- $action: (array of object)
  Contains actions to apply as update (for PUT only)
Example:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array of object)
Contains list of items
$facet: (object)
Contains facet if requested

Example:

{
  "$hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$query": {
      "$path": "aaaaa"
    }
  },
  "$results": [
    {
      "#id": "id1"
    },
    {
      "#id": "id2"
    },
    {
      "#id": "id3"
    }
  ]
}

HTTP status code 206

UNSUPPORTED Returns the list of matching Rules using Cursor

Headers

X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id
X-Cursor-Timeout: (datetime)
When X-Cursor-Id is present, it specifies the date and time limit of the availability of this cursor Id
X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

$hits: required (object)
Contains the hits for the response
- total: required (integer)
  Total estimated possible answears
- offset: required (integer)
  Offset on possible answears
- limit: required (integer)
  Limit specified in the request (or implicit) from Offset
- size: required (integer)
  Number of currently returned answears
- time_out: (boolean)
  True means the request was too long and so only partial result could be retrieved
$context: required (object)
Contains Request related to this to reply
- $query: required (object)
  Contains one query
- $filter: (object)
  Contains filter to apply (for GET only)
  - $offset: (integer - minimum: 1 - maximum: 100000)
  - $limit: (integer - minimum: 1 - maximum: 100000)
  - $per_page: (integer - minimum: 1 - maximum: 100)
  - $orderby: (object)
  - $hint: (one of null, cache, nocache)
- $projection: (object)
  Contains projection to apply (for GET only)
  - $fields: (object)
  - $usage: (string)
- $data: (object)
  Contains data to insert (for POST only)
- $facetQuery: (object)
  Contains facet to apply (for GET only)
- $action: (array of object)
  Contains actions to apply as update (for PUT only)
Example:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array of object)
Contains list of items
$facet: (object)
Contains facet if requested

Example:

{
  "$hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$query": {
      "$path": "aaaaa"
    }
  },
  "$results": [
    {
      "#id": "id1"
    },
    {
      "#id": "id2"
    },
    {
      "#id": "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

Secured by VitamPlatform

Based on Platform Secret

Headers

X-Http-Method-Override: (GET)
X-Filename: (string)
Name of the file uploaded
Example:
```
Rules_v5.csv
```
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-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
$filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $per_page: (integer - minimum: 1 - maximum: 100)
- $orderby: (object)
- $hint: (one of null, cache, nocache)
$projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
$data: (object)
Contains data to insert (for POST only)
$facetQuery: (object)
Contains facet to apply (for GET only)
$action: (array of object)
Contains actions to apply as update (for PUT only)

Examples:

{
  "$query": {
    "$path": "aaaaa"
  }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

Media type: application/xml

Type: object

Media type: application/csv

Type: object

HTTP status code 200

Returns the list of matching Rules

Headers

X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

$hits: required (object)
Contains the hits for the response
- total: required (integer)
  Total estimated possible answears
- offset: required (integer)
  Offset on possible answears
- limit: required (integer)
  Limit specified in the request (or implicit) from Offset
- size: required (integer)
  Number of currently returned answears
- time_out: (boolean)
  True means the request was too long and so only partial result could be retrieved
$context: required (object)
Contains Request related to this to reply
- $query: required (object)
  Contains one query
- $filter: (object)
  Contains filter to apply (for GET only)
  - $offset: (integer - minimum: 1 - maximum: 100000)
  - $limit: (integer - minimum: 1 - maximum: 100000)
  - $per_page: (integer - minimum: 1 - maximum: 100)
  - $orderby: (object)
  - $hint: (one of null, cache, nocache)
- $projection: (object)
  Contains projection to apply (for GET only)
  - $fields: (object)
  - $usage: (string)
- $data: (object)
  Contains data to insert (for POST only)
- $facetQuery: (object)
  Contains facet to apply (for GET only)
- $action: (array of object)
  Contains actions to apply as update (for PUT only)
Example:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array of object)
Contains list of items
$facet: (object)
Contains facet if requested

Example:

{
  "$hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$query": {
      "$path": "aaaaa"
    }
  },
  "$results": [
    {
      "#id": "id1"
    },
    {
      "#id": "id2"
    },
    {
      "#id": "id3"
    }
  ]
}

HTTP status code 206

UNSUPPORTED Returns the list of matching Rules using Cursor

Headers

X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id
X-Cursor-Timeout: (datetime)
When X-Cursor-Id is present, it specifies the date and time limit of the availability of this cursor Id
X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

$hits: required (object)
Contains the hits for the response
- total: required (integer)
  Total estimated possible answears
- offset: required (integer)
  Offset on possible answears
- limit: required (integer)
  Limit specified in the request (or implicit) from Offset
- size: required (integer)
  Number of currently returned answears
- time_out: (boolean)
  True means the request was too long and so only partial result could be retrieved
$context: required (object)
Contains Request related to this to reply
- $query: required (object)
  Contains one query
- $filter: (object)
  Contains filter to apply (for GET only)
  - $offset: (integer - minimum: 1 - maximum: 100000)
  - $limit: (integer - minimum: 1 - maximum: 100000)
  - $per_page: (integer - minimum: 1 - maximum: 100)
  - $orderby: (object)
  - $hint: (one of null, cache, nocache)
- $projection: (object)
  Contains projection to apply (for GET only)
  - $fields: (object)
  - $usage: (string)
- $data: (object)
  Contains data to insert (for POST only)
- $facetQuery: (object)
  Contains facet to apply (for GET only)
- $action: (array of object)
  Contains actions to apply as update (for PUT only)
Example:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array of object)
Contains list of items
$facet: (object)
Contains facet if requested

Example:

{
  "$hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$query": {
      "$path": "aaaaa"
    }
  },
  "$results": [
    {
      "#id": "id1"
    },
    {
      "#id": "id2"
    },
    {
      "#id": "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

This allow to submit a new Referential from a CSV source file containing Rules definitions to check if this could be imported.

Secured by VitamPlatform

Based on Platform Secret

Headers

X-Http-Method-Override: (string)
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/xml

Type: object

Media type: application/csv

Type: object

HTTP status code 200

Returns if upload or check of Rules is OK

Headers

X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

/rules/{idu} get post

API qui définit les requêtes pour accéder à 1 Règle dans le référentiel des Règles de gestion.

get

Request that will return result composed of 1 Rule

post

Request that will return result of 1 Rule. The request is using POST with X-Http-Method-Override: GET

Request that will return result composed of 1 Rule

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

idu: required (string)

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
```
0
```

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
$filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $per_page: (integer - minimum: 1 - maximum: 100)
- $orderby: (object)
- $hint: (one of null, cache, nocache)
$projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
$data: (object)
Contains data to insert (for POST only)
$facetQuery: (object)
Contains facet to apply (for GET only)
$action: (array of object)
Contains actions to apply as update (for PUT only)

Examples:

{
  "$query": {
    "$path": "aaaaa"
  }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

HTTP status code 200

Returns one Rules item

Headers

X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

$hits: required (object)
Contains the hits for the response
- total: required (integer)
  Total estimated possible answears
- offset: required (integer)
  Offset on possible answears
- limit: required (integer)
  Limit specified in the request (or implicit) from Offset
- size: required (integer)
  Number of currently returned answears
- time_out: (boolean)
  True means the request was too long and so only partial result could be retrieved
$context: required (object)
Contains Request related to this to reply
- $query: required (object)
  Contains one query
- $filter: (object)
  Contains filter to apply (for GET only)
  - $offset: (integer - minimum: 1 - maximum: 100000)
  - $limit: (integer - minimum: 1 - maximum: 100000)
  - $per_page: (integer - minimum: 1 - maximum: 100)
  - $orderby: (object)
  - $hint: (one of null, cache, nocache)
- $projection: (object)
  Contains projection to apply (for GET only)
  - $fields: (object)
  - $usage: (string)
- $data: (object)
  Contains data to insert (for POST only)
- $facetQuery: (object)
  Contains facet to apply (for GET only)
- $action: (array of object)
  Contains actions to apply as update (for PUT only)
Example:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array of object)
Contains list of items
$facet: (object)
Contains facet if requested

Example:

{
  "$hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$query": {
      "$path": "aaaaa"
    }
  },
  "$results": [
    {
      "#id": "id1"
    },
    {
      "#id": "id2"
    },
    {
      "#id": "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

Request that will return result of 1 Rule. The request is using POST with X-Http-Method-Override: GET

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

idu: required (string)

Headers

X-Http-Method-Override: required (GET)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
```
0
```

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
$filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $per_page: (integer - minimum: 1 - maximum: 100)
- $orderby: (object)
- $hint: (one of null, cache, nocache)
$projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
$data: (object)
Contains data to insert (for POST only)
$facetQuery: (object)
Contains facet to apply (for GET only)
$action: (array of object)
Contains actions to apply as update (for PUT only)

Examples:

{
  "$query": {
    "$path": "aaaaa"
  }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

HTTP status code 200

Returns one Rules item

Headers

X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

$hits: required (object)
Contains the hits for the response
- total: required (integer)
  Total estimated possible answears
- offset: required (integer)
  Offset on possible answears
- limit: required (integer)
  Limit specified in the request (or implicit) from Offset
- size: required (integer)
  Number of currently returned answears
- time_out: (boolean)
  True means the request was too long and so only partial result could be retrieved
$context: required (object)
Contains Request related to this to reply
- $query: required (object)
  Contains one query
- $filter: (object)
  Contains filter to apply (for GET only)
  - $offset: (integer - minimum: 1 - maximum: 100000)
  - $limit: (integer - minimum: 1 - maximum: 100000)
  - $per_page: (integer - minimum: 1 - maximum: 100)
  - $orderby: (object)
  - $hint: (one of null, cache, nocache)
- $projection: (object)
  Contains projection to apply (for GET only)
  - $fields: (object)
  - $usage: (string)
- $data: (object)
  Contains data to insert (for POST only)
- $facetQuery: (object)
  Contains facet to apply (for GET only)
- $action: (array of object)
  Contains actions to apply as update (for PUT only)
Example:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array of object)
Contains list of items
$facet: (object)
Contains facet if requested

Example:

{
  "$hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$query": {
      "$path": "aaaaa"
    }
  },
  "$results": [
    {
      "#id": "id1"
    },
    {
      "#id": "id2"
    },
    {
      "#id": "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

Accès contracts

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

/accesscontracts get post

get

API qui définit les requêtes pour accéder aux contrats d'accès

post

Importe un ensemble des contrats d'accès qui sont sauvegardés et indexés en cas de succès

API qui définit les requêtes pour accéder aux contrats d'accès

Secured by VitamPlatform

Based on Platform Secret

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
```
0
```
X-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
$filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $per_page: (integer - minimum: 1 - maximum: 100)
- $orderby: (object)
- $hint: (one of null, cache, nocache)
$projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
$data: (object)
Contains data to insert (for POST only)
$facetQuery: (object)
Contains facet to apply (for GET only)
$action: (array of object)
Contains actions to apply as update (for PUT only)

Examples:

{
  "$query": {
    "$path": "aaaaa"
  }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

HTTP status code 200

Returns the list of matching Accesscontracts

Headers

X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

$hits: required (object)
Contains the hits for the response
- total: required (integer)
  Total estimated possible answears
- offset: required (integer)
  Offset on possible answears
- limit: required (integer)
  Limit specified in the request (or implicit) from Offset
- size: required (integer)
  Number of currently returned answears
- time_out: (boolean)
  True means the request was too long and so only partial result could be retrieved
$context: required (object)
Contains Request related to this to reply
- $query: required (object)
  Contains one query
- $filter: (object)
  Contains filter to apply (for GET only)
  - $offset: (integer - minimum: 1 - maximum: 100000)
  - $limit: (integer - minimum: 1 - maximum: 100000)
  - $per_page: (integer - minimum: 1 - maximum: 100)
  - $orderby: (object)
  - $hint: (one of null, cache, nocache)
- $projection: (object)
  Contains projection to apply (for GET only)
  - $fields: (object)
  - $usage: (string)
- $data: (object)
  Contains data to insert (for POST only)
- $facetQuery: (object)
  Contains facet to apply (for GET only)
- $action: (array of object)
  Contains actions to apply as update (for PUT only)
Example:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array of object)
Contains list of items
$facet: (object)
Contains facet if requested

Example:

{
  "$hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$query": {
      "$path": "aaaaa"
    }
  },
  "$results": [
    {
      "#id": "id1"
    },
    {
      "#id": "id2"
    },
    {
      "#id": "id3"
    }
  ]
}

HTTP status code 206

UNSUPPORTED Returns the list of matching Accesscontracts using Cursor

Headers

X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id
X-Cursor-Timeout: (datetime)
When X-Cursor-Id is present, it specifies the date and time limit of the availability of this cursor Id
X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

$hits: required (object)
Contains the hits for the response
- total: required (integer)
  Total estimated possible answears
- offset: required (integer)
  Offset on possible answears
- limit: required (integer)
  Limit specified in the request (or implicit) from Offset
- size: required (integer)
  Number of currently returned answears
- time_out: (boolean)
  True means the request was too long and so only partial result could be retrieved
$context: required (object)
Contains Request related to this to reply
- $query: required (object)
  Contains one query
- $filter: (object)
  Contains filter to apply (for GET only)
  - $offset: (integer - minimum: 1 - maximum: 100000)
  - $limit: (integer - minimum: 1 - maximum: 100000)
  - $per_page: (integer - minimum: 1 - maximum: 100)
  - $orderby: (object)
  - $hint: (one of null, cache, nocache)
- $projection: (object)
  Contains projection to apply (for GET only)
  - $fields: (object)
  - $usage: (string)
- $data: (object)
  Contains data to insert (for POST only)
- $facetQuery: (object)
  Contains facet to apply (for GET only)
- $action: (array of object)
  Contains actions to apply as update (for PUT only)
Example:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array of object)
Contains list of items
$facet: (object)
Contains facet if requested

Example:

{
  "$hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$query": {
      "$path": "aaaaa"
    }
  },
  "$results": [
    {
      "#id": "id1"
    },
    {
      "#id": "id2"
    },
    {
      "#id": "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

Importe un ensemble des contrats d'accès qui sont sauvegardés et indexés en cas de succès

Secured by VitamPlatform

Based on Platform Secret

Headers

X-Http-Method-Override: (GET)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
```
0
```
X-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
$filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $per_page: (integer - minimum: 1 - maximum: 100)
- $orderby: (object)
- $hint: (one of null, cache, nocache)
$projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
$data: (object)
Contains data to insert (for POST only)
$facetQuery: (object)
Contains facet to apply (for GET only)
$action: (array of object)
Contains actions to apply as update (for PUT only)

Examples:

{
  "$query": {
    "$path": "aaaaa"
  }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

Media type: application/xml

Type: object

Media type: application/csv

Type: object

HTTP status code 200

Returns the list of matching Accesscontracts

Headers

X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

$hits: required (object)
Contains the hits for the response
- total: required (integer)
  Total estimated possible answears
- offset: required (integer)
  Offset on possible answears
- limit: required (integer)
  Limit specified in the request (or implicit) from Offset
- size: required (integer)
  Number of currently returned answears
- time_out: (boolean)
  True means the request was too long and so only partial result could be retrieved
$context: required (object)
Contains Request related to this to reply
- $query: required (object)
  Contains one query
- $filter: (object)
  Contains filter to apply (for GET only)
  - $offset: (integer - minimum: 1 - maximum: 100000)
  - $limit: (integer - minimum: 1 - maximum: 100000)
  - $per_page: (integer - minimum: 1 - maximum: 100)
  - $orderby: (object)
  - $hint: (one of null, cache, nocache)
- $projection: (object)
  Contains projection to apply (for GET only)
  - $fields: (object)
  - $usage: (string)
- $data: (object)
  Contains data to insert (for POST only)
- $facetQuery: (object)
  Contains facet to apply (for GET only)
- $action: (array of object)
  Contains actions to apply as update (for PUT only)
Example:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array of object)
Contains list of items
$facet: (object)
Contains facet if requested

Example:

{
  "$hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$query": {
      "$path": "aaaaa"
    }
  },
  "$results": [
    {
      "#id": "id1"
    },
    {
      "#id": "id2"
    },
    {
      "#id": "id3"
    }
  ]
}

HTTP status code 206

UNSUPPORTED Returns the list of matching Accesscontracts using Cursor

Headers

X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id
X-Cursor-Timeout: (datetime)
When X-Cursor-Id is present, it specifies the date and time limit of the availability of this cursor Id
X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

$hits: required (object)
Contains the hits for the response
- total: required (integer)
  Total estimated possible answears
- offset: required (integer)
  Offset on possible answears
- limit: required (integer)
  Limit specified in the request (or implicit) from Offset
- size: required (integer)
  Number of currently returned answears
- time_out: (boolean)
  True means the request was too long and so only partial result could be retrieved
$context: required (object)
Contains Request related to this to reply
- $query: required (object)
  Contains one query
- $filter: (object)
  Contains filter to apply (for GET only)
  - $offset: (integer - minimum: 1 - maximum: 100000)
  - $limit: (integer - minimum: 1 - maximum: 100000)
  - $per_page: (integer - minimum: 1 - maximum: 100)
  - $orderby: (object)
  - $hint: (one of null, cache, nocache)
- $projection: (object)
  Contains projection to apply (for GET only)
  - $fields: (object)
  - $usage: (string)
- $data: (object)
  Contains data to insert (for POST only)
- $facetQuery: (object)
  Contains facet to apply (for GET only)
- $action: (array of object)
  Contains actions to apply as update (for PUT only)
Example:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array of object)
Contains list of items
$facet: (object)
Contains facet if requested

Example:

{
  "$hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$query": {
      "$path": "aaaaa"
    }
  },
  "$results": [
    {
      "#id": "id1"
    },
    {
      "#id": "id2"
    },
    {
      "#id": "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

Ingest contracts

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

/ingestcontracts get post

get

API qui définit les requêtes pour accéder aux contrats d'entrée

post

Importe un ensemble des contrats d'entrée qui sont sauvegardés et indexés en cas de succès

API qui définit les requêtes pour accéder aux contrats d'entrée

Secured by VitamPlatform

Based on Platform Secret

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
```
0
```
X-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
$filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $per_page: (integer - minimum: 1 - maximum: 100)
- $orderby: (object)
- $hint: (one of null, cache, nocache)
$projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
$data: (object)
Contains data to insert (for POST only)
$facetQuery: (object)
Contains facet to apply (for GET only)
$action: (array of object)
Contains actions to apply as update (for PUT only)

Examples:

{
  "$query": {
    "$path": "aaaaa"
  }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

HTTP status code 200

Returns the list of matching Ingestcontracts

Headers

X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

$hits: required (object)
Contains the hits for the response
- total: required (integer)
  Total estimated possible answears
- offset: required (integer)
  Offset on possible answears
- limit: required (integer)
  Limit specified in the request (or implicit) from Offset
- size: required (integer)
  Number of currently returned answears
- time_out: (boolean)
  True means the request was too long and so only partial result could be retrieved
$context: required (object)
Contains Request related to this to reply
- $query: required (object)
  Contains one query
- $filter: (object)
  Contains filter to apply (for GET only)
  - $offset: (integer - minimum: 1 - maximum: 100000)
  - $limit: (integer - minimum: 1 - maximum: 100000)
  - $per_page: (integer - minimum: 1 - maximum: 100)
  - $orderby: (object)
  - $hint: (one of null, cache, nocache)
- $projection: (object)
  Contains projection to apply (for GET only)
  - $fields: (object)
  - $usage: (string)
- $data: (object)
  Contains data to insert (for POST only)
- $facetQuery: (object)
  Contains facet to apply (for GET only)
- $action: (array of object)
  Contains actions to apply as update (for PUT only)
Example:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array of object)
Contains list of items
$facet: (object)
Contains facet if requested

Example:

{
  "$hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$query": {
      "$path": "aaaaa"
    }
  },
  "$results": [
    {
      "#id": "id1"
    },
    {
      "#id": "id2"
    },
    {
      "#id": "id3"
    }
  ]
}

HTTP status code 206

UNSUPPORTED Returns the list of matching Ingestcontracts using Cursor

Headers

X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id
X-Cursor-Timeout: (datetime)
When X-Cursor-Id is present, it specifies the date and time limit of the availability of this cursor Id
X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

$hits: required (object)
Contains the hits for the response
- total: required (integer)
  Total estimated possible answears
- offset: required (integer)
  Offset on possible answears
- limit: required (integer)
  Limit specified in the request (or implicit) from Offset
- size: required (integer)
  Number of currently returned answears
- time_out: (boolean)
  True means the request was too long and so only partial result could be retrieved
$context: required (object)
Contains Request related to this to reply
- $query: required (object)
  Contains one query
- $filter: (object)
  Contains filter to apply (for GET only)
  - $offset: (integer - minimum: 1 - maximum: 100000)
  - $limit: (integer - minimum: 1 - maximum: 100000)
  - $per_page: (integer - minimum: 1 - maximum: 100)
  - $orderby: (object)
  - $hint: (one of null, cache, nocache)
- $projection: (object)
  Contains projection to apply (for GET only)
  - $fields: (object)
  - $usage: (string)
- $data: (object)
  Contains data to insert (for POST only)
- $facetQuery: (object)
  Contains facet to apply (for GET only)
- $action: (array of object)
  Contains actions to apply as update (for PUT only)
Example:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array of object)
Contains list of items
$facet: (object)
Contains facet if requested

Example:

{
  "$hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$query": {
      "$path": "aaaaa"
    }
  },
  "$results": [
    {
      "#id": "id1"
    },
    {
      "#id": "id2"
    },
    {
      "#id": "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

Importe un ensemble des contrats d'entrée qui sont sauvegardés et indexés en cas de succès

Secured by VitamPlatform

Based on Platform Secret

Headers

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

$query: required (object)
Contains one query
$filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $per_page: (integer - minimum: 1 - maximum: 100)
- $orderby: (object)
- $hint: (one of null, cache, nocache)
$projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
$data: (object)
Contains data to insert (for POST only)
$facetQuery: (object)
Contains facet to apply (for GET only)
$action: (array of object)
Contains actions to apply as update (for PUT only)

Examples:

{
  "$query": {
    "$path": "aaaaa"
  }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

HTTP status code 200

Returns one Ingestcontracts item

Headers

X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

$hits: required (object)
Contains the hits for the response
- total: required (integer)
  Total estimated possible answears
- offset: required (integer)
  Offset on possible answears
- limit: required (integer)
  Limit specified in the request (or implicit) from Offset
- size: required (integer)
  Number of currently returned answears
- time_out: (boolean)
  True means the request was too long and so only partial result could be retrieved
$context: required (object)
Contains Request related to this to reply
- $query: required (object)
  Contains one query
- $filter: (object)
  Contains filter to apply (for GET only)
  - $offset: (integer - minimum: 1 - maximum: 100000)
  - $limit: (integer - minimum: 1 - maximum: 100000)
  - $per_page: (integer - minimum: 1 - maximum: 100)
  - $orderby: (object)
  - $hint: (one of null, cache, nocache)
- $projection: (object)
  Contains projection to apply (for GET only)
  - $fields: (object)
  - $usage: (string)
- $data: (object)
  Contains data to insert (for POST only)
- $facetQuery: (object)
  Contains facet to apply (for GET only)
- $action: (array of object)
  Contains actions to apply as update (for PUT only)
Example:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array of object)
Contains list of items
$facet: (object)
Contains facet if requested

Example:

{
  "$hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$query": {
      "$path": "aaaaa"
    }
  },
  "$results": [
    {
      "#id": "id1"
    },
    {
      "#id": "id2"
    },
    {
      "#id": "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

Access contract

API qui permet de mettre à jour les contrats d'accès via une requête de mise à jour

/accesscontract/{id} put

put

Update the given access contract

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

id: required (string)

Headers

X-Http-Method-Override: (string)
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/xml

Type: object

Media type: application/csv

Type: object

HTTP status code 200

Returns if upload or check of Accesscontract is OK

Headers

X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

Ingest contract

API qui permet de mettre à jour les contrats d'entrées via une requête de mise à jour

/contract/{id} put

put

Update the given ingest contract

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

id: required (string)

Headers

X-Http-Method-Override: (string)
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/xml

Type: object

Media type: application/csv

Type: object

HTTP status code 200

Returns if upload or check of Contract is OK

Headers

X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

Security Profiles

API qui définit les requêtes pour accéder aux Profiles de Sécurité. La requête utilise le langage de requête (DSL) de Vitam en entrée et retourne une liste de profiles de sécurité selon le DSL Vitam en cas de succès.

/securityprofiles get post

get

Request that will return results composed of Security Profiles

post

Request to import new Security Profiles.

Request that will return results composed of Security Profiles

Secured by VitamPlatform

Based on Platform Secret

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
```
0
```
X-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
$filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $per_page: (integer - minimum: 1 - maximum: 100)
- $orderby: (object)
- $hint: (one of null, cache, nocache)
$projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
$data: (object)
Contains data to insert (for POST only)
$facetQuery: (object)
Contains facet to apply (for GET only)
$action: (array of object)
Contains actions to apply as update (for PUT only)

Examples:

{
  "$query": {
    "$path": "aaaaa"
  }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

HTTP status code 200

Returns the list of matching Securityprofiles

Headers

X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

$hits: required (object)
Contains the hits for the response
- total: required (integer)
  Total estimated possible answears
- offset: required (integer)
  Offset on possible answears
- limit: required (integer)
  Limit specified in the request (or implicit) from Offset
- size: required (integer)
  Number of currently returned answears
- time_out: (boolean)
  True means the request was too long and so only partial result could be retrieved
$context: required (object)
Contains Request related to this to reply
- $query: required (object)
  Contains one query
- $filter: (object)
  Contains filter to apply (for GET only)
  - $offset: (integer - minimum: 1 - maximum: 100000)
  - $limit: (integer - minimum: 1 - maximum: 100000)
  - $per_page: (integer - minimum: 1 - maximum: 100)
  - $orderby: (object)
  - $hint: (one of null, cache, nocache)
- $projection: (object)
  Contains projection to apply (for GET only)
  - $fields: (object)
  - $usage: (string)
- $data: (object)
  Contains data to insert (for POST only)
- $facetQuery: (object)
  Contains facet to apply (for GET only)
- $action: (array of object)
  Contains actions to apply as update (for PUT only)
Example:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array of object)
Contains list of items
$facet: (object)
Contains facet if requested

Example:

{
  "$hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$query": {
      "$path": "aaaaa"
    }
  },
  "$results": [
    {
      "#id": "id1"
    },
    {
      "#id": "id2"
    },
    {
      "#id": "id3"
    }
  ]
}

HTTP status code 206

UNSUPPORTED Returns the list of matching Securityprofiles using Cursor

Headers

X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id
X-Cursor-Timeout: (datetime)
When X-Cursor-Id is present, it specifies the date and time limit of the availability of this cursor Id
X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

$hits: required (object)
Contains the hits for the response
- total: required (integer)
  Total estimated possible answears
- offset: required (integer)
  Offset on possible answears
- limit: required (integer)
  Limit specified in the request (or implicit) from Offset
- size: required (integer)
  Number of currently returned answears
- time_out: (boolean)
  True means the request was too long and so only partial result could be retrieved
$context: required (object)
Contains Request related to this to reply
- $query: required (object)
  Contains one query
- $filter: (object)
  Contains filter to apply (for GET only)
  - $offset: (integer - minimum: 1 - maximum: 100000)
  - $limit: (integer - minimum: 1 - maximum: 100000)
  - $per_page: (integer - minimum: 1 - maximum: 100)
  - $orderby: (object)
  - $hint: (one of null, cache, nocache)
- $projection: (object)
  Contains projection to apply (for GET only)
  - $fields: (object)
  - $usage: (string)
- $data: (object)
  Contains data to insert (for POST only)
- $facetQuery: (object)
  Contains facet to apply (for GET only)
- $action: (array of object)
  Contains actions to apply as update (for PUT only)
Example:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array of object)
Contains list of items
$facet: (object)
Contains facet if requested

Example:

{
  "$hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$query": {
      "$path": "aaaaa"
    }
  },
  "$results": [
    {
      "#id": "id1"
    },
    {
      "#id": "id2"
    },
    {
      "#id": "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

Request to import new Security Profiles.

Secured by VitamPlatform

Based on Platform Secret

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
```
0
```
X-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
$filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $per_page: (integer - minimum: 1 - maximum: 100)
- $orderby: (object)
- $hint: (one of null, cache, nocache)
$projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
$data: (object)
Contains data to insert (for POST only)
$facetQuery: (object)
Contains facet to apply (for GET only)
$action: (array of object)
Contains actions to apply as update (for PUT only)

Examples:

{
  "$query": {
    "$path": "aaaaa"
  }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

Media type: application/xml

Type: object

Media type: application/csv

Type: object

HTTP status code 200

Returns the list of matching Securityprofiles

Headers

X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

$hits: required (object)
Contains the hits for the response
- total: required (integer)
  Total estimated possible answears
- offset: required (integer)
  Offset on possible answears
- limit: required (integer)
  Limit specified in the request (or implicit) from Offset
- size: required (integer)
  Number of currently returned answears
- time_out: (boolean)
  True means the request was too long and so only partial result could be retrieved
$context: required (object)
Contains Request related to this to reply
- $query: required (object)
  Contains one query
- $filter: (object)
  Contains filter to apply (for GET only)
  - $offset: (integer - minimum: 1 - maximum: 100000)
  - $limit: (integer - minimum: 1 - maximum: 100000)
  - $per_page: (integer - minimum: 1 - maximum: 100)
  - $orderby: (object)
  - $hint: (one of null, cache, nocache)
- $projection: (object)
  Contains projection to apply (for GET only)
  - $fields: (object)
  - $usage: (string)
- $data: (object)
  Contains data to insert (for POST only)
- $facetQuery: (object)
  Contains facet to apply (for GET only)
- $action: (array of object)
  Contains actions to apply as update (for PUT only)
Example:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array of object)
Contains list of items
$facet: (object)
Contains facet if requested

Example:

{
  "$hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$query": {
      "$path": "aaaaa"
    }
  },
  "$results": [
    {
      "#id": "id1"
    },
    {
      "#id": "id2"
    },
    {
      "#id": "id3"
    }
  ]
}

HTTP status code 206

UNSUPPORTED Returns the list of matching Securityprofiles using Cursor

Headers

X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id
X-Cursor-Timeout: (datetime)
When X-Cursor-Id is present, it specifies the date and time limit of the availability of this cursor Id
X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

$hits: required (object)
Contains the hits for the response
- total: required (integer)
  Total estimated possible answears
- offset: required (integer)
  Offset on possible answears
- limit: required (integer)
  Limit specified in the request (or implicit) from Offset
- size: required (integer)
  Number of currently returned answears
- time_out: (boolean)
  True means the request was too long and so only partial result could be retrieved
$context: required (object)
Contains Request related to this to reply
- $query: required (object)
  Contains one query
- $filter: (object)
  Contains filter to apply (for GET only)
  - $offset: (integer - minimum: 1 - maximum: 100000)
  - $limit: (integer - minimum: 1 - maximum: 100000)
  - $per_page: (integer - minimum: 1 - maximum: 100)
  - $orderby: (object)
  - $hint: (one of null, cache, nocache)
- $projection: (object)
  Contains projection to apply (for GET only)
  - $fields: (object)
  - $usage: (string)
- $data: (object)
  Contains data to insert (for POST only)
- $facetQuery: (object)
  Contains facet to apply (for GET only)
- $action: (array of object)
  Contains actions to apply as update (for PUT only)
Example:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array of object)
Contains list of items
$facet: (object)
Contains facet if requested

Example:

{
  "$hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$query": {
      "$path": "aaaaa"
    }
  },
  "$results": [
    {
      "#id": "id1"
    },
    {
      "#id": "id2"
    },
    {
      "#id": "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

/securityprofiles/{identifier} get put

API qui définit les requêtes pour accéder aux Profiles de Sécurité.

get

Request that will return a Security Profile

put

Update the given Security Profile

Request that will return a Security Profile

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

identifier: required (string)

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
```
0
```

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
$filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $per_page: (integer - minimum: 1 - maximum: 100)
- $orderby: (object)
- $hint: (one of null, cache, nocache)
$projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
$data: (object)
Contains data to insert (for POST only)
$facetQuery: (object)
Contains facet to apply (for GET only)
$action: (array of object)
Contains actions to apply as update (for PUT only)

Examples:

{
  "$query": {
    "$path": "aaaaa"
  }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

{
  "$query":
    { "$range": {
      "start_date": {
        "$gte": "2014-01-10", "$lte": "2014-03-10"
      }
    }
  },
  "$filter": { "$limit": 100, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}

HTTP status code 200

Returns one Securityprofiles item

Headers

X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

$hits: required (object)
Contains the hits for the response
- total: required (integer)
  Total estimated possible answears
- offset: required (integer)
  Offset on possible answears
- limit: required (integer)
  Limit specified in the request (or implicit) from Offset
- size: required (integer)
  Number of currently returned answears
- time_out: (boolean)
  True means the request was too long and so only partial result could be retrieved
$context: required (object)
Contains Request related to this to reply
- $query: required (object)
  Contains one query
- $filter: (object)
  Contains filter to apply (for GET only)
  - $offset: (integer - minimum: 1 - maximum: 100000)
  - $limit: (integer - minimum: 1 - maximum: 100000)
  - $per_page: (integer - minimum: 1 - maximum: 100)
  - $orderby: (object)
  - $hint: (one of null, cache, nocache)
- $projection: (object)
  Contains projection to apply (for GET only)
  - $fields: (object)
  - $usage: (string)
- $data: (object)
  Contains data to insert (for POST only)
- $facetQuery: (object)
  Contains facet to apply (for GET only)
- $action: (array of object)
  Contains actions to apply as update (for PUT only)
Example:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array of object)
Contains list of items
$facet: (object)
Contains facet if requested

Example:

{
  "$hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$query": {
      "$path": "aaaaa"
    }
  },
  "$results": [
    {
      "#id": "id1"
    },
    {
      "#id": "id2"
    },
    {
      "#id": "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

Update the given Security Profile

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

identifier: required (string)

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
```
0
```

Body

Media type: application/xml

Type: object

Media type: application/csv

Type: object

HTTP status code 200

Returns if upload or check of Securityprofiles is OK

Headers

X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

Raw

API d'accès aux référentiels en mode brut (pas de traduction Vitam).

/raw/accession-register/detail get post

Accès au détail d'un registre de fond.

get

Get an Accession Register Detail

post

Insert or replace Accession Register Detail

Get an Accession Register Detail

Secured by VitamPlatform

Based on Platform Secret

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
```
0
```

Body

Media type: application/json

Type: object

Example:

{
	"OriginatingAgency": "FRAN_NP_009913",
	"Opc": "aeeaaaaaagghkzkeaacimalb2grgctiaaaaq"
}

HTTP status code 200

Returns one Accession Register Detail Raw

Headers

X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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": 1,
		"size": 1,
		"offset": 0,
		"limit": 1000
	},
	"$context": {},
	"$results": [
      {
        "_id": "aehaaaaaaaecjmacabcnualfddjzvpyaaaaq",
        "ObjectSize": {
          "ingested": 12,
          "deleted": 0,
          "remained": 12
        },
        "OriginatingAgency": "FRAN_NP_009913",
        "SubmissionAgency": "FRAN_NP_009913",
        "ArchivalAgreement": "ArchivalAgreement0",
        "EndDate": "2018-08-08T09:17:25.567",
        "StartDate": "2018-08-08T09:17:25.567",
        "LastUpdate": "2018-08-08T09:17:25.567",
        "Status": "STORED_AND_COMPLETED",
        "TotalObjectGroups": {
          "ingested": 2,
          "deleted": 0,
          "remained": 2
        },
        "TotalUnits": {
          "ingested": 3,
          "deleted": 0,
          "remained": 3
        },
        "TotalObjects": {
          "ingested": 2,
          "deleted": 0,
          "remained": 2
        },
        "Opc": "aeeaaaaaacecjmacabdbaalfddjuhciaaaaq",
        "Opi": "aeeaaaaaacecjmacabdbaalfddjuhciaaaaq",
        "Events": [
          {
            "Opc": "aeeaaaaaacecjmacabdbaalfddjuhciaaaaq",
            "OpType": "INGEST",
            "Gots": 2,
            "Units": 3,
            "Objects": 2,
            "ObjSize": 12,
            "CreationDate": "2018-08-08T11:17:25.582"
          }
        ],
        "OperationIds": [
          "aeeaaaaaacecjmacabdbaalfddjuhciaaaaq"
        ],
        "_v": 0,
        "_tenant": 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

Insert or replace Accession Register Detail

Secured by VitamPlatform

Based on Platform Secret

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
```
0
```

Body

Media type: application/json

Type: object

Example:

{
  "#id": "aehaaaaaaaecjmacabcnualfddjzvpyaaaaq",
  "ObjectSize": {
    "ingested": 12,
    "deleted": 0,
    "remained": 12
  },
  "OriginatingAgency": "FRAN_NP_009913",
  "SubmissionAgency": "FRAN_NP_009913",
  "ArchivalAgreement": "ArchivalAgreement0",
  "EndDate": "2018-08-08T09:17:25.567",
  "StartDate": "2018-08-08T09:17:25.567",
  "LastUpdate": "2018-08-08T09:17:25.567",
  "Status": "STORED_AND_COMPLETED",
  "TotalObjectGroups": {
    "ingested": 2,
    "deleted": 0,
    "remained": 2
  },
  "TotalUnits": {
    "ingested": 3,
    "deleted": 0,
    "remained": 3
  },
  "TotalObjects": {
    "ingested": 2,
    "deleted": 0,
    "remained": 2
  },
  "Opc": "aeeaaaaaacecjmacabdbaalfddjuhciaaaaq",
  "Opi": "aeeaaaaaacecjmacabdbaalfddjuhciaaaaq",
  "Events": [
    {
      "Opc": "aeeaaaaaacecjmacabdbaalfddjuhciaaaaq",
      "OpType": "INGEST",
      "Gots": 2,
      "Units": 3,
      "Objects": 2,
      "ObjSize": 12,
      "CreationDate": "2018-08-08T11:17:25.582"
    }
  ],
  "OperationIds": [
    "aeeaaaaaacecjmacabdbaalfddjuhciaaaaq"
  ],
  "#v": 0,
  "#tenant": 0
}

HTTP status code 201

Creation done

Headers

X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
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

Reindexation

API qui permet de lancer une réindexation de collection(s)

/reindex post

post

Lance la réindexation de collection(s) sur une liste de tenants donnée

Secured by VitamPlatform

Based on Platform Secret

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
```
0
```

Body

Media type: application/json

Type: object

Example:

[
	
	{
	
		"collection": "ObjectGroup",
	
		"tenants": [0, 1, 2]
	
	}
	
]

HTTP status code 200

Retourne OK en cas de succès de réindexation

Body

Media type: application/json

Type: object

Example:

{
  "httpCode": 201,
  "$hits": {
    "total": 1,
    "offset": 0,
    "limit": 0,
    "size": 1
  },
  "$results": [
    {
      "collectionName": "ObjectGroup",
      "OK": [
        {
          "indexName": "objectgroup_20_20180126_143919",
          "tenant": 20
        }
      ],
      "KO": null
    }
  ],
  "$context": {

  }
}

HTTP status code 400

Bad Request, syntax might be erroneous

Headers

X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
```
0
```

Secured by VitamPlatform

Headers

X-Vitam-Key: required (string)
Vitam Platform Key

Switch Indexes

API qui permet de faire pointer un alias sur un nouvel index

/alias post

post

Lance le switch d'index pour un alias donné

Secured by VitamPlatform

Based on Platform Secret

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
```
0
```

Body

Media type: application/json

Type: object

Example:

[
  {
    "alias": "ObjectGroup",
    "indexName": "objectgroup_20_20180125_161152"
  }
]

HTTP status code 200

Retourne OK en cas de succès de switch

Body

Media type: application/json

Type: object

Example:

{
  "httpCode": 200,
  "$hits": {
    "total": 1,
    "offset": 0,
    "limit": 0,
    "size": 1
  },
  "$results": [
    {
      "collectionName": null,
      "OK": null,
      "KO": null
    }
  ],
  "$context": {

  }
}

HTTP status code 400

Bad Request, syntax might be erroneous

Headers

X-Request-Id: required (string)
Unique Request Identifier
Example:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Example:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
```
0
```

Secured by VitamPlatform

Headers

X-Vitam-Key: required (string)
Vitam Platform Key

Journalisation externe

API permettant d'intégrer des journaux d'opération externes.

/logbookoperations post

post

Requête qui insère une opération externe dans le journal des opérations

Secured by VitamPlatform

Based on Platform Secret

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
```
0
```

Body

Media type: application/json

Type: object

Example:

{
    "eventIdentifier": "entryId",
    "eventType": "externalOperation",
    "eventDateTime": "2015-07-14T17:32:05Z",
    "eventIdentifierProcess": "workflowId",
    "eventTypeProcess": "EXTERNAL",
    "outcome" : "STARTED",
    "eventOutcomeDetail": "404_123456",
    "eventOutcomeDetailMessage": "Error message",
    "agentIdentifier": "server_identifier",
    "agentIdentifierApplication": "remoteApplicationId",
    "agentIdentifierApplicationSession": "X-AID",
    "eventIdentifierRequest": "W-Request-Id",
    "agentIdentifierSubmission": "Submission_agency_Id",
    "agentIdentifierOriginating": "Originating_agency_Id",
    "objectIdentifier": "Object_or_SIP_Id",
    "objectIdentifierRequest": "Request_selecting_objects",
    "objectIdentifierIncome": "MessageIdentifier_in_SEDA",
    "events": []
  }

HTTP status code 201

L'opération a bien été créée dans VITAM

HTTP status code 400

L'opération n'est pas au format exigé. Ou alors la valeur du champ eventTypeProcess est incorrecte (devrait être EXTERNAL)

HTTP status code 409

L'opération existe déjà

HTTP status code 500

Internal Server Error, le serveur a rencontré une erreur

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

API-Vitam Version Alpha - Administration Management interne API documentation version v1

Avertissements

Licence

API Administration

Référentiel des Formats

Référentiel des Règles de Gestion

Registre des Fonds

FileFormats

/formats get post put

get /formats

Headers

Body

HTTP status code 200

Headers

Body

HTTP status code 206

Headers

Body

HTTP status code 401

Headers

HTTP status code 404

Headers

HTTP status code 412

Headers

Secured by VitamPlatform

Headers

post /formats

Headers

Body

HTTP status code 200

Headers

Body

HTTP status code 206

Headers

Body

HTTP status code 401

Headers

HTTP status code 404

Headers

HTTP status code 412

Headers

Secured by VitamPlatform

Headers

put /formats

Headers

Body

HTTP status code 200

Headers

HTTP status code 401

Headers

HTTP status code 404

Headers

HTTP status code 412

Headers

Secured by VitamPlatform

Headers

/formats/{idu} get post

get /formats/{idu}

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 /formats/{idu}

URI Parameters

Headers

Body

HTTP status code 200

Headers

Body

HTTP status code 401