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

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

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).

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

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

/units/{idu}/object get post head

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

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

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

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

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, "$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

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

Operations Logbooks

API d'accès aux Journaux d'opérations (Logbooks Operations). Ce point d'entrée permet de chercher une opération (entrée, audit, élimination, préservation, ...).

La recherche sur cette API retourne pour chaque opération, la première entrée (la création à la date de démarrage de l'opération) et la dernière entrée (dans l'état connu par le journal à la date de la dernière étape de cette opération).

/operations get post

get

Response model for the listing of Logbook operations.

post

Response model for the listing of Logbook operations. The request is using POST with X-Http-Method-Override: GET

Response model for the listing of Logbook operations.

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
```
X-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
$data: (object)
Contains data to insert (for POST only)
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)

Examples:

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

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

HTTP status code 200

Returns the list of matching Logbook operations

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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "STARTED",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
    },
    {
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

HTTP status code 206

Returns the list of matching Logbook operations 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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "STARTED",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
    },
    {
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

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

Response model for the listing of Logbook operations. The request is using POST with X-Http-Method-Override: GET

Secured by VitamPlatform

Based on Platform Secret

Headers

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

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
$data: (object)
Contains data to insert (for POST only)
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)

Examples:

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

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

HTTP status code 200

Returns the list of matching Logbook operations

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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "STARTED",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
    },
    {
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

HTTP status code 206

Returns the list of matching Logbook operations 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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "STARTED",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
    },
    {
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

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

/operations/{idop} get post

Accès à une opération.

get

Response model for one Logbook operation item.

post

Response model for one Logbook operation item. The request is using POST with X-Http-Method-Override: GET

Response model for one Logbook operation item.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

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

$query: required (object)
Contains one query
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
$data: (object)
Contains data to insert (for POST only)
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)

Examples:

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

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

HTTP status code 200

Returns one Logbook Operation item

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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "STARTED",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
    },
    {
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

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

Response model for one Logbook operation item. The request is using POST with X-Http-Method-Override: GET

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

idop: required (string)

Headers

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

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
$data: (object)
Contains data to insert (for POST only)
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)

Examples:

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

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

HTTP status code 200

Returns one Logbook Operation item

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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "STARTED",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
    },
    {
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

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

/operations/{idop}/traceability post

post

Permet de lancer une opération de sécurisation des journaux d'opération sur un tenant donné.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

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

L'opération a été réalisée avec succès. L'ID de l'opération est retournée.

HTTP status code 400

Le tenant n'est pas indiqué, l'opération n'a pu être réalisée.

HTTP status code 500

Un problème interne a empêché l'opération de se dérouler.

Secured by VitamPlatform

Headers

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

/operations/{idop}/traceability/{idOperation}/datafiles get post

get

Permet de télécharger le fichier sécurisé des journaux d'opération

post

Permet de télécharger le fichier sécurisé des journaux d'opération (POST avec X-Http-Method-Override: GET)

Permet de télécharger le fichier sécurisé des journaux d'opération

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

idop: required (string)
idOperation: 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 one traceability zip file

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/octet-stream

Type: object

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

Permet de télécharger le fichier sécurisé des journaux d'opération (POST avec X-Http-Method-Override: GET)

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

idop: required (string)
idOperation: required (string)

Headers

X-Http-Method-Override: required (string)
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 one traceability zip file

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/octet-stream

Type: object

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

/operations/{idop}/traceabilitychecks post

post

Permet de vérifier une opération de sécurisation des journaux

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

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

$query: required (object)
Contains one query
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
$data: (object)
Contains data to insert (for POST only)
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)

Examples:

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

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

HTTP status code 200

Returns one traceability object

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:

{
  "$hint": {
    "total": "1"
  },
  "$context": {
    "$query": {
      "$eq": {
        "id": "1"
      }
    },
    "$projection": {

    },
    "$filter": {

    }
  },
  "$result": {
    "LogType": "OPERATION",
    "StartDate": "2017-03-02T12:46:25.618",
    "EndDate": "2017-03-02T14:22:34.811",
    "Hash": "obu+Z7+M7JlaY5ney0dDNTzmWr4+r6Cf3GtwMrLKpCLIL7Bjqty8kfUNSGNQ9qlzO3YE7+zRdC2o\/S+uUOJM4g==",
    "TimeStampToken": "MIIEZzAVAgEAMBAMDk9wZXJhdGlvbiBPa2F5MIIETAYJKoZIhvcNAQcCoIIEPTCCBDkCAQMxDzANBglghkgBZQMEAgMFADCBgAYLKoZIhvcNAQkQAQSgcQRvMG0CAQEGASkwUTANBglghkgBZQMEAgMFAARAMcCUdvY+87OSgJw3slg+aHgTt+j+UcybWmhG0G9wL7A0NE8eUO8JFJRD81Gb4wTu12AealKzWeUoLczLWRhACQIBARgPMjAxNzAzMDIxNDIyMzVaMYIDnjCCA5oCAQEwTzBKMQswCQYDVQQGEwJGUjEPMA0GA1UECBMGRnJhbmNlMQ4wDAYDVQQHEwVQQXJpczENMAsGA1UEChMERXRhdDELMAkGA1UECxMCRVQCAQEwDQYJYIZIAWUDBAIDBQCgggEgMBoGCSqGSIb3DQEJAzENBgsqhkiG9w0BCRABBDAcBgkqhkiG9w0BCQUxDxcNMTcwMzAyMTQyMjM1WjAtBgkqhkiG9w0BCTQxIDAeMA0GCWCGSAFlAwQCAwUAoQ0GCSqGSIb3DQEBDQUAME8GCSqGSIb3DQEJBDFCBECDgiYpV3Bd\/9ckq0Nq+zm\/TmPWO3rCt33o+cKA8DI5L9EGiEV2GtjO0z4jnw08\/iZ3chanYRrR8hJk4u4Fmqk4MGQGCyqGSIb3DQEJEAIvMVUwUzBRME8wCwYJYIZIAWUDBAIDBEACrDhLC92Gcm2mclJwDuLADobFbVWY5HASuT8FL0\/1nNexkoSVnVclwr0VkxJgmVAxa+g8ecGbwLzDs8vbT9AYMA0GCSqGSIb3DQEBDQUABIICABBtgwv5dZJhWu050wXM27HGZF6yFaU6AOPjjUIQccbly1nw\/Sebg2xRenMv+jxAm8bAdW3eBPNrSa1iJKGLmgfYZuxIwt5AluzVuvTH2t1j08XSMmDQpilhN6Bx9dOS3aClNm89ZVygmdUz6N9HGmxZh1yis80SxD6jDjhnuK6R+xpmdmL6HIDzHa5mjOCbD1lXtr5tWWR+1K9Axv4qoLADlrUKmpCdbnfUBgVdbWJnJBcW6WoQXDpTD\/JbV\/m2s\/yzK7FDt+IpERwVZGqiZF9WwzgX9AFJ352tFWWj+KhqfFN8UgfPKD5aCo6V5T+vMlkodiV+0XQBPKdcPBoo8PJtiCR5sFlJHbQ0qGwQq6P\/06ApvrXOFKz434CkCGTbZLKVEHTs1SqgZuAg54bR6GbifOheVojOhWDFEMEXlnpD7PjCYscL9U83H92Iosr4rJhvYwSYbahmU7W1RlUP4cHy8nUYwvUO54ehYMcKcZ4idG4nbUfVYy8lClYruKG0rVcwWu3TZxeSaLePYRZwaeXJ00p36SttyZTLeN4rZatePQc\/ff856jvKqDlDZlXIyhOcYCXot5xHFlv+zKZhB71uOv\/XvqqmZFhentmkZFYK+qi2tH+Tahar2f3b4RJo+bm235g\/v1rIvKQKe8rjkemgPIG7RzkCnss2SGIpfW5h",
    "NumberOfElement": 4,
    "FileName": "0_LogbookOperation_20170302_142234.zip",
    "Size": 41807
  }
}

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

/operations/{idop}/unitlifecycles get post

API d'accès aux Journaux de cycle de vie des Units. Ce point d'entrée permet de chercher un cycle de vie ayant été impacté par cette opération (pour une entrée les archives ayant été intégrées, pour une élimination les archives ayant été éliminées, ...).

La recherche sur cette API retourne uniquement la première ligne et la dernière connue pour chaque journal du cycle de vie en rapport avec l'opération concernée.

get

Response model for the listing of Logbook unit life cycles

post

Response model for the listing of Logbook unit life cycles. The request is using POST with X-Http-Method-Override: GET

Response model for the listing of Logbook unit life cycles

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

idop: 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-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
$data: (object)
Contains data to insert (for POST only)
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)

Examples:

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

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

HTTP status code 200

Returns the list of matching Logbook units life cycles

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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "STARTED",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
    },
    {
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

HTTP status code 206

Returns the list of matching Logbook units life cycles 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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "STARTED",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
    },
    {
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

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

Response model for the listing of Logbook unit life cycles. The request is using POST with X-Http-Method-Override: GET

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

idop: required (string)

Headers

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

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
$data: (object)
Contains data to insert (for POST only)
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)

Examples:

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

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

HTTP status code 200

Returns the list of matching Logbook units life cycles

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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "STARTED",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
    },
    {
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

HTTP status code 206

Returns the list of matching Logbook units life cycles 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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "STARTED",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
    },
    {
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

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

/operations/{idop}/unitlifecycles/{id_lfc} get post

Accès à un cycle de vie lié à l'opération en référence (Unit).

Le cycle de vie concerné est retourné complet ou tronqué aux seuls événements liés à l'opération en référence selon l'argument X-Full.

get

Response model for one Logbook unit life cycle item.

post

Response model for one Logbook unit life cycle item. The request is using POST with X-Http-Method-Override: GET

Response model for one Logbook unit life cycle item.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

idop: required (string)
id_lfc: 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

$query: required (object)
Contains one query
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
$data: (object)
Contains data to insert (for POST only)
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)

Examples:

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

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

HTTP status code 200

Returns one Logbook unit life cycle item

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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "archiveId",
      "eventType": "CheckDigest",
      "eventDateTime": "2015-07-14T17:34:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK - digest has been checked",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

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

Response model for one Logbook unit life cycle item. The request is using POST with X-Http-Method-Override: GET

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

idop: required (string)
id_lfc: required (string)

Headers

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

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
$data: (object)
Contains data to insert (for POST only)
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)

Examples:

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

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

HTTP status code 200

Returns one Logbook unit life cycle item

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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "archiveId",
      "eventType": "CheckDigest",
      "eventDateTime": "2015-07-14T17:34:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK - digest has been checked",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

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

/operations/{idop}/objectlifecycles get post

API d'accès aux Journaux de cycle de vie des Objects. Ce point d'entrée permet de chercher un cycle de vie ayant été impacté par cette opération (pour une entrée les archives ayant été intégrées, pour une élimination les archives ayant été éliminées, ...).

La recherche sur cette API retourne uniquement la première ligne et la dernière connue pour chaque journal du cycle de vie en rapport avec l'opération concernée.

get

Response model for the listing of Logbook object life cycles

post

Response model for the listing of Logbook object life cycles. The request is using POST with X-Http-Method-Override: GET

Response model for the listing of Logbook object life cycles

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

idop: 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-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
$data: (object)
Contains data to insert (for POST only)
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)

Examples:

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

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

HTTP status code 200

Returns the list of matching Logbook objects life cycles

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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "STARTED",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
    },
    {
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

HTTP status code 206

Returns the list of matching Logbook objects life cycles 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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "STARTED",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
    },
    {
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

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

Response model for the listing of Logbook object life cycles. The request is using POST with X-Http-Method-Override: GET

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

idop: required (string)

Headers

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

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
$data: (object)
Contains data to insert (for POST only)
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)

Examples:

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

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

HTTP status code 200

Returns the list of matching Logbook objects life cycles

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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "STARTED",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
    },
    {
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

HTTP status code 206

Returns the list of matching Logbook objects life cycles 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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "STARTED",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
    },
    {
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

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

/operations/{idop}/objectlifecycles/{id_lfc} get post

Accès à un cycle de vie lié à l'opération en référence (Object).

Le cycle de vie concerné est retourné complet ou tronqué aux seuls événements liés à l'opération en référence selon l'argument X-Full.

get

Response model for one Logbook object life cycle item

post

Response model for one Logbook object life cycle item. The request is using POST with X-Http-Method-Override: GET

Response model for one Logbook object life cycle item

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

idop: required (string)
id_lfc: 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

$query: required (object)
Contains one query
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
$data: (object)
Contains data to insert (for POST only)
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)

Examples:

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

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

HTTP status code 200

Returns one Logbook object life cycle item

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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "archiveId",
      "eventType": "CheckDigest",
      "eventDateTime": "2015-07-14T17:34:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK - digest has been checked",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

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

Response model for one Logbook object life cycle item. The request is using POST with X-Http-Method-Override: GET

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

idop: required (string)
id_lfc: required (string)

Headers

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

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
$data: (object)
Contains data to insert (for POST only)
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)

Examples:

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

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

HTTP status code 200

Returns one Logbook object life cycle item

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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "archiveId",
      "eventType": "CheckDigest",
      "eventDateTime": "2015-07-14T17:34:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK - digest has been checked",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

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

Unit Life Cycle Logbook

API d'accès aux Journaux de cycle de vie des Units.

La recherche sur cette API retourne uniquement la première ligne et la dernière connue pour chaque journal du cycle de vie.

/unitlifecycles get post

get

Response model for the listing of Logbook unit life cycles

post

Response model for the listing of Logbook unit life cycles. The request is using POST with X-Http-Method-Override: GET

Response model for the listing of Logbook unit life cycles

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
```
X-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
$data: (object)
Contains data to insert (for POST only)
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)

