API-Vitam Version Alpha - Metadata interne API documentation version v1

http://metadata.internal.vitam.gouv.fr/{version}

version: required (v1)

Avertissements

Cette version d'API présente des fonctionnalités sous différents statuts :

Supportées : rien n'est spécifié, la fonctionnalité ou la donnée est supportée
Non supportées : le mot clef UNSUPPORTED est indiqué et précise que cette fonctionnalité ou donnée n'est pas supportée par l'implémentaton courante
Cette version d'API présente des fonctionnalités sous différentes versions :
Alpha : l'API est dans une première version, susceptible d'évoluer fortement
Beta : l'API est proche de sa version stable
Production : l'API est considérée comme "production ready"
Deprecated : l'API est considérée comme obsolète et devrait disparaître dans une version majeure prochaine
Pour le moment, la partie /containers/{cid} des paths n'est pas encore pris en compte mais doit être ajoutée à terme.

Licence

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

ArchiveUnits

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

/units get post put

get

Request that will return results composed of Units

post

Request that will return results composed of Units. The request is using POST with X-Http-Method-Override: GET

put

Request that will update a set of Units according to the query and the filter parts. The actions to be applied on the set of Units are specified in the action part of the request.

Request that will return results composed of Units

Secured by VitamPlatform

Based on Platform Secret

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```
Accept: required (one of application/json, application/zip, application/octet-stream)
Allow to specify if a result must contain only Metadata ('application/json'), or a complete DIP (one ZIP or TAR containing both Metadata and Binary object) ('application/zip' or 'application/x-tar') or only the Objects with a binary content ('application/octet-stream').
X-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

$roots: required (array)
Contains all root ids
$query: required (array)
Contains the queries (for all types)
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)
$data: (object)
Contains the data to insert (for POST only)

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

{
  "$roots": [ "id0" ],
  "$query": [
    { "$match": { "title": "titre" }, "$depth": 4 }
  ],
  "$filter": { "$limit": 1000, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#sector": 1, "#parents": 1, "#object": 1 } },
  "$facetQuery": { "$terms": "#object.#type" }
}

HTTP status code 200

Returns the list of Units results

Headers

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

Body

Media type: application/json

Examples:

{
  "$hits": {
    "total": 3,
    "size": 3,
    "offset": 0,
    "limit": 1000,
    "time_out": false
  },
  "$context": {
    "$roots": [ "id0" ],
    "$query": [
      { "$match": { "title": "titre" }, "$depth": 4 }
    ],
    "$filter": { "$limit": 1000, "$per_page": 10 },
    "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#sector": 1, "#parents": 1, "#object": 1 } },
    "$facetQuery": { "$terms": "#object.#type" }
  },
  "$results": [
    {
      "#id": "id1", "title": "titre 1", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id101", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id2", "title": "titre 2", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id102", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id3", "title": "titre 3", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id103", "#type": "Image",
        "#qualifiers": { "BinaryMaster": 3, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    }
  ],
  "$facet": {
    "#object.#type": { "Document": 2, "Image": 1 }
  }
}

Media type: application/zip

Type: object

Media type: application/x-tar

Type: object

Media type: application/octet-stream

Type: object

HTTP status code 206

Returns the list of Units results 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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Body

Media type: application/json

Type: object

Properties

$hits: required (object)
Contains the hits for the response

DSL Query for Access: required (object)

External Access Vitam DSL query

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

$results: required (array)
Contains list of items
FacetResponse: required (object)
Facet for a Response

Examples:

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

{
  "$hits": {
    "total": 3,
    "size": 3,
    "offset": 0,
    "limit": 1000,
    "time_out": false
  },
  "$context": {
    "$roots": [ "id0" ],
    "$query": [
      { "$match": { "title": "titre" }, "$depth": 4 }
    ],
    "$filter": { "$limit": 1000, "$per_page": 10 },
    "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#sector": 1, "#parents": 1, "#object": 1 } },
    "$facetQuery": { "$terms": "#object.#type" }
  },
  "$results": [
    {
      "#id": "id1", "title": "titre 1", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id101", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id2", "title": "titre 2", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id102", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id3", "title": "titre 3", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id103", "#type": "Image",
        "#qualifiers": { "BinaryMaster": 3, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    }
  ],
  "$facet": {
    "#object.#type": { "Document": 2, "Image": 1 }
  }
}

HTTP status code 401

Unauthorized, authentication in error

Headers

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

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

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

Request that will return results composed of Units. The request is using POST with X-Http-Method-Override: GET

Secured by VitamPlatform

Based on Platform Secret

Headers

X-Http-Method-Override: required (GET)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```
Accept: required (one of application/json, application/zip, application/octet-stream)
Allow to specify if a result must contain only Metadata ('application/json'), or a complete DIP (one ZIP or TAR containing both Metadata and Binary object) ('application/zip' or 'application/x-tar') or only the Objects with a binary content ('application/octet-stream').
X-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

$roots: required (array)
Contains all root ids
$query: required (array)
Contains the queries (for all types)
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)
$data: (object)
Contains the data to insert (for POST only)

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

{
  "$roots": [ "id0" ],
  "$query": [
    { "$match": { "title": "titre" }, "$depth": 4 }
  ],
  "$filter": { "$limit": 1000, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#sector": 1, "#parents": 1, "#object": 1 } },
  "$facetQuery": { "$terms": "#object.#type" }
}

HTTP status code 200

Returns the list of Units results

Headers

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

Body

Media type: application/json

Examples:

{
  "$hits": {
    "total": 3,
    "size": 3,
    "offset": 0,
    "limit": 1000,
    "time_out": false
  },
  "$context": {
    "$roots": [ "id0" ],
    "$query": [
      { "$match": { "title": "titre" }, "$depth": 4 }
    ],
    "$filter": { "$limit": 1000, "$per_page": 10 },
    "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#sector": 1, "#parents": 1, "#object": 1 } },
    "$facetQuery": { "$terms": "#object.#type" }
  },
  "$results": [
    {
      "#id": "id1", "title": "titre 1", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id101", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id2", "title": "titre 2", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id102", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id3", "title": "titre 3", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id103", "#type": "Image",
        "#qualifiers": { "BinaryMaster": 3, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    }
  ],
  "$facet": {
    "#object.#type": { "Document": 2, "Image": 1 }
  }
}

Media type: application/zip

Type: object

Media type: application/x-tar

Type: object

Media type: application/octet-stream

Type: object

HTTP status code 206

Returns the list of Units results 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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Body

Media type: application/json

Type: object

Properties

$hits: required (object)
Contains the hits for the response

DSL Query for Access: required (object)

External Access Vitam DSL query

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

$results: required (array)
Contains list of items
FacetResponse: required (object)
Facet for a Response

Examples:

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

{
  "$hits": {
    "total": 3,
    "size": 3,
    "offset": 0,
    "limit": 1000,
    "time_out": false
  },
  "$context": {
    "$roots": [ "id0" ],
    "$query": [
      { "$match": { "title": "titre" }, "$depth": 4 }
    ],
    "$filter": { "$limit": 1000, "$per_page": 10 },
    "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#sector": 1, "#parents": 1, "#object": 1 } },
    "$facetQuery": { "$terms": "#object.#type" }
  },
  "$results": [
    {
      "#id": "id1", "title": "titre 1", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id101", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id2", "title": "titre 2", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id102", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id3", "title": "titre 3", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id103", "#type": "Image",
        "#qualifiers": { "BinaryMaster": 3, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    }
  ],
  "$facet": {
    "#object.#type": { "Document": 2, "Image": 1 }
  }
}

