API-Vitam Version Alpha - Logbook Interne version v1
http://logbook.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
API Logbook Interne
API Logbook Interne
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).
Response model for the listing of Logbook operations.
Response model for the listing of Logbook operations. The request is using POST with X-Http-Method-Override: GET
get /operations
Response model for the listing of Logbook operations.
Based on Platform Secret
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
- X-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
- X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id
Body
Media type: application/json
Type: object
Properties- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100 },
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
post /operations
Response model for the listing of Logbook operations. The request is using POST with X-Http-Method-Override: GET
Based on Platform Secret
Headers
- X-Http-Method-Override: (GET)
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
- X-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
- X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id
Body
Media type: application/json
Type: object
Properties- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100 },
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
Accès à une opération.
Response model for one Logbook operation item.
Response model for one Logbook operation item. The request is using POST with X-Http-Method-Override: GET
Add one item or item bundle to an existing operation
Allow to know if an operation exists
get /operations/{idop}
Response model for one Logbook operation item.
Based on Platform Secret
URI Parameters
- idop: required(string)
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100 },
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
post /operations/{idop}
Response model for one Logbook operation item. The request is using POST with X-Http-Method-Override: GET
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
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: DslTypes.DslQuery | LogbookTypes.LogbookOperation | LogbookTypes.LogbookOperation[]
HTTP status code 200
Append done or Query done
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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 201
Creation done
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 401
Unauthorized, authentication in error
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
put /operations/{idop}
Add one item or item bundle to an existing operation
Based on Platform Secret
URI Parameters
- idop: required(string)
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: array of object
Items: LogbookOperation
- eventIdentifier: required(string)
GUID of this particular event
- eventType: required(string)
Enum among several task ids
- eventDateTime: required(datetime)
- eventIdentifierProcess: required(string)
GUID of this operation (primary key)
- eventTypeProcess: required(one of Ingest, Access, Query, Freeze, Destruction, Audit, Preservation, Platform, Internal)
- outcome: required(one of STARTED, OK, WARNING, KO, FATAL)
- eventOutcomeDetail: required(string)
Vitam Code using HTTPSTATUS_VITAMCODE
- eventOutcomeDetailMessage: required(string)
Information ouput related to this log entry
- agentIdentifier: required(string)
Agent from which this entry is set
- agentIdentifierApplication: required(string)
Application from which this eventProces is requested
- agentIdentifierApplicationSession: required(string)
Application Session ID from which this eventProces is requested
- eventIdentifierRequest: required(string)
Internal Vitam Session ID from which this eventProces is requested
- agentIdentifierSubmission: required(string)
Submission Agency from which this eventProces is requested
- agentIdentifierOriginating: required(string)
Originating Agency from which this eventProces is requested
- objectIdentifier: required(string)
Id of the item on which the operation is (For Entry objectIdentifier = GUID of SIP)
- objectIdentifierRequest: required(string)
Request that select the various items on which the operation is (for operations occuring on a select query)
- objectIdentifierIncome: required(string)
Id from SEDA as MessageIdentifier
Example:
[
{
"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 200
Append done
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 201
Creation done
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 401
Unauthorized, authentication in error
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
head /operations/{idop}
Allow to know if an operation exists
Based on Platform Secret
URI Parameters
- idop: required(string)
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 204
No Content, Used to test existence
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
Permet de lancer une opération de sécurisation des journaux d'opération sur un tenant donné.
post /operations/{idop}/traceability
Permet de lancer une opération de sécurisation des journaux d'opération sur un tenant donné.
Based on Platform Secret
URI Parameters
- idop: required(string)
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
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
Permet de vérifier une opération de sécurisation des journaux
post /operations/{idop}/traceability/check
Permet de vérifier une opération de sécurisation des journaux
Based on Platform Secret
URI Parameters
- idop: required(string)
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100 },
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: any
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
Permet de télécharger le fichier sécurisé des journaux d'opération
Permet de télécharger le fichier sécurisé des journaux d'opération (POST avec X-Http-Method-Override: GET)
get /operations/{idop}/traceability/{idOperation}/content
Permet de télécharger le fichier sécurisé des journaux d'opération
Based on Platform Secret
URI Parameters
- idop: required(string)
- idOperation: required(string)
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 200
Returns one traceability zip file
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/octet-stream
Type: any
HTTP status code 401
Unauthorized, authentication in error
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
post /operations/{idop}/traceability/{idOperation}/content
Permet de télécharger le fichier sécurisé des journaux d'opération (POST avec X-Http-Method-Override: GET)
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
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 200
Returns one traceability zip file
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/octet-stream
Type: any
HTTP status code 401
Unauthorized, authentication in error
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
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.
Response model for the listing of Logbook unit life cycles
Response model for the listing of Logbook unit life cycles. The request is using POST with X-Http-Method-Override: GET
rollback Unit LifeCycles By Operation
get /operations/{idop}/unitlifecycles
Response model for the listing of Logbook unit life cycles
Based on Platform Secret
URI Parameters
- idop: required(string)
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
- X-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
- X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id
Body
Media type: application/json
Type: object
Properties- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100 },
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
post /operations/{idop}/unitlifecycles
Response model for the listing of Logbook unit life cycles. The request is using POST with X-Http-Method-Override: GET
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
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
- X-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
- X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id
Body
Media type: application/json
Type: object
Properties- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100 },
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
Accès à 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.
Response model for one Logbook unit life cycle item.
Response model for one Logbook unit life cycle item. The request is using POST with X-Http-Method-Override: GET
Add one item or item bundle to an existing operation
Purge one Lifecycle during one operation
Allow to know if a life cycle exists
get /operations/{idop}/unitlifecycles/{id_lfc}
Response model for one Logbook unit life cycle item.
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
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100 },
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
post /operations/{idop}/unitlifecycles/{id_lfc}
Response model for one Logbook unit life cycle item. The request is using POST with X-Http-Method-Override: GET
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
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: DslTypes.DslQuery | LogbookTypes.LogbookOperation | LogbookTypes.LogbookOperation[]
HTTP status code 200
Append done or Query done
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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 201
Creation done
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 401
Unauthorized, authentication in error
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
put /operations/{idop}/unitlifecycles/{id_lfc}
Add one item or item bundle to an existing operation
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
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: array of object
Items: LogbookOperation
- eventIdentifier: required(string)
GUID of this particular event
- eventType: required(string)
Enum among several task ids
- eventDateTime: required(datetime)
- eventIdentifierProcess: required(string)
GUID of this operation (primary key)
- eventTypeProcess: required(one of Ingest, Access, Query, Freeze, Destruction, Audit, Preservation, Platform, Internal)
- outcome: required(one of STARTED, OK, WARNING, KO, FATAL)
- eventOutcomeDetail: required(string)
Vitam Code using HTTPSTATUS_VITAMCODE
- eventOutcomeDetailMessage: required(string)
Information ouput related to this log entry
- agentIdentifier: required(string)
Agent from which this entry is set
- agentIdentifierApplication: required(string)
Application from which this eventProces is requested
- agentIdentifierApplicationSession: required(string)
Application Session ID from which this eventProces is requested
- eventIdentifierRequest: required(string)
Internal Vitam Session ID from which this eventProces is requested
- agentIdentifierSubmission: required(string)
Submission Agency from which this eventProces is requested
- agentIdentifierOriginating: required(string)
Originating Agency from which this eventProces is requested
- objectIdentifier: required(string)
Id of the item on which the operation is (For Entry objectIdentifier = GUID of SIP)
- objectIdentifierRequest: required(string)
Request that select the various items on which the operation is (for operations occuring on a select query)
- objectIdentifierIncome: required(string)
Id from SEDA as MessageIdentifier
Example:
[
{
"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 200
Append done
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 201
Creation done
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 401
Unauthorized, authentication in error
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
delete /operations/{idop}/unitlifecycles/{id_lfc}
Purge one Lifecycle during one operation
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
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 204
No Content, Used to test existence
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
head /operations/{idop}/unitlifecycles/{id_lfc}
Allow to know if a life cycle exists
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
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 204
No Content, Used to test existence
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
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.
Response model for the listing of Logbook object life cycles
Response model for the listing of Logbook object life cycles. The request is using POST with X-Http-Method-Override: GET
rollback object group LifeCycles By Operation
get /operations/{idop}/objectlifecycles
Response model for the listing of Logbook object life cycles
Based on Platform Secret
URI Parameters
- idop: required(string)
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
- X-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
- X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id
Body
Media type: application/json
Type: object
Properties- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100 },
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
post /operations/{idop}/objectlifecycles
Response model for the listing of Logbook object life cycles. The request is using POST with X-Http-Method-Override: GET
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
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
- X-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
- X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id
Body
Media type: application/json
Type: object
Properties- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100 },
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
Accès à 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.
Response model for one Logbook object life cycle item
Response model for one Logbook object life cycle item. The request is using POST with X-Http-Method-Override: GET
Add one item or item bundle to an existing operation
Purge one Lifecycle during one operation
Allow to know if a life cycle exists
get /operations/{idop}/objectlifecycles/{id_lfc}
Response model for one Logbook object life cycle item
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
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100 },
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
post /operations/{idop}/objectlifecycles/{id_lfc}
Response model for one Logbook object life cycle item. The request is using POST with X-Http-Method-Override: GET
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
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: DslTypes.DslQuery | LogbookTypes.LogbookOperation | LogbookTypes.LogbookOperation[]
HTTP status code 200
Append done or Query done
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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 201
Creation done
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 401
Unauthorized, authentication in error
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
put /operations/{idop}/objectlifecycles/{id_lfc}
Add one item or item bundle to an existing operation
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
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: array of object
Items: LogbookOperation
- eventIdentifier: required(string)
GUID of this particular event
- eventType: required(string)
Enum among several task ids
- eventDateTime: required(datetime)
- eventIdentifierProcess: required(string)
GUID of this operation (primary key)
- eventTypeProcess: required(one of Ingest, Access, Query, Freeze, Destruction, Audit, Preservation, Platform, Internal)
- outcome: required(one of STARTED, OK, WARNING, KO, FATAL)
- eventOutcomeDetail: required(string)
Vitam Code using HTTPSTATUS_VITAMCODE
- eventOutcomeDetailMessage: required(string)
Information ouput related to this log entry
- agentIdentifier: required(string)
Agent from which this entry is set
- agentIdentifierApplication: required(string)
Application from which this eventProces is requested
- agentIdentifierApplicationSession: required(string)
Application Session ID from which this eventProces is requested
- eventIdentifierRequest: required(string)
Internal Vitam Session ID from which this eventProces is requested
- agentIdentifierSubmission: required(string)
Submission Agency from which this eventProces is requested
- agentIdentifierOriginating: required(string)
Originating Agency from which this eventProces is requested
- objectIdentifier: required(string)
Id of the item on which the operation is (For Entry objectIdentifier = GUID of SIP)
- objectIdentifierRequest: required(string)
Request that select the various items on which the operation is (for operations occuring on a select query)
- objectIdentifierIncome: required(string)
Id from SEDA as MessageIdentifier
Example:
[
{
"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 200
Append done
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 201
Creation done
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 401
Unauthorized, authentication in error
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
delete /operations/{idop}/objectlifecycles/{id_lfc}
Purge one Lifecycle during one operation
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
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 204
No Content, Used to test existence
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
head /operations/{idop}/objectlifecycles/{id_lfc}
Allow to know if a life cycle exists
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
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 204
No Content, Used to test existence
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
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.
Response model for the listing of Logbook unit life cycles
Response model for the listing of Logbook unit life cycles. The request is using POST with X-Http-Method-Override: GET
get /unitlifecycles
Response model for the listing of Logbook unit life cycles
Based on Platform Secret
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
- X-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
- X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id
Body
Media type: application/json
Type: object
Properties- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100 },
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
post /unitlifecycles
Response model for the listing of Logbook unit life cycles. The request is using POST with X-Http-Method-Override: GET
Based on Platform Secret
Headers
- X-Http-Method-Override: (GET)
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
- X-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
- X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id
Body
Media type: application/json
Type: object
Properties- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100 },
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
Accès à un cycle de vie (Unit).
Le cycle de vie concerné est retourné complet.
Response model for one Logbook unit life cycle item
Response model for one Logbook unit life cycle item. The request is using POST with X-Http-Method-Override: GET
Allow to know the life cycle status
get /unitlifecycles/{id_lfc}
Response model for one Logbook unit life cycle item
Based on Platform Secret
URI Parameters
- id_lfc: required(string)
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100 },
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
post /unitlifecycles/{id_lfc}
Response model for one Logbook unit life cycle item. The request is using POST with X-Http-Method-Override: GET
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
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100 },
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
head /unitlifecycles/{id_lfc}
Allow to know the life cycle status
Based on Platform Secret
URI Parameters
- id_lfc: required(string)
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 204
No Content, Used to test existence
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
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.
Response model for the listing of Logbook object life cycles
Response model for the listing of Logbook object life cycles. The request is using POST with X-Http-Method-Override: GET
get /objectlifecycles
Response model for the listing of Logbook object life cycles
Based on Platform Secret
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
- X-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
- X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id
Body
Media type: application/json
Type: object
Properties- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100 },
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
post /objectlifecycles
Response model for the listing of Logbook object life cycles. The request is using POST with X-Http-Method-Override: GET
Based on Platform Secret
Headers
- X-Http-Method-Override: (GET)
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
- X-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
- X-Cursor-Id: (string)
If present, means the query could continue with the next set of response, according to current position of the Cursor Id
Body
Media type: application/json
Type: object
Properties- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100 },
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
Accès à un cycle de vie (Object).
Le cycle de vie concerné est retourné complet.
Response model for one Logbook object life cycle item
Response model for one Logbook object life cycle item. The request is using POST with X-Http-Method-Override: GET
Allow to know the life cycle status
get /objectlifecycles/{id_lfc}
Response model for one Logbook object life cycle item
Based on Platform Secret
URI Parameters
- id_lfc: required(string)
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100 },
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
post /objectlifecycles/{id_lfc}
Response model for one Logbook object life cycle item. The request is using POST with X-Http-Method-Override: GET
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
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100 },
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- $hits: required(object)
Contains the hits for the response
- total: required(integer)
Total estimated possible answears
- offset: required(integer)
Offset on possible answears
- limit: required(integer)
Limit specified in the request (or implicit) from Offset
- size: required(integer)
Number of currently returned answears
- time_out: (boolean)
True means the request was too long and so only partial result could be retrieved
- total: required(integer)
- $context: required(object)
Contains Request related to this to reply
- $query: required(object)
Contains one query
- $filter: (object)
Contains filter to apply (for GET only)
- $offset: (integer - minimum: 1 - maximum: 100000)
- $limit: (integer - minimum: 1 - maximum: 100000)
- $orderby: (object)
- $hint: (one of , cache, nocache)
- $projection: (object)
Contains projection to apply (for GET only)
- $fields: (object)
- $usage: (string)
- $fields: (object)
- $data: (object)
Contains data to insert (for POST only)
- $facetQuery: (object)
Contains facet to apply (for GET only)
- $action: (array of object)
Contains actions to apply as update (for PUT only)
Items:
Example:
{ "$query": { "$path": "aaaaa" } }
- $query: required(object)
- $results: required(array of object)
Contains list of items
Items:
Example:
{
"$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
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
head /objectlifecycles/{id_lfc}
Allow to know the life cycle status
Based on Platform Secret
URI Parameters
- id_lfc: required(string)
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 204
No Content, Used to test existence
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
Raw
API d'accès aux Journaux en mode brut (pas de traduction Vitam).
Insertion des cycles de vie des Unit en masse.
Insert or replace existing Lifecycle Units
post /raw/unitlifecycles/bulk
Insert or replace existing Lifecycle Units
Based on Platform Secret
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: any
Example:
[
{
"_id": "aebaaaaaaafukrl4aa4i4alb2jxjwmqaaaaq",
"evId": "aedqaaaaacfukrl4aa4i4alb2jxjykaaaaaq",
"evParentId": null,
"evType": "LFC.LFC_CREATION",
"evDateTime": "2018-02-26T14:05:19.785",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.LFC_CREATION.OK",
"outMessg": "Succès de l'alimentation du journal du cycle de vie",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aebaaaaaaafukrl4aa4i4alb2jxjwmqaaaaq",
"evDetData": null,
"events": [
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxjykiaaaaq",
"evParentId": null,
"evType": "LFC.CHECK_MANIFEST",
"evDateTime": "2018-02-26T14:05:19.785",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.CHECK_MANIFEST.OK",
"outMessg": "Succès de la vérification de la cohérence du bordereau de transfert",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aebaaaaaaafukrl4aa4i4alb2jxjwmqaaaaq",
"evDetData": null
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxjykiaaaba",
"evParentId": "aedqaaaaacfukrl4aa4i4alb2jxjykiaaaaq",
"evType": "LFC.CHECK_MANIFEST.LFC_CREATION",
"evDateTime": "2018-02-26T14:05:19.785",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.CHECK_MANIFEST.LFC_CREATION.OK",
"outMessg": "Succès de la création du journal du cycle de vie",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aebaaaaaaafukrl4aa4i4alb2jxjwmqaaaaq",
"evDetData": null
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxj2kiaaaaq",
"evParentId": null,
"evType": "LFC.CHECK_CONSISTENCY",
"evDateTime": "2018-02-26T14:05:20.041",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.CHECK_CONSISTENCY.OK",
"outMessg": "Succès de la vérification de la cohérence entre objets, groupes d'objets et unités archivistiques",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aebaaaaaaafukrl4aa4i4alb2jxjwmqaaaaq",
"evDetData": null
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxkdpiaaaaq",
"evParentId": null,
"evType": "LFC.CHECK_DIGEST",
"evDateTime": "2018-02-26T14:05:21.227",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.CHECK_DIGEST.OK",
"outMessg": "Succès de la vérification de l'intégrité des objets versés",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aebaaaaaaafukrl4aa4i4alb2jxjwmqaaaaq",
"evDetData": "{}"
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxkdsyaaaaq",
"evParentId": "aedqaaaaacfukrl4aa4i4alb2jxkdpiaaaaq",
"evType": "LFC.CHECK_DIGEST.CALC_CHECK",
"evDateTime": "2018-02-26T14:05:21.235",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.CHECK_DIGEST.CALC_CHECK.OK",
"outMessg": "Succès du calcul d'une empreinte en SHA-512",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aeaaaaaaaafukrl4aa4i4alb2jxjwmiaaaaq",
"evDetData": "{\"MessageDigest\":\"58e37fa092797145f2a0d063ebf8699b9725ab9955ebc2aa503539c3d7c39ab4f867ffb02595782195f2f94ac23017f9a78c1b10c2fc37287227a7673e2b8c28\",\"Algorithm\": \"SHA512\", \"SystemMessageDigest\": \"58e37fa092797145f2a0d063ebf8699b9725ab9955ebc2aa503539c3d7c39ab4f867ffb02595782195f2f94ac23017f9a78c1b10c2fc37287227a7673e2b8c28\", \"SystemAlgorithm\": \"SHA-512\"} "
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxkdxiaaaaq",
"evParentId": null,
"evType": "LFC.OG_OBJECTS_FORMAT_CHECK",
"evDateTime": "2018-02-26T14:05:21.309",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.OG_OBJECTS_FORMAT_CHECK.OK",
"outMessg": "Succès de la vérification des formats",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aebaaaaaaafukrl4aa4i4alb2jxjwmqaaaaq",
"evDetData": "{}"
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxkehiaaaaq",
"evParentId": "aedqaaaaacfukrl4aa4i4alb2jxkdxiaaaaq",
"evType": "LFC.OG_OBJECTS_FORMAT_CHECK.FILE_FORMAT",
"evDateTime": "2018-02-26T14:05:21.316",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.OG_OBJECTS_FORMAT_CHECK.FILE_FORMAT.OK",
"outMessg": "Format de l'objet identifié, référencé dans le référentiel interne et avec des informations cohérentes entre le bordereau de transfert et le résultat de l'outil d'identification des formats.",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aeaaaaaaaafukrl4aa4i4alb2jxjwmiaaaaq",
"evDetData": "{}"
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxmkmiaaaaq",
"evParentId": null,
"evType": "LFC.OBJ_STORAGE",
"evDateTime": "2018-02-26T14:05:30.333",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.OBJ_STORAGE.OK",
"outMessg": "Succès de l'écriture des objets sur les offres de stockage",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aebaaaaaaafukrl4aa4i4alb2jxjwmqaaaaq",
"evDetData": "{}"
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxmkxiaaaaq",
"evParentId": "aedqaaaaacfukrl4aa4i4alb2jxmkmiaaaaq",
"evType": "LFC.OBJ_STORAGE.OBJECT_STORAGE_SUB_TASK",
"evDateTime": "2018-02-26T14:05:30.339",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.OBJ_STORAGE.OBJECT_STORAGE_SUB_TASK.OK",
"outMessg": "Succès de l'écriture de l'objet sur les offres de stockage",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aeaaaaaaaafukrl4aa4i4alb2jxjwmiaaaaq",
"evDetData": "{\"FileName\":\"aeaaaaaaaafukrl4aa4i4alb2jxjwmiaaaaq\",\"Algorithm\":\"SHA-512\",\"MessageDigest\":\"58e37fa092797145f2a0d063ebf8699b9725ab9955ebc2aa503539c3d7c39ab4f867ffb02595782195f2f94ac23017f9a78c1b10c2fc37287227a7673e2b8c28\",\"Offers\":\"offer-fs-1.service.consul\"}"
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxmk2iaaaaq",
"evParentId": null,
"evType": "LFC.OG_METADATA_INDEXATION",
"evDateTime": "2018-02-26T14:05:30.380",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.OG_METADATA_INDEXATION.OK",
"outMessg": "Succès de l'indexation des métadonnées du groupe d'objets",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aebaaaaaaafukrl4aa4i4alb2jxjwmqaaaaq",
"evDetData": "{}"
}
],
"_tenant": 0,
"_v": 8,
"_lastPersistedDate": "2018-02-26T14:05:36.211"
},
{
"_id": "aeaqaaaaaafukrl4aa4i4alb2jxjxzqaaaaq",
"evId": "aedqaaaaacfukrl4aa4i4alb2jxjzjyaaabq",
"evParentId": null,
"evType": "LFC.LFC_CREATION",
"evDateTime": "2018-02-26T14:05:19.911",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.LFC_CREATION.OK",
"outMessg": "Succès de l'alimentation du journal du cycle de vie",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aeaqaaaaaafukrl4aa4i4alb2jxjxzqaaaaq",
"evDetData": null,
"events": [
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxjzkaaaaaq",
"evParentId": null,
"evType": "LFC.CHECK_MANIFEST",
"evDateTime": "2018-02-26T14:05:19.912",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.CHECK_MANIFEST.OK",
"outMessg": "Succès de la vérification de la cohérence du bordereau de transfert",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aeaqaaaaaafukrl4aa4i4alb2jxjxzqaaaaq",
"evDetData": "{ }"
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxjzkaaaaba",
"evParentId": "aedqaaaaacfukrl4aa4i4alb2jxjzkaaaaaq",
"evType": "LFC.CHECK_MANIFEST.LFC_CREATION",
"evDateTime": "2018-02-26T14:05:19.913",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.CHECK_MANIFEST.LFC_CREATION.OK",
"outMessg": "Succès de la création du journal du cycle de vie",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aeaqaaaaaafukrl4aa4i4alb2jxjxzqaaaaq",
"evDetData": null
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxlvnaaaaaq",
"evParentId": null,
"evType": "LFC.CHECK_UNIT_SCHEMA",
"evDateTime": "2018-02-26T14:05:27.664",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.CHECK_UNIT_SCHEMA.OK",
"outMessg": "Succès de la vérification globale de l'unité archivistique",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aeaqaaaaaafukrl4aa4i4alb2jxjxzqaaaaq",
"evDetData": "{}"
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxlv6iaaaaq",
"evParentId": null,
"evType": "LFC.CHECK_CLASSIFICATION_LEVEL",
"evDateTime": "2018-02-26T14:05:27.673",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.CHECK_CLASSIFICATION_LEVEL.OK",
"outMessg": "Succès de la vérification du niveau de classification",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aeaqaaaaaafukrl4aa4i4alb2jxjxzqaaaaq",
"evDetData": "{}"
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxlwaaaaaaq",
"evParentId": null,
"evType": "LFC.UNITS_RULES_COMPUTE",
"evDateTime": "2018-02-26T14:05:27.690",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.UNITS_RULES_COMPUTE.OK",
"outMessg": "Succès de l'application des règles de gestion et du calcul des dates d'échéance",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aeaqaaaaaafukrl4aa4i4alb2jxjxzqaaaaq",
"evDetData": "{}"
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxnneiaaaaq",
"evParentId": null,
"evType": "LFC.UNIT_METADATA_INDEXATION",
"evDateTime": "2018-02-26T14:05:34.782",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.UNIT_METADATA_INDEXATION.OK",
"outMessg": "Succès de l'indexation des métadonnées de l'unité archivistique",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aeaqaaaaaafukrl4aa4i4alb2jxjxzqaaaaq",
"evDetData": "{}"
}
],
"_tenant": 0,
"_v": 4,
"_lastPersistedDate": "2018-02-26T14:05:41.507"
}
]
HTTP status code 201
Creation done
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 401
Unauthorized, authentication in error
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
Insertion des cycles de vie des Objets en masse.
Insert or replace existing Lifecycle Objects
post /raw/objectgrouplifecycles/bulk
Insert or replace existing Lifecycle Objects
Based on Platform Secret
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: any
Example:
[
{
"_id": "aebaaaaaaafukrl4aa4i4alb2jxjwmqaaaaq",
"evId": "aedqaaaaacfukrl4aa4i4alb2jxjykaaaaaq",
"evParentId": null,
"evType": "LFC.LFC_CREATION",
"evDateTime": "2018-02-26T14:05:19.785",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.LFC_CREATION.OK",
"outMessg": "Succès de l'alimentation du journal du cycle de vie",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aebaaaaaaafukrl4aa4i4alb2jxjwmqaaaaq",
"evDetData": null,
"events": [
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxjykiaaaaq",
"evParentId": null,
"evType": "LFC.CHECK_MANIFEST",
"evDateTime": "2018-02-26T14:05:19.785",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.CHECK_MANIFEST.OK",
"outMessg": "Succès de la vérification de la cohérence du bordereau de transfert",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aebaaaaaaafukrl4aa4i4alb2jxjwmqaaaaq",
"evDetData": null
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxjykiaaaba",
"evParentId": "aedqaaaaacfukrl4aa4i4alb2jxjykiaaaaq",
"evType": "LFC.CHECK_MANIFEST.LFC_CREATION",
"evDateTime": "2018-02-26T14:05:19.785",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.CHECK_MANIFEST.LFC_CREATION.OK",
"outMessg": "Succès de la création du journal du cycle de vie",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aebaaaaaaafukrl4aa4i4alb2jxjwmqaaaaq",
"evDetData": null
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxj2kiaaaaq",
"evParentId": null,
"evType": "LFC.CHECK_CONSISTENCY",
"evDateTime": "2018-02-26T14:05:20.041",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.CHECK_CONSISTENCY.OK",
"outMessg": "Succès de la vérification de la cohérence entre objets, groupes d'objets et unités archivistiques",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aebaaaaaaafukrl4aa4i4alb2jxjwmqaaaaq",
"evDetData": null
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxkdpiaaaaq",
"evParentId": null,
"evType": "LFC.CHECK_DIGEST",
"evDateTime": "2018-02-26T14:05:21.227",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.CHECK_DIGEST.OK",
"outMessg": "Succès de la vérification de l'intégrité des objets versés",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aebaaaaaaafukrl4aa4i4alb2jxjwmqaaaaq",
"evDetData": "{}"
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxkdsyaaaaq",
"evParentId": "aedqaaaaacfukrl4aa4i4alb2jxkdpiaaaaq",
"evType": "LFC.CHECK_DIGEST.CALC_CHECK",
"evDateTime": "2018-02-26T14:05:21.235",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.CHECK_DIGEST.CALC_CHECK.OK",
"outMessg": "Succès du calcul d'une empreinte en SHA-512",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aeaaaaaaaafukrl4aa4i4alb2jxjwmiaaaaq",
"evDetData": "{\"MessageDigest\":\"58e37fa092797145f2a0d063ebf8699b9725ab9955ebc2aa503539c3d7c39ab4f867ffb02595782195f2f94ac23017f9a78c1b10c2fc37287227a7673e2b8c28\",\"Algorithm\": \"SHA512\", \"SystemMessageDigest\": \"58e37fa092797145f2a0d063ebf8699b9725ab9955ebc2aa503539c3d7c39ab4f867ffb02595782195f2f94ac23017f9a78c1b10c2fc37287227a7673e2b8c28\", \"SystemAlgorithm\": \"SHA-512\"} "
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxkdxiaaaaq",
"evParentId": null,
"evType": "LFC.OG_OBJECTS_FORMAT_CHECK",
"evDateTime": "2018-02-26T14:05:21.309",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.OG_OBJECTS_FORMAT_CHECK.OK",
"outMessg": "Succès de la vérification des formats",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aebaaaaaaafukrl4aa4i4alb2jxjwmqaaaaq",
"evDetData": "{}"
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxkehiaaaaq",
"evParentId": "aedqaaaaacfukrl4aa4i4alb2jxkdxiaaaaq",
"evType": "LFC.OG_OBJECTS_FORMAT_CHECK.FILE_FORMAT",
"evDateTime": "2018-02-26T14:05:21.316",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.OG_OBJECTS_FORMAT_CHECK.FILE_FORMAT.OK",
"outMessg": "Format de l'objet identifié, référencé dans le référentiel interne et avec des informations cohérentes entre le bordereau de transfert et le résultat de l'outil d'identification des formats.",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aeaaaaaaaafukrl4aa4i4alb2jxjwmiaaaaq",
"evDetData": "{}"
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxmkmiaaaaq",
"evParentId": null,
"evType": "LFC.OBJ_STORAGE",
"evDateTime": "2018-02-26T14:05:30.333",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.OBJ_STORAGE.OK",
"outMessg": "Succès de l'écriture des objets sur les offres de stockage",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aebaaaaaaafukrl4aa4i4alb2jxjwmqaaaaq",
"evDetData": "{}"
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxmkxiaaaaq",
"evParentId": "aedqaaaaacfukrl4aa4i4alb2jxmkmiaaaaq",
"evType": "LFC.OBJ_STORAGE.OBJECT_STORAGE_SUB_TASK",
"evDateTime": "2018-02-26T14:05:30.339",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.OBJ_STORAGE.OBJECT_STORAGE_SUB_TASK.OK",
"outMessg": "Succès de l'écriture de l'objet sur les offres de stockage",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aeaaaaaaaafukrl4aa4i4alb2jxjwmiaaaaq",
"evDetData": "{\"FileName\":\"aeaaaaaaaafukrl4aa4i4alb2jxjwmiaaaaq\",\"Algorithm\":\"SHA-512\",\"MessageDigest\":\"58e37fa092797145f2a0d063ebf8699b9725ab9955ebc2aa503539c3d7c39ab4f867ffb02595782195f2f94ac23017f9a78c1b10c2fc37287227a7673e2b8c28\",\"Offers\":\"offer-fs-1.service.consul\"}"
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxmk2iaaaaq",
"evParentId": null,
"evType": "LFC.OG_METADATA_INDEXATION",
"evDateTime": "2018-02-26T14:05:30.380",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.OG_METADATA_INDEXATION.OK",
"outMessg": "Succès de l'indexation des métadonnées du groupe d'objets",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aebaaaaaaafukrl4aa4i4alb2jxjwmqaaaaq",
"evDetData": "{}"
}
],
"_tenant": 0,
"_v": 8,
"_lastPersistedDate": "2018-02-26T14:05:36.211"
},
{
"_id": "aeaqaaaaaafukrl4aa4i4alb2jxjxzqaaaaq",
"evId": "aedqaaaaacfukrl4aa4i4alb2jxjzjyaaabq",
"evParentId": null,
"evType": "LFC.LFC_CREATION",
"evDateTime": "2018-02-26T14:05:19.911",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.LFC_CREATION.OK",
"outMessg": "Succès de l'alimentation du journal du cycle de vie",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aeaqaaaaaafukrl4aa4i4alb2jxjxzqaaaaq",
"evDetData": null,
"events": [
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxjzkaaaaaq",
"evParentId": null,
"evType": "LFC.CHECK_MANIFEST",
"evDateTime": "2018-02-26T14:05:19.912",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.CHECK_MANIFEST.OK",
"outMessg": "Succès de la vérification de la cohérence du bordereau de transfert",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aeaqaaaaaafukrl4aa4i4alb2jxjxzqaaaaq",
"evDetData": "{ }"
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxjzkaaaaba",
"evParentId": "aedqaaaaacfukrl4aa4i4alb2jxjzkaaaaaq",
"evType": "LFC.CHECK_MANIFEST.LFC_CREATION",
"evDateTime": "2018-02-26T14:05:19.913",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.CHECK_MANIFEST.LFC_CREATION.OK",
"outMessg": "Succès de la création du journal du cycle de vie",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aeaqaaaaaafukrl4aa4i4alb2jxjxzqaaaaq",
"evDetData": null
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxlvnaaaaaq",
"evParentId": null,
"evType": "LFC.CHECK_UNIT_SCHEMA",
"evDateTime": "2018-02-26T14:05:27.664",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.CHECK_UNIT_SCHEMA.OK",
"outMessg": "Succès de la vérification globale de l'unité archivistique",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aeaqaaaaaafukrl4aa4i4alb2jxjxzqaaaaq",
"evDetData": "{}"
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxlv6iaaaaq",
"evParentId": null,
"evType": "LFC.CHECK_CLASSIFICATION_LEVEL",
"evDateTime": "2018-02-26T14:05:27.673",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.CHECK_CLASSIFICATION_LEVEL.OK",
"outMessg": "Succès de la vérification du niveau de classification",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aeaqaaaaaafukrl4aa4i4alb2jxjxzqaaaaq",
"evDetData": "{}"
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxlwaaaaaaq",
"evParentId": null,
"evType": "LFC.UNITS_RULES_COMPUTE",
"evDateTime": "2018-02-26T14:05:27.690",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.UNITS_RULES_COMPUTE.OK",
"outMessg": "Succès de l'application des règles de gestion et du calcul des dates d'échéance",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aeaqaaaaaafukrl4aa4i4alb2jxjxzqaaaaq",
"evDetData": "{}"
},
{
"evId": "aedqaaaaacfukrl4aa4i4alb2jxnneiaaaaq",
"evParentId": null,
"evType": "LFC.UNIT_METADATA_INDEXATION",
"evDateTime": "2018-02-26T14:05:34.782",
"evIdProc": "aeeaaaaaacfs6qdyaarhqalb2jxi56qaaaaq",
"evTypeProc": "INGEST",
"outcome": "OK",
"outDetail": "LFC.UNIT_METADATA_INDEXATION.OK",
"outMessg": "Succès de l'indexation des métadonnées de l'unité archivistique",
"agId": "{\"Name\":\"3a78947f03cc\",\"Role\":\"worker\",\"ServerId\":1665484156,\"SiteId\":1,\"GlobalPlatformId\":189089148}",
"obId": "aeaqaaaaaafukrl4aa4i4alb2jxjxzqaaaaq",
"evDetData": "{}"
}
],
"_tenant": 0,
"_v": 4,
"_lastPersistedDate": "2018-02-26T14:05:41.507"
}
]
HTTP status code 201
Creation done
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 401
Unauthorized, authentication in error
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
/status
get /status
Based on Platform Secret
HTTP status code 200
OK, operation in success
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Body
Media type: application/json
Type: object
Properties- id: required(string)
Id of the instance
- service: required(string)
Service Name for this instance
- startDate: required(datetime)
Date time for the start of this instance
- status: required(one of Active, Inactive, ShutdownInProgress, Unreachable)
Status of this instance
Example:
{
"id": "abcdef",
"service": "serviceName",
"startDate": "2015-07-14T17:07:14Z",
"status": "Active"
}
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 503
Service Unavailable, the requested service is unavailable
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key