Examples:

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

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

HTTP status code 200

Returns the list of matching Logbook units life cycles

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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "STARTED",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
    },
    {
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

HTTP status code 206

Returns the list of matching Logbook units life cycles 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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "STARTED",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
    },
    {
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

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

Response model for the listing of Logbook unit life cycles. The request is using POST with X-Http-Method-Override: GET

Secured by VitamPlatform

Based on Platform Secret

Headers

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

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
$data: (object)
Contains data to insert (for POST only)
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)

Examples:

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

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

HTTP status code 200

Returns the list of matching Logbook units life cycles

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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "STARTED",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
    },
    {
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

HTTP status code 206

Returns the list of matching Logbook units life cycles 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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "STARTED",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
    },
    {
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

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

/unitlifecycles/{id_lfc} get post

Accès à un cycle de vie (Unit). Le cycle de vie concerné est retourné complet.

get

Response model for one Logbook unit life cycle item

post

Response model for one Logbook unit life cycle item. The request is using POST with X-Http-Method-Override: GET

Response model for one Logbook unit life cycle item

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

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

$query: required (object)
Contains one query
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
$data: (object)
Contains data to insert (for POST only)
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)

Examples:

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

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

HTTP status code 200

Returns one Logbook unit life cycle item

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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "archiveId",
      "eventType": "CheckDigest",
      "eventDateTime": "2015-07-14T17:34:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK - digest has been checked",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

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