HTTP status code 401

Unauthorized, authentication in error

Headers

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

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

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

Request that will update a set of Units according to the query and the filter parts. The actions to be applied on the set of Units are specified in the action part of the request.

Secured by VitamPlatform

Based on Platform Secret

Headers

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

Body

Media type: application/json

Type: object

Properties

$roots: required (array)
Contains all root ids
$query: required (array)
Contains the queries (for all types)
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)
$data: (object)
Contains the data to insert (for POST only)

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

{
  "$roots": [ "id3" ],
  "$query": [
  ],
  "$filter": {  },
  "$action": [{ "$set": { "NewField": "New value" } }]
}

HTTP status code 200

Returns the list of 1 or many Object result according to DSL query

Headers

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

Body

Media type: application/json

Type: object

Properties

$hits: required (object)
Contains the hits for the response

DSL Query for Access: required (object)

External Access Vitam DSL query

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

$results: required (array)
Contains list of items
FacetResponse: required (object)
Facet for a Response

Examples:

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

{
  "$hits": {
    "total": 1,
    "size": 1,
    "offset": 0,
    "limit": 1,
    "time_out": false
  },
  "$context": {
    "$roots": [ "id3" ],
    "$query": [
    ],
    "$filter": {  },
    "$action": [{ "$set": { "NewField": "New value" } }]
  },
  "$results": [
    {
      "#id": "id3", "title": "titre 3", "NewField": "New value",
      "#type": "DemandeCongés", "#sector": "RessourcesHumaines"
    }
  ]
}

HTTP status code 401

Unauthorized, authentication in error

Headers

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

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

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

/units/{idu} get post head put delete

API qui définit les requêtes pour accéder aux Unités d'archives à partir d'une Unité donnée (racine). La requête utilise le langage de requête (DSL) de Vitam en entrée et retourne une liste d'Unités d'archives selon le DSL Vitam en cas de succès.

get

Request that will return results composed of Units

post

Request that will return results composed of Units. The request is using POST with X-Http-Method-Override: GET

head

Test the existence of this Unit

put

Request that will update a set of Units according to the query and the filter parts. The actions to be applied on the set of Units are specified in the action part of the request. In this case this update is to be applied for only one Unit (the one specified in the URI).

delete

Request to destroy one Unit

Request that will return results composed of Units

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

idu: required (string)

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```
Accept: required (one of application/json, application/zip, application/octet-stream)
Allow to specify if a result must contain only Metadata ('application/json'), or a complete DIP (one ZIP or TAR containing both Metadata and Binary object) ('application/zip' or 'application/x-tar') or only the Objects with a binary content ('application/octet-stream').
X-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

$roots: required (array)
Contains all root ids
$query: required (array)
Contains the queries (for all types)
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)
$data: (object)
Contains the data to insert (for POST only)

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

{
  "$roots": [ "id0" ],
  "$query": [
    { "$match": { "title": "titre" }, "$depth": 4 }
  ],
  "$filter": { "$limit": 1000, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#sector": 1, "#parents": 1, "#object": 1 } },
  "$facetQuery": { "$terms": "#object.#type" }
}

HTTP status code 200

Returns the list of Units results

Headers

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

Body

Media type: application/json

Examples:

{
  "$hits": {
    "total": 3,
    "size": 3,
    "offset": 0,
    "limit": 1000,
    "time_out": false
  },
  "$context": {
    "$roots": [ "id0" ],
    "$query": [
      { "$match": { "title": "titre" }, "$depth": 4 }
    ],
    "$filter": { "$limit": 1000, "$per_page": 10 },
    "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#sector": 1, "#parents": 1, "#object": 1 } },
    "$facetQuery": { "$terms": "#object.#type" }
  },
  "$results": [
    {
      "#id": "id1", "title": "titre 1", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id101", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id2", "title": "titre 2", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id102", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id3", "title": "titre 3", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id103", "#type": "Image",
        "#qualifiers": { "BinaryMaster": 3, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    }
  ],
  "$facet": {
    "#object.#type": { "Document": 2, "Image": 1 }
  }
}

Media type: application/zip

Type: object

Media type: application/x-tar

Type: object

Media type: application/octet-stream

Type: object

HTTP status code 206

Returns the list of Units results 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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Body

Media type: application/json

Type: object

Properties

$hits: required (object)
Contains the hits for the response

DSL Query for Access: required (object)

External Access Vitam DSL query

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

$results: required (array)
Contains list of items
FacetResponse: required (object)
Facet for a Response

Examples:

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

{
  "$hits": {
    "total": 3,
    "size": 3,
    "offset": 0,
    "limit": 1000,
    "time_out": false
  },
  "$context": {
    "$roots": [ "id0" ],
    "$query": [
      { "$match": { "title": "titre" }, "$depth": 4 }
    ],
    "$filter": { "$limit": 1000, "$per_page": 10 },
    "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#sector": 1, "#parents": 1, "#object": 1 } },
    "$facetQuery": { "$terms": "#object.#type" }
  },
  "$results": [
    {
      "#id": "id1", "title": "titre 1", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id101", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id2", "title": "titre 2", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id102", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id3", "title": "titre 3", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id103", "#type": "Image",
        "#qualifiers": { "BinaryMaster": 3, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    }
  ],
  "$facet": {
    "#object.#type": { "Document": 2, "Image": 1 }
  }
}

HTTP status code 401

Unauthorized, authentication in error

Headers

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

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

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

Request that will return results composed of Units. 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
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```
Accept: required (one of application/json, application/zip, application/octet-stream)
Allow to specify if a result must contain only Metadata ('application/json'), or a complete DIP (one ZIP or TAR containing both Metadata and Binary object) ('application/zip' or 'application/x-tar') or only the Objects with a binary content ('application/octet-stream').
X-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

$roots: required (array)
Contains all root ids
$query: required (array)
Contains the queries (for all types)
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)
$data: (object)
Contains the data to insert (for POST only)

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

{
  "$roots": [ "id0" ],
  "$query": [
    { "$match": { "title": "titre" }, "$depth": 4 }
  ],
  "$filter": { "$limit": 1000, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#sector": 1, "#parents": 1, "#object": 1 } },
  "$facetQuery": { "$terms": "#object.#type" }
}

HTTP status code 200

Returns the list of Units results

Headers

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

Body

Media type: application/json

Examples:

{
  "$hits": {
    "total": 3,
    "size": 3,
    "offset": 0,
    "limit": 1000,
    "time_out": false
  },
  "$context": {
    "$roots": [ "id0" ],
    "$query": [
      { "$match": { "title": "titre" }, "$depth": 4 }
    ],
    "$filter": { "$limit": 1000, "$per_page": 10 },
    "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#sector": 1, "#parents": 1, "#object": 1 } },
    "$facetQuery": { "$terms": "#object.#type" }
  },
  "$results": [
    {
      "#id": "id1", "title": "titre 1", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id101", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id2", "title": "titre 2", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id102", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id3", "title": "titre 3", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id103", "#type": "Image",
        "#qualifiers": { "BinaryMaster": 3, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    }
  ],
  "$facet": {
    "#object.#type": { "Document": 2, "Image": 1 }
  }
}

Media type: application/zip

Type: object

Media type: application/x-tar

Type: object

Media type: application/octet-stream

Type: object

HTTP status code 201

Returns the Unit created as a list of 1

Headers

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

Body

Media type: application/json

Examples:

{
  "$hits": {
    "total": 3,
    "size": 3,
    "offset": 0,
    "limit": 1000,
    "time_out": false
  },
  "$context": {
    "$roots": [ "id0" ],
    "$query": [
      { "$match": { "title": "titre" }, "$depth": 4 }
    ],
    "$filter": { "$limit": 1000, "$per_page": 10 },
    "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#sector": 1, "#parents": 1, "#object": 1 } },
    "$facetQuery": { "$terms": "#object.#type" }
  },
  "$results": [
    {
      "#id": "id1", "title": "titre 1", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id101", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id2", "title": "titre 2", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id102", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id3", "title": "titre 3", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id103", "#type": "Image",
        "#qualifiers": { "BinaryMaster": 3, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    }
  ],
  "$facet": {
    "#object.#type": { "Document": 2, "Image": 1 }
  }
}

HTTP status code 206

Returns the list of Units results 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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Body

Media type: application/json

Type: object

Properties

$hits: required (object)
Contains the hits for the response

DSL Query for Access: required (object)

External Access Vitam DSL query

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

$results: required (array)
Contains list of items
FacetResponse: required (object)
Facet for a Response

Examples:

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

{
  "$hits": {
    "total": 3,
    "size": 3,
    "offset": 0,
    "limit": 1000,
    "time_out": false
  },
  "$context": {
    "$roots": [ "id0" ],
    "$query": [
      { "$match": { "title": "titre" }, "$depth": 4 }
    ],
    "$filter": { "$limit": 1000, "$per_page": 10 },
    "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#sector": 1, "#parents": 1, "#object": 1 } },
    "$facetQuery": { "$terms": "#object.#type" }
  },
  "$results": [
    {
      "#id": "id1", "title": "titre 1", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id101", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id2", "title": "titre 2", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id102", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id3", "title": "titre 3", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id103", "#type": "Image",
        "#qualifiers": { "BinaryMaster": 3, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    }
  ],
  "$facet": {
    "#object.#type": { "Document": 2, "Image": 1 }
  }
}

HTTP status code 401

Unauthorized, authentication in error

Headers

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

HTTP status code 404

Not Found, requested resource does not exist

Headers

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

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

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

Test the existence of this Unit

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

idu: required (string)

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```
X-Valid: (boolean)
Allow to check if the item is valid (exists and digest is correct)

HTTP status code 204

No Content, Used to test existence

Headers

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

HTTP status code 404

Not Found, requested resource does not exist

Headers

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

HTTP status code 417

Expectation Failed, used in Validation when the required validation (X-Valid) is in error

Headers

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

Secured by VitamPlatform

Headers

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

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

idu: required (string)

Headers

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

Body

Media type: application/json

Type: object

Properties

$roots: required (array)
Contains all root ids
$query: required (array)
Contains the queries (for all types)
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)
$data: (object)
Contains the data to insert (for POST only)

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

{
  "$roots": [ "id3" ],
  "$query": [
  ],
  "$filter": {  },
  "$action": [{ "$set": { "NewField": "New value" } }]
}

HTTP status code 200

Returns the list of 1 or many Object result according to DSL query

Headers

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

Body

Media type: application/json

Type: object

Properties

$hits: required (object)
Contains the hits for the response

DSL Query for Access: required (object)

External Access Vitam DSL query

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

$results: required (array)
Contains list of items
FacetResponse: required (object)
Facet for a Response

Examples:

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

{
  "$hits": {
    "total": 1,
    "size": 1,
    "offset": 0,
    "limit": 1,
    "time_out": false
  },
  "$context": {
    "$roots": [ "id3" ],
    "$query": [
    ],
    "$filter": {  },
    "$action": [{ "$set": { "NewField": "New value" } }]
  },
  "$results": [
    {
      "#id": "id3", "title": "titre 3", "NewField": "New value",
      "#type": "DemandeCongés", "#sector": "RessourcesHumaines"
    }
  ]
}

HTTP status code 401

Unauthorized, authentication in error

Headers

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

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

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

Request to destroy one Unit

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

idu: required (string)

Headers

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

Body

Media type: application/json

Type: object

Properties

$roots: required (array)
Contains all root ids
$query: required (array)
Contains the queries (for all types)
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)
$data: (object)
Contains the data to insert (for POST only)

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

{
  "$roots": [ "id3" ],
  "$query": [
  ],
  "$filter": {  },
  "$action": [{ "$set": { "NewField": "New value" } }]
}

HTTP status code 204

No Content, Used to test existence

Headers

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

HTTP status code 401

Unauthorized, authentication in error

Headers

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

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

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

/units/{idu}/objectgroup get post head put

API qui définit les requêtes pour accéder à l'Objet d'archives associé à l'Unité d'archives s'il existe. La requête utilise le langage de requête (DSL) de Vitam en entrée et retourne l'objet d'archives selon le DSL Vitam en cas de succès.

get

Request that will return results composed of Objects (generally 1)

post

Request that will return results composed of Objects (generally 1). The request is using POST with X-Http-Method-Override: GET

head

Test the existence of this Object

put

Request to add one ObjectGroup to this Unit

Request that will return results composed of Objects (generally 1)

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

idu: required (string)

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```
Accept: required (one of application/json, application/zip, application/octet-stream)
Allow to specify if a result must contain only Metadata ('application/json'), or a complete DIP (one ZIP or TAR containing both Metadata and Binary object) ('application/zip' or 'application/x-tar') or only the Objects with a binary content ('application/octet-stream').

Body

Media type: application/json

Type: object

Properties

$roots: required (array)
Contains all root ids
$query: required (array)
Contains the queries (for all types)
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)
$data: (object)
Contains the data to insert (for POST only)

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

{
  "$roots": [ "id0" ],
  "$query": [
    { "$match": { "title": "titre" }, "$depth": 4, "$source": "units" },
    { "$eq": { "#type": "Document" }, "$source": "objects" }
  ],
  "$filter": { "$limit": 1000, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "#qualifiers": 1, "#type": 1, "#parents": 1 } }
}

HTTP status code 200

Returns the list of 1 Object matching the DSL query

Headers