Response model for one Logbook unit life cycle item. The request is using POST with X-Http-Method-Override: GET

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

id_lfc: required (string)

Headers

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

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
$data: (object)
Contains data to insert (for POST only)
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)

Examples:

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

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

HTTP status code 200

Returns one Logbook unit life cycle item

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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "archiveId",
      "eventType": "CheckDigest",
      "eventDateTime": "2015-07-14T17:34:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK - digest has been checked",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

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

Object Life Cycle Logbook

API d'accès aux Journaux du Cycle de Vie des archives (Object).

La recherche sur cette API retourne uniquement la première ligne et la dernière connue pour chaque journal du cycle de vie.

/objectlifecycles get post

get

Response model for the listing of Logbook object life cycles

post

Response model for the listing of Logbook object life cycles. The request is using POST with X-Http-Method-Override: GET

Response model for the listing of Logbook object life cycles

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
```
X-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
$data: (object)
Contains data to insert (for POST only)
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)

Examples:

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

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

HTTP status code 200

Returns the list of matching Logbook objects life cycles

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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "STARTED",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
    },
    {
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

HTTP status code 206

Returns the list of matching Logbook objects life cycles 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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "STARTED",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
    },
    {
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

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

Response model for the listing of Logbook object life cycles. The request is using POST with X-Http-Method-Override: GET

Secured by VitamPlatform

Based on Platform Secret

Headers

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

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
$data: (object)
Contains data to insert (for POST only)
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)

Examples:

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

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

HTTP status code 200

Returns the list of matching Logbook objects life cycles

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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "STARTED",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
    },
    {
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

HTTP status code 206

Returns the list of matching Logbook objects life cycles 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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "STARTED",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
    },
    {
      "eventIdentifier": "entryId",
      "eventType": "CheckSeda",
      "eventDateTime": "2015-07-14T17:32:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

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

/objectlifecycles/{id_lfc} get post

Accès à un cycle de vie (Object). Le cycle de vie concerné est retourné complet.

get

Response model for one Logbook object life cycle item

post

Response model for one Logbook object life cycle item. The request is using POST with X-Http-Method-Override: GET

Response model for one Logbook object life cycle item

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

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

$query: required (object)
Contains one query
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
$data: (object)
Contains data to insert (for POST only)
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)

Examples:

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

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

HTTP status code 200

Returns one Logbook object life cycle item

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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "archiveId",
      "eventType": "CheckDigest",
      "eventDateTime": "2015-07-14T17:34:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK - digest has been checked",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

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

Response model for one Logbook object life cycle item. The request is using POST with X-Http-Method-Override: GET

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

id_lfc: required (string)

Headers

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

Body

Media type: application/json

Type: object

Properties

$query: required (object)
Contains one query
Filter: required (object)
Filter for a Request
Projection: required (object)
Projection for a Request
$data: (object)
Contains data to insert (for POST only)
FacetQuery: required (object)
Facet for a Request
$action: (array)
Contains actions to apply as update (for PUT only)

Examples:

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

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

HTTP status code 200

Returns one Logbook object life cycle item

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: required (object)
External Vitam DSL query
Examples:
```
{
  "$query": {
    "$path": "aaaaa"
  }
}
```
$results: required (array)
Contains list of items

Examples:

{
  "$hits": {
    "total": 2,
    "size": 2,
    "offset": 0,
    "limit": 100
  },
  "$context": {
    "$query":
      { "$path": "aaaaa" }
  },
  "$results":
  [{
      "eventIdentifier": "archiveId",
      "eventType": "CheckDigest",
      "eventDateTime": "2015-07-14T17:34:05Z",
      "eventIdentifierProcess": "workflowId",
      "eventTypeProcess": "Ingest",
      "outcome" : "OK - digest has been checked",
      "eventOutcomeDetail": "404_123456",
      "eventOutcomeDetailMessage": "Error message",
      "agentIdentifier": "server_identifier",
      "agentIdentifierApplication": "remoteApplicationId",
      "agentIdentifierApplicationSession": "X-AID",
      "eventIdentifierRequest": "W-Request-Id",
      "agentIdentifierSubmission": "Submission_agency_Id",
      "agentIdentifierOriginating": "Originating_agency_Id",
      "objectIdentifier": "Object_or_SIP_Id",
      "objectIdentifierRequest": "Request_selecting_objects",
      "objectIdentifierIncome": "MessageIdentifier_in_SEDA"
  }]
}

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 - Access interne API documentation version v1

Avertissements

Licence

API Access

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

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