Qualifiers: required (one of PhysicalMaster, BinaryMaster, Dissemination, Thumbnail, TextContent, All)
Qualifiers for Objects. For the moment, only the number version of each qualifier is returned. (see examples) In the future, it would be possible to get the details of each qualifier, in a new field (#qualifiersMD)
X-Version: (integer)
The rank of the version only when used with Accept: application/octet-stream or application/zip or application/x-tar. If the rank is missing, it means the last version. Extra qualifier "All" means all Qualifiers and all Versions in conjunction with application/zip or application/x-tar for GET (HEAD allows all). ONLY VALID with Accept application/octet-stream, application/zip or application/x-tar
X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Body

Media type: application/zip

Type: object

Media type: application/x-tar

Type: object

Media type: application/octet-stream

Type: object

Media type: application/json

Examples:

{
  "$hits": {
    "total": 1,
    "size": 1,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$roots": [ ],
    "$query": [
    ],
    "$filter": {  },
    "$projection": { "$fields": { "#id": 1, "#qualifiers": 1, "#type": 1, "#parents": 1 } }
  },
  "$results": [
    {
      "#id": "id101", "#type": "Document",
      "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 },
      "#parents": [ { "#id": "id1", "#type": "DemandeCongés", "#sector": "RessourcesHumaines" } ]
    }
  ]
}

HTTP status code 401

Unauthorized, authentication in error

Headers

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

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

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

Request that will return results composed of Objects (generally 1). 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
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```
Accept: required (one of application/json, application/zip, application/octet-stream)
Allow to specify if a result must contain only Metadata ('application/json'), or a complete DIP (one ZIP or TAR containing both Metadata and Binary object) ('application/zip' or 'application/x-tar') or only the Objects with a binary content ('application/octet-stream').

Body

Media type: application/json

Type: object

Properties

$roots: required (array)
Contains all root ids
$query: required (array)
Contains the queries (for all types)
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)
$data: (object)
Contains the data to insert (for POST only)

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

{
  "$roots": [ "id0" ],
  "$query": [
    { "$match": { "title": "titre" }, "$depth": 4, "$source": "units" },
    { "$eq": { "#type": "Document" }, "$source": "objects" }
  ],
  "$filter": { "$limit": 1000, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "#qualifiers": 1, "#type": 1, "#parents": 1 } }
}

HTTP status code 200

Returns the list of 1 Object matching the DSL query

Headers

Qualifiers: required (one of PhysicalMaster, BinaryMaster, Dissemination, Thumbnail, TextContent, All)
Qualifiers for Objects. For the moment, only the number version of each qualifier is returned. (see examples) In the future, it would be possible to get the details of each qualifier, in a new field (#qualifiersMD)
X-Version: (integer)
The rank of the version only when used with Accept: application/octet-stream or application/zip or application/x-tar. If the rank is missing, it means the last version. Extra qualifier "All" means all Qualifiers and all Versions in conjunction with application/zip or application/x-tar for GET (HEAD allows all). ONLY VALID with Accept application/octet-stream, application/zip or application/x-tar
X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Body

Media type: application/zip

Type: object

Media type: application/x-tar

Type: object

Media type: application/octet-stream

Type: object

Media type: application/json

Examples:

{
  "$hits": {
    "total": 1,
    "size": 1,
    "offset": 0,
    "limit": 100,
    "time_out": false
  },
  "$context": {
    "$roots": [ ],
    "$query": [
    ],
    "$filter": {  },
    "$projection": { "$fields": { "#id": 1, "#qualifiers": 1, "#type": 1, "#parents": 1 } }
  },
  "$results": [
    {
      "#id": "id101", "#type": "Document",
      "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 },
      "#parents": [ { "#id": "id1", "#type": "DemandeCongés", "#sector": "RessourcesHumaines" } ]
    }
  ]
}

HTTP status code 401

Unauthorized, authentication in error

Headers

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

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

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

Test the existence of this Object

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

idu: required (string)

Headers

Qualifiers: required (one of PhysicalMaster, BinaryMaster, Dissemination, Thumbnail, TextContent, All)
Qualifiers for Objects. For the moment, only the number version of each qualifier is returned. (see examples) In the future, it would be possible to get the details of each qualifier, in a new field (#qualifiersMD)
X-Version: (integer)
The rank of the version only when used with Accept: application/octet-stream or application/zip or application/x-tar. If the rank is missing, it means the last version. Extra qualifier "All" means all Qualifiers and all Versions in conjunction with application/zip or application/x-tar for GET (HEAD allows all). ONLY VALID with Accept application/octet-stream, application/zip or application/x-tar
X-Valid: (boolean)
Allow to check if the item is valid (exists and digest is correct)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```
Accept: required (one of application/json, application/zip, application/octet-stream)
Allow to specify if a result must contain only Metadata ('application/json'), or a complete DIP (one ZIP or TAR containing both Metadata and Binary object) ('application/zip' or 'application/x-tar') or only the Objects with a binary content ('application/octet-stream').

HTTP status code 204

No Content, Used to test existence

Headers

Qualifiers: required (one of PhysicalMaster, BinaryMaster, Dissemination, Thumbnail, TextContent, All)
Qualifiers for Objects. For the moment, only the number version of each qualifier is returned. (see examples) In the future, it would be possible to get the details of each qualifier, in a new field (#qualifiersMD)
X-Version: (integer)
The rank of the version only when used with Accept: application/octet-stream or application/zip or application/x-tar. If the rank is missing, it means the last version. Extra qualifier "All" means all Qualifiers and all Versions in conjunction with application/zip or application/x-tar for GET (HEAD allows all). ONLY VALID with Accept application/octet-stream, application/zip or application/x-tar
X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

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

HTTP status code 417

Expectation Failed, used in Validation when the required validation (X-Valid) is in error

Headers

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

Secured by VitamPlatform

Headers

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

Request to add one ObjectGroup to this Unit

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

idu: required (string)

Headers

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

Body

Media type: application/json

Type: object

Properties

$roots: required (array)
Contains all root ids
$query: required (array)
Contains the queries (for all types)
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)
$data: (object)
Contains the data to insert (for POST only)

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

{
  "$roots": [ "id3" ],
  "$query": [
  ],
  "$filter": {  },
  "$action": [{ "$set": { "NewField": "New value" } }]
}

HTTP status code 200

Returns the list of 1 or many Object result according to DSL query

Headers

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

Body

Media type: application/json

Type: object

Properties

$hits: required (object)
Contains the hits for the response

DSL Query for Access: required (object)

External Access Vitam DSL query

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

$results: required (array)
Contains list of items
FacetResponse: required (object)
Facet for a Response

Examples:

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

{
  "$hits": {
    "total": 1,
    "size": 1,
    "offset": 0,
    "limit": 1,
    "time_out": false
  },
  "$context": {
    "$roots": [ "id3" ],
    "$query": [
    ],
    "$filter": {  },
    "$action": [{ "$set": { "NewField": "New value" } }]
  },
  "$results": [
    {
      "#id": "id3", "title": "titre 3", "NewField": "New value",
      "#type": "DemandeCongés", "#sector": "RessourcesHumaines"
    }
  ]
}

HTTP status code 401

Unauthorized, authentication in error

Headers

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

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

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

Objects

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

/objects get post

get

Request that will return results composed of Objects

post

Request that will return results composed of Objects. The request is using POST with X-Http-Method-Override: GET

Request that will return results composed of Objects

Secured by VitamPlatform

Based on Platform Secret

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```
Accept: required (one of application/json, application/zip, application/octet-stream)
Allow to specify if a result must contain only Metadata ('application/json'), or a complete DIP (one ZIP or TAR containing both Metadata and Binary object) ('application/zip' or 'application/x-tar') or only the Objects with a binary content ('application/octet-stream').
X-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

$roots: required (array)
Contains all root ids
$query: required (array)
Contains the queries (for all types)
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)
$data: (object)
Contains the data to insert (for POST only)

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

{
  "$roots": [ "id0" ],
  "$query": [
    { "$match": { "title": "titre" }, "$depth": 4, "$source": "units" },
    { "$eq": { "#type": "Document" }, "$source": "objects" }
  ],
  "$filter": { "$limit": 1000, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "#qualifiers": 1, "#type": 1, "#parents": 1 } }
}

HTTP status code 200

Returns the list of Objects matching the DSL query

Headers

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

Body

Media type: application/json

Examples:

{
  "$hits": {
    "total": 3,
    "size": 3,
    "offset": 0,
    "limit": 1000,
    "time_out": false
  },
  "$context": {
    "$roots": [ "id0" ],
    "$query": [
      { "$match": { "title": "titre" }, "$depth": 4, "$source": "units" },
      { "$eq": { "#type": "Document" }, "$source": "objects" }
    ],
    "$filter": { "$limit": 1000, "$per_page": 10 },
    "$projection": { "$fields": { "#id": 1, "#qualifiers": 1, "#type": 1, "#parents": 1 } }
  },
  "$results": [
    {
      "#id": "id101", "#type": "Document",
      "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 },
      "#parents": [ { "#id": "id1", "#type": "DemandeCongés", "#sector": "RessourcesHumaines" } ]
    },
    {
      "#id": "id102", "#type": "Document",
      "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 },
      "#parents": [ { "#id": "id2", "#type": "DemandeCongés", "#sector": "RessourcesHumaines" } ]
    },
    {
      "#id": "id103", "#type": "Document",
      "#qualifiers": { "BinaryMaster": 3, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 },
      "#parents": [ { "#id": "id3", "#type": "DemandeCongés", "#sector": "RessourcesHumaines" } ]
    }
  ]
}

Media type: application/zip

Type: object

Media type: application/x-tar

Type: object

Media type: application/octet-stream

Type: object

HTTP status code 206

Returns the list of Objects matching the DSL query, 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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Body

Media type: application/json

Type: object

Properties

$hits: required (object)
Contains the hits for the response

DSL Query for Access: required (object)

External Access Vitam DSL query

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

$results: required (array)
Contains list of items
FacetResponse: required (object)
Facet for a Response

Examples:

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

{
  "$hits": {
    "total": 3,
    "size": 3,
    "offset": 0,
    "limit": 1000,
    "time_out": false
  },
  "$context": {
    "$roots": [ "id0" ],
    "$query": [
      { "$match": { "title": "titre" }, "$depth": 4, "$source": "units" },
      { "$eq": { "#type": "Document" }, "$source": "objects" }
    ],
    "$filter": { "$limit": 1000, "$per_page": 10 },
    "$projection": { "$fields": { "#id": 1, "#qualifiers": 1, "#type": 1, "#parents": 1 } }
  },
  "$results": [
    {
      "#id": "id101", "#type": "Document",
      "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 },
      "#parents": [ { "#id": "id1", "#type": "DemandeCongés", "#sector": "RessourcesHumaines" } ]
    },
    {
      "#id": "id102", "#type": "Document",
      "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 },
      "#parents": [ { "#id": "id2", "#type": "DemandeCongés", "#sector": "RessourcesHumaines" } ]
    },
    {
      "#id": "id103", "#type": "Document",
      "#qualifiers": { "BinaryMaster": 3, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 },
      "#parents": [ { "#id": "id3", "#type": "DemandeCongés", "#sector": "RessourcesHumaines" } ]
    }
  ]
}

HTTP status code 401

Unauthorized, authentication in error

Headers

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

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

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

Request that will return results composed of Objects. The request is using POST with X-Http-Method-Override: GET

Secured by VitamPlatform

Based on Platform Secret

Headers

X-Http-Method-Override: required (GET)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```
Accept: required (one of application/json, application/zip, application/octet-stream)
Allow to specify if a result must contain only Metadata ('application/json'), or a complete DIP (one ZIP or TAR containing both Metadata and Binary object) ('application/zip' or 'application/x-tar') or only the Objects with a binary content ('application/octet-stream').
X-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

$roots: required (array)
Contains all root ids
$query: required (array)
Contains the queries (for all types)
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)
$data: (object)
Contains the data to insert (for POST only)

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

{
  "$roots": [ "id0" ],
  "$query": [
    { "$match": { "title": "titre" }, "$depth": 4, "$source": "units" },
    { "$eq": { "#type": "Document" }, "$source": "objects" }
  ],
  "$filter": { "$limit": 1000, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "#qualifiers": 1, "#type": 1, "#parents": 1 } }
}

HTTP status code 200

Returns the list of Objects matching the DSL query

Headers

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

Body

Media type: application/json

Examples:

{
  "$hits": {
    "total": 3,
    "size": 3,
    "offset": 0,
    "limit": 1000,
    "time_out": false
  },
  "$context": {
    "$roots": [ "id0" ],
    "$query": [
      { "$match": { "title": "titre" }, "$depth": 4, "$source": "units" },
      { "$eq": { "#type": "Document" }, "$source": "objects" }
    ],
    "$filter": { "$limit": 1000, "$per_page": 10 },
    "$projection": { "$fields": { "#id": 1, "#qualifiers": 1, "#type": 1, "#parents": 1 } }
  },
  "$results": [
    {
      "#id": "id101", "#type": "Document",
      "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 },
      "#parents": [ { "#id": "id1", "#type": "DemandeCongés", "#sector": "RessourcesHumaines" } ]
    },
    {
      "#id": "id102", "#type": "Document",
      "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 },
      "#parents": [ { "#id": "id2", "#type": "DemandeCongés", "#sector": "RessourcesHumaines" } ]
    },
    {
      "#id": "id103", "#type": "Document",
      "#qualifiers": { "BinaryMaster": 3, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 },
      "#parents": [ { "#id": "id3", "#type": "DemandeCongés", "#sector": "RessourcesHumaines" } ]
    }
  ]
}

Media type: application/zip

Type: object

Media type: application/x-tar

Type: object

Media type: application/octet-stream

Type: object

HTTP status code 206

Returns the list of Objects matching the DSL query, 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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Body

Media type: application/json

Type: object

Properties

$hits: required (object)
Contains the hits for the response

DSL Query for Access: required (object)

External Access Vitam DSL query

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

$results: required (array)
Contains list of items
FacetResponse: required (object)
Facet for a Response

Examples:

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

{
  "$hits": {
    "total": 3,
    "size": 3,
    "offset": 0,
    "limit": 1000,
    "time_out": false
  },
  "$context": {
    "$roots": [ "id0" ],
    "$query": [
      { "$match": { "title": "titre" }, "$depth": 4, "$source": "units" },
      { "$eq": { "#type": "Document" }, "$source": "objects" }
    ],
    "$filter": { "$limit": 1000, "$per_page": 10 },
    "$projection": { "$fields": { "#id": 1, "#qualifiers": 1, "#type": 1, "#parents": 1 } }
  },
  "$results": [
    {
      "#id": "id101", "#type": "Document",
      "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 },
      "#parents": [ { "#id": "id1", "#type": "DemandeCongés", "#sector": "RessourcesHumaines" } ]
    },
    {
      "#id": "id102", "#type": "Document",
      "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 },
      "#parents": [ { "#id": "id2", "#type": "DemandeCongés", "#sector": "RessourcesHumaines" } ]
    },
    {
      "#id": "id103", "#type": "Document",
      "#qualifiers": { "BinaryMaster": 3, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 },
      "#parents": [ { "#id": "id3", "#type": "DemandeCongés", "#sector": "RessourcesHumaines" } ]
    }
  ]
}

HTTP status code 401

Unauthorized, authentication in error

Headers

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

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

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

/objects/{ido} get post head put delete

API qui définit les requêtes pour accéder aux Objets d'archives à partir d'un Objet d'archives donné (racine). La requête utilise le langage de requête (DSL) de Vitam en entrée et retourne une liste d'Objets d'archives selon le DSL Vitam en cas de succès.

get

Request that will return results composed of Objects (generally 1)

post

Request that will return results composed of Objects (generally 1). The request is using POST with X-Http-Method-Override: GET

head

Test the existence of this Object

put

Request to update one ObjectGroup

delete

Request to delete one ObjectGroup

Request that will return results composed of Objects (generally 1)

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

ido: required (string)

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```
Accept: required (one of application/json, application/zip, application/octet-stream)
Allow to specify if a result must contain only Metadata ('application/json'), or a complete DIP (one ZIP or TAR containing both Metadata and Binary object) ('application/zip' or 'application/x-tar') or only the Objects with a binary content ('application/octet-stream').
X-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

$roots: required (array)
Contains all root ids
$query: required (array)
Contains the queries (for all types)
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)
$data: (object)
Contains the data to insert (for POST only)

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

{
  "$roots": [ "id0" ],
  "$query": [
    { "$match": { "title": "titre" }, "$depth": 4, "$source": "units" },
    { "$eq": { "#type": "Document" }, "$source": "objects" }
  ],
  "$filter": { "$limit": 1000, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "#qualifiers": 1, "#type": 1, "#parents": 1 } }
}

HTTP status code 200

Returns the list of 1 Object matching the DSL query

Headers

Qualifiers: required (one of PhysicalMaster, BinaryMaster, Dissemination, Thumbnail, TextContent, All)
Qualifiers for Objects. For the moment, only the number version of each qualifier is returned. (see examples) In the future, it would be possible to get the details of each qualifier, in a new field (#qualifiersMD)
X-Version: (integer)
The rank of the version only when used with Accept: application/octet-stream or application/zip or application/x-tar. If the rank is missing, it means the last version. Extra qualifier "All" means all Qualifiers and all Versions in conjunction with application/zip or application/x-tar for GET (HEAD allows all). ONLY VALID with Accept application/octet-stream, application/zip or application/x-tar
X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Body

Media type: application/zip

Type: object

Media type: application/x-tar

Type: object

Media type: application/octet-stream

Type: object

Media type: application/json

Examples:

{
  "$hits": {
    "total": 3,
    "size": 3,
    "offset": 0,
    "limit": 1000,
    "time_out": false
  },
  "$context": {
    "$roots": [ "id0" ],
    "$query": [
      { "$match": { "title": "titre" }, "$depth": 4, "$source": "units" },
      { "$eq": { "#type": "Document" }, "$source": "objects" }
    ],
    "$filter": { "$limit": 1000, "$per_page": 10 },
    "$projection": { "$fields": { "#id": 1, "#qualifiers": 1, "#type": 1, "#parents": 1 } }
  },
  "$results": [
    {
      "#id": "id101", "#type": "Document",
      "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 },
      "#parents": [ { "#id": "id1", "#type": "DemandeCongés", "#sector": "RessourcesHumaines" } ]
    },
    {
      "#id": "id102", "#type": "Document",
      "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 },
      "#parents": [ { "#id": "id2", "#type": "DemandeCongés", "#sector": "RessourcesHumaines" } ]
    },
    {
      "#id": "id103", "#type": "Document",
      "#qualifiers": { "BinaryMaster": 3, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 },
      "#parents": [ { "#id": "id3", "#type": "DemandeCongés", "#sector": "RessourcesHumaines" } ]
    }
  ]
}

HTTP status code 206

Returns the list of Objects matching the DSL query, 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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Body

Media type: application/json

Type: object

Properties

$hits: required (object)
Contains the hits for the response

DSL Query for Access: required (object)

External Access Vitam DSL query

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

$results: required (array)
Contains list of items
FacetResponse: required (object)
Facet for a Response

Examples:

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

{
  "$hits": {
    "total": 3,
    "size": 3,
    "offset": 0,
    "limit": 1000,
    "time_out": false
  },
  "$context": {
    "$roots": [ "id0" ],
    "$query": [
      { "$match": { "title": "titre" }, "$depth": 4, "$source": "units" },
      { "$eq": { "#type": "Document" }, "$source": "objects" }
    ],
    "$filter": { "$limit": 1000, "$per_page": 10 },
    "$projection": { "$fields": { "#id": 1, "#qualifiers": 1, "#type": 1, "#parents": 1 } }
  },
  "$results": [
    {
      "#id": "id101", "#type": "Document",
      "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 },
      "#parents": [ { "#id": "id1", "#type": "DemandeCongés", "#sector": "RessourcesHumaines" } ]
    },
    {
      "#id": "id102", "#type": "Document",
      "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 },
      "#parents": [ { "#id": "id2", "#type": "DemandeCongés", "#sector": "RessourcesHumaines" } ]
    },
    {
      "#id": "id103", "#type": "Document",
      "#qualifiers": { "BinaryMaster": 3, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 },
      "#parents": [ { "#id": "id3", "#type": "DemandeCongés", "#sector": "RessourcesHumaines" } ]
    }
  ]
}

HTTP status code 401

Unauthorized, authentication in error

Headers

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

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

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

Request that will return results composed of Objects (generally 1). The request is using POST with X-Http-Method-Override: GET

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

ido: required (string)

Headers

X-Http-Method-Override: required (GET)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```
Accept: required (one of application/json, application/zip, application/octet-stream)
Allow to specify if a result must contain only Metadata ('application/json'), or a complete DIP (one ZIP or TAR containing both Metadata and Binary object) ('application/zip' or 'application/x-tar') or only the Objects with a binary content ('application/octet-stream').
X-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

$roots: required (array)
Contains all root ids
$query: required (array)
Contains the queries (for all types)
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)
$data: (object)
Contains the data to insert (for POST only)

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

{
  "$roots": [ "id0" ],
  "$query": [
    { "$match": { "title": "titre" }, "$depth": 4 }
  ],
  "$filter": { "$limit": 1000, "$per_page": 10 },
  "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#sector": 1, "#parents": 1, "#object": 1 } },
  "$facetQuery": { "$terms": "#object.#type" }
}

HTTP status code 200

Returns the list of 1 Object matching the DSL query

Headers

Qualifiers: required (one of PhysicalMaster, BinaryMaster, Dissemination, Thumbnail, TextContent, All)
Qualifiers for Objects. For the moment, only the number version of each qualifier is returned. (see examples) In the future, it would be possible to get the details of each qualifier, in a new field (#qualifiersMD)
X-Version: (integer)
The rank of the version only when used with Accept: application/octet-stream or application/zip or application/x-tar. If the rank is missing, it means the last version. Extra qualifier "All" means all Qualifiers and all Versions in conjunction with application/zip or application/x-tar for GET (HEAD allows all). ONLY VALID with Accept application/octet-stream, application/zip or application/x-tar
X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Body

Media type: application/zip

Type: object

Media type: application/x-tar

Type: object

Media type: application/octet-stream

Type: object

Media type: application/json

Examples:

{
  "$hits": {
    "total": 3,
    "size": 3,
    "offset": 0,
    "limit": 1000,
    "time_out": false
  },
  "$context": {
    "$roots": [ "id0" ],
    "$query": [
      { "$match": { "title": "titre" }, "$depth": 4 }
    ],
    "$filter": { "$limit": 1000, "$per_page": 10 },
    "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#sector": 1, "#parents": 1, "#object": 1 } },
    "$facetQuery": { "$terms": "#object.#type" }
  },
  "$results": [
    {
      "#id": "id1", "title": "titre 1", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id101", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id2", "title": "titre 2", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id102", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id3", "title": "titre 3", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id103", "#type": "Image",
        "#qualifiers": { "BinaryMaster": 3, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    }
  ],
  "$facet": {
    "#object.#type": { "Document": 2, "Image": 1 }
  }
}

HTTP status code 201

Returns the ObjectGroup created as a list of 1

Headers

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

Body

Media type: application/json

Examples:

{
  "$hits": {
    "total": 3,
    "size": 3,
    "offset": 0,
    "limit": 1000,
    "time_out": false
  },
  "$context": {
    "$roots": [ "id0" ],
    "$query": [
      { "$match": { "title": "titre" }, "$depth": 4 }
    ],
    "$filter": { "$limit": 1000, "$per_page": 10 },
    "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#sector": 1, "#parents": 1, "#object": 1 } },
    "$facetQuery": { "$terms": "#object.#type" }
  },
  "$results": [
    {
      "#id": "id1", "title": "titre 1", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id101", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id2", "title": "titre 2", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id102", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id3", "title": "titre 3", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id103", "#type": "Image",
        "#qualifiers": { "BinaryMaster": 3, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    }
  ],
  "$facet": {
    "#object.#type": { "Document": 2, "Image": 1 }
  }
}

HTTP status code 206

Returns the list of ObjectGroup results 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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Body

Media type: application/json

Type: object

Properties

$hits: required (object)
Contains the hits for the response

DSL Query for Access: required (object)

External Access Vitam DSL query

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

$results: required (array)
Contains list of items
FacetResponse: required (object)
Facet for a Response

Examples:

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

{
  "$hits": {
    "total": 3,
    "size": 3,
    "offset": 0,
    "limit": 1000,
    "time_out": false
  },
  "$context": {
    "$roots": [ "id0" ],
    "$query": [
      { "$match": { "title": "titre" }, "$depth": 4 }
    ],
    "$filter": { "$limit": 1000, "$per_page": 10 },
    "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#sector": 1, "#parents": 1, "#object": 1 } },
    "$facetQuery": { "$terms": "#object.#type" }
  },
  "$results": [
    {
      "#id": "id1", "title": "titre 1", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id101", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id2", "title": "titre 2", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id102", "#type": "Document",
        "#qualifiers": { "BinaryMaster": 5, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    },
    {
      "#id": "id3", "title": "titre 3", "#type": "DemandeCongés", "#sector": "RessourcesHumaines",
      "#parents": [ { "#id": "id4", "#type": "DossierCongés", "#sector": "RessourcesHumaines" } ],
      "#object": { "#id": "id103", "#type": "Image",
        "#qualifiers": { "BinaryMaster": 3, "Dissemination": 1, "Thumbnail": 1, "TextContent": 1 } }
    }
  ],
  "$facet": {
    "#object.#type": { "Document": 2, "Image": 1 }
  }
}

HTTP status code 401

Unauthorized, authentication in error

Headers

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

HTTP status code 404

Not Found, requested resource does not exist

Headers

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

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

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

Test the existence of this Object

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

ido: required (string)

Headers

Qualifiers: required (one of PhysicalMaster, BinaryMaster, Dissemination, Thumbnail, TextContent, All)
Qualifiers for Objects. For the moment, only the number version of each qualifier is returned. (see examples) In the future, it would be possible to get the details of each qualifier, in a new field (#qualifiersMD)
X-Version: (integer)
The rank of the version only when used with Accept: application/octet-stream or application/zip or application/x-tar. If the rank is missing, it means the last version. Extra qualifier "All" means all Qualifiers and all Versions in conjunction with application/zip or application/x-tar for GET (HEAD allows all). ONLY VALID with Accept application/octet-stream, application/zip or application/x-tar
X-Valid: (boolean)
Allow to check if the item is valid (exists and digest is correct)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```
Accept: required (one of application/json, application/zip, application/octet-stream)
Allow to specify if a result must contain only Metadata ('application/json'), or a complete DIP (one ZIP or TAR containing both Metadata and Binary object) ('application/zip' or 'application/x-tar') or only the Objects with a binary content ('application/octet-stream').

HTTP status code 204

No Content, Used to test existence

Headers

Qualifiers: required (one of PhysicalMaster, BinaryMaster, Dissemination, Thumbnail, TextContent, All)
Qualifiers for Objects. For the moment, only the number version of each qualifier is returned. (see examples) In the future, it would be possible to get the details of each qualifier, in a new field (#qualifiersMD)
X-Version: (integer)
The rank of the version only when used with Accept: application/octet-stream or application/zip or application/x-tar. If the rank is missing, it means the last version. Extra qualifier "All" means all Qualifiers and all Versions in conjunction with application/zip or application/x-tar for GET (HEAD allows all). ONLY VALID with Accept application/octet-stream, application/zip or application/x-tar
X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

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

HTTP status code 417

Expectation Failed, used in Validation when the required validation (X-Valid) is in error

Headers

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

Secured by VitamPlatform

Headers

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

Request to update one ObjectGroup

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

ido: required (string)

Headers

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

Body

Media type: application/json

Type: object

Properties

$roots: required (array)
Contains all root ids
$query: required (array)
Contains the queries (for all types)
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)
$data: (object)
Contains the data to insert (for POST only)

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

{
  "$roots": [ "id3" ],
  "$query": [
  ],
  "$filter": {  },
  "$action": [{ "$set": { "NewField": "New value" } }]
}

HTTP status code 200

Returns the list of 1 or many Object result according to DSL query

Headers

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

Body

Media type: application/json

Type: object

Properties

$hits: required (object)
Contains the hits for the response

DSL Query for Access: required (object)

External Access Vitam DSL query

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

$results: required (array)
Contains list of items
FacetResponse: required (object)
Facet for a Response

Examples:

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

{
  "$hits": {
    "total": 1,
    "size": 1,
    "offset": 0,
    "limit": 1,
    "time_out": false
  },
  "$context": {
    "$roots": [ "id3" ],
    "$query": [
    ],
    "$filter": {  },
    "$action": [{ "$set": { "NewField": "New value" } }]
  },
  "$results": [
    {
      "#id": "id3", "title": "titre 3", "NewField": "New value",
      "#type": "DemandeCongés", "#sector": "RessourcesHumaines"
    }
  ]
}

HTTP status code 401

Unauthorized, authentication in error

Headers

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

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

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

Request to delete one ObjectGroup

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

ido: required (string)

Headers

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

Body

Media type: application/json

Type: object

Properties

$roots: required (array)
Contains all root ids
$query: required (array)
Contains the queries (for all types)
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)
$data: (object)
Contains the data to insert (for POST only)

Examples:

{
  "$roots": [
    "bbb"
  ],
  "$query": [
    {
      "$path": "aaaaa"
    }
  ]
}

{
  "$roots": [ "id3" ],
  "$query": [
  ],
  "$filter": {  },
  "$action": [{ "$set": { "NewField": "New value" } }]
}

HTTP status code 204

No Content, Used to test existence

Headers

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

HTTP status code 401

Unauthorized, authentication in error

Headers

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

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

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

Raw

API d'accès aux métadonnées en mode brut (pas de traduction Vitam).

/raw/units/{id_unit} get

Récupère un Unit.

get

Get a Unit

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

id_unit: required (string)

Headers

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

HTTP status code 200

Returns the list of Units results containing one result

Headers

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

Body

Media type: application/json

Type: object

Examples:

{
	"$hits": {
		"total": 1,
		"size": 1,
		"offset": 0,
		"limit": 1000
	},
	"$context": {},
	"$results": [
		{
			"_id": "aeaqaaaaaafukrl4aa4i4alb2jxjxzqaaaaq",
			"_og": "aebaaaaaaafukrl4aa4i4alb2jxjwmqaaaaq",
			"_mgt": {
				"OriginatingAgency": "FRAN_NP_050770"
			},
			"DescriptionLevel": "Item",
			"Title": "Archive unit ID0910",
			"Titles": {
				"fr": "Archive unit ID0910"
			},
			"Description": "Curabitur et velit ornare, consectetur mi sed, volutpat augue. Duis semper, mauris eget luctus facilisis, tortor purus euismod mi, id vulputate augue nulla sit amet sapien. Sed posuere porta tortor vel tempus. Donec in vestibulum tellus.",
			"Descriptions": {
				"fr": "Curabitur et velit ornare, consectetur mi sed, volutpat augue. Duis semper, mauris eget luctus facilisis, tortor purus euismod mi, id vulputate augue nulla sit amet sapien. Sed posuere porta tortor vel tempus. Donec in vestibulum tellus."
			},
			"TransactedDate": "2016-06-08T10:16:16",
			"_storage": {
				"_nbc": 1,
				"offerIds": [
					"offer1"
				],
				"strategyId": "default"
			},
			"_sps": [
				"FRAN_NP_050770"
			],
			"_sp": "FRAN_NP_050770",
			"_ops": [
				"aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq"
			],
			"_opi": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
			"_unitType": "INGEST",
			"_max": 9,
			"_min": 1,
			"_up": [
				"aeaqaaaaaafukrl4aa4i4alb2jxjxxaaaaba"
			],
			"_nbc": 0,
			"_us": [
				"aeaqaaaaaafukrl4aa4i4alb2jxjxvqaaaba",
				"aeaqaaaaaafukrl4aa4i4alb2jxjxxaaaaba"
			],
			"_uds": {
				"aeaqaaaaaafukrl4aa4i4alb2jxjxvqaaaba": 2,
				"aeaqaaaaaafukrl4aa4i4alb2jxjxxaaaaba": 1
			},
			"_v": 0,
			"_tenant": 0
		}
	]
}

HTTP status code 401

Unauthorized, authentication in error

Headers

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

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

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

/raw/objectgroups/{id_og} get

Récupère un Groupe d'Objet.

get

Get an Object

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

id_og: required (string)

Headers

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

HTTP status code 200

Returns the list of Objects results containing one result

Headers

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

Body

Media type: application/json

Type: object

Examples:

{
	"$hits": {
		"total": 1,
		"size": 1,
		"offset": 0,
		"limit": 1000
	},
	"$context": {},
	"$results": [
		{
			"_id": "aebaaaaaaafukrl4aa4i4alb2jxjwmqaaaaq",
			"_tenant": 0,
			"_profil": "",
			"FileInfo": {
				"Filename": "KEpK4t9AS8oYpbWkr4rWo10vcfIBXM",
				"LastModified": "2016-06-08T10:16:16.000+02:00"
			},
			"_qualifiers": [
				{
					"qualifier": "BinaryMaster",
					"_nbc": 1,
					"versions": [
						{
							"_id": "aeaaaaaaaafukrl4aa4i4alb2jxjwmiaaaaq",
							"DataObjectGroupId": "aebaaaaaaafukrl4aa4i4alb2jxjwmqaaaaq",
							"DataObjectVersion": "BinaryMaster_1",
							"FormatIdentification": {
								"FormatLitteral": "OpenDocument Text",
								"MimeType": "application/vnd.oasis.opendocument.text",
								"FormatId": "fmt/291"
							},
							"FileInfo": {
								"Filename": "KEpK4t9AS8oYpbWkr4rWo10vcfIBXM",
								"LastModified": "2016-06-08T10:16:16.000+02:00"
							},
							"Size": 68438,
							"Uri": "Content/KEpK4t9AS8oYpbWkr4rWo10vcfIBXM.odt",
							"MessageDigest": "58e37fa092797145f2a0d063ebf8699b9725ab9955ebc2aa503539c3d7c39ab4f867ffb02595782195f2f94ac23017f9a78c1b10c2fc37287227a7673e2b8c28",
							"Algorithm": "SHA-512",
							"_storage": {
								"_nbc": 1,
								"offerIds": [
									"offer-fs-1.service.consul"
								],
								"strategyId": "default"
							}
						}
					]
				}
			],
			"_up": [
				"aeaqaaaaaafukrl4aa4i4alb2jxjxzqaaaaq"
			],
			"_nbc": 1,
			"_ops": [
				"aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq"
			],
			"_opi": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
			"_sp": "FRAN_NP_050770",
			"_sps": [
				"FRAN_NP_050770"
			],
			"_storage": {
				"_nbc": 1,
				"offerIds": [
					"offer1"
				],
				"strategyId": "default"
			},
			"_v": 0
		}
	]
}

HTTP status code 401

Unauthorized, authentication in error

Headers

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

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

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

/status

/status get

get

Secured by VitamPlatform

Based on Platform Secret

Response
Security

HTTP status code 200

OK, operation in success

Headers

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

Body

Media type: application/json

Type: object

Properties

id: required (string)
Id of the instance
service: required (string)
Service Name for this instance
startDate: required (datetime)
Date time for the start of this instance
status: required (one of Active, Inactive, ShutdownInProgress, Unreachable)
Status of this instance

Examples:

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

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

HTTP status code 401

Unauthorized, authentication in error

Headers

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

HTTP status code 404

Not Found, requested resource does not exist

Headers

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

API-Vitam Version Alpha - Metadata interne API documentation version v1

Avertissements

Licence

API Metadata

ArchiveUnits

/units get post put

get /units

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 /units

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 /units

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

/units/{idu} get post head put delete

get /units/{idu}

URI Parameters

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

URI Parameters

Headers

Body

HTTP status code 200

Headers

Body