API-Vitam Version Alpha - Collect version v1
https://api.vitam.gouv.fr/collect-internal/{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 Collect
API Collect
Projects
API de collecte. Ce point d'entrée permet d'initialiser et de gérer un projet de versement.
Création d'un projet :
- une requête unique, avec un 'body' contenant toutes les informations au format JSON :
- ArchivalAgencyIdentifier
- TransferringAgencyIdentifier
- OriginatingAgencyIdentifier
- SubmissionAgencyIdentifier
- MessageIdentifier
- ArchivalAgreement
- unitUp
- Comment
- LegalStatus
- Name
- request body : JSON object
- response : JSON of saved project / HTTP CODE 200
- request body : JSON object
- response : JSON of saved project / HTTP CODE 200
- request body : JSON object
- response : JSON of saved project / HTTP CODE 200
post /projects
- request body : JSON object
- response : JSON of saved project / HTTP CODE 200
Based on Platform Secret
Headers
- x-tenant-id: 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
- X-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
Body
Media type: application/json
Type: object
Example:
{
"ArchivalAgencyIdentifier": "Identifier0",
"TransferringAgencyIdentifier": "Identifier3",
"OriginatingAgencyIdentifier": "FRAN_NP_009915",
"SubmissionAgencyIdentifier": "FRAN_NP_005061",
"MessageIdentifier": "20220302-000005",
"Name": "Project Name",
"LegalStatus": "Archives privées",
"AcquisitionInformation": "Versement",
"ArchivalAgreement":"IC-000001",
"Comment": "Versement du service producteur : Cabinet de Michel Mercier",
"UnitUp": "aeaqaaaaaahgnz5dabg42amava5kfoqaaaba"
}
HTTP status code 200
Returns the saved transaction
Body
Media type: application/json
Type: object
Example:
{
"httpCode": 200,
"$hits": {
"total": 1,
"offset": 0,
"limit": 0,
"size": 1
},
"$results": [
{
"#id": "aeaaaaaaaahago4caajvgamet3mprkqaaaaq",
"Name": "This is my Name",
"ArchivalAgreement": "IC-000001",
"MessageIdentifier": "20220302-000005",
"ArchivalAgencyIdentifier": "Identifier0",
"TransferringAgencyIdentifier": "Identifier3",
"OriginatingAgencyIdentifier": "FRAN_NP_009915",
"SubmissionAgencyIdentifier": "FRAN_NP_005061",
"AcquisitionInformation": "Versement",
"LegalStatus": "Archives privées",
"Comment": "Versement du service producteur : Cabinet de Michel Mercier",
"UnitUp": "aeaqaaaaaahgnz5dabg42amava5kfoqaaaba",
"#tenant": 0
}
],
"$facetResults": [],
"$context": {}
}
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 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- 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 /projects
- request body : JSON object
- response : JSON of saved project / HTTP CODE 200
Based on Platform Secret
Headers
- x-tenant-id: 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
- X-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
Body
Media type: application/json
Type: object
Example:
{
"#id": "aeaaaaaaaahago4caajvgamet3mprkqaaaaq",
"Name": "This is my Name",
"ArchivalAgreement": "IC-000001",
"MessageIdentifier": "20220302-000005",
"ArchivalAgencyIdentifier": "Identifier0",
"TransferringAgencyIdentifier": "Identifier3",
"OriginatingAgencyIdentifier": "FRAN_NP_009915",
"SubmissionAgencyIdentifier": "FRAN_NP_005061",
"AcquisitionInformation": "Versement",
"LegalStatus": "Archives privées",
"Comment": "Versement du service producteur : Cabinet de Michel Mercier",
"UnitUp": "aeaqaaaaaahgnz5dabg42amava5kfoqaaaba",
"#tenant": 0
}
HTTP status code 200
Returns the saved transaction
Body
Media type: application/json
Type: object
Example:
{
"httpCode": 200,
"$hits": {
"total": 1,
"offset": 0,
"limit": 0,
"size": 1
},
"$results": [
{
"#id": "aeaaaaaaaahago4caajvgamet3mprkqaaaaq",
"Name": "This is my Name",
"ArchivalAgreement": "IC-000001",
"MessageIdentifier": "20220302-000005",
"ArchivalAgencyIdentifier": "Identifier0",
"TransferringAgencyIdentifier": "Identifier3",
"OriginatingAgencyIdentifier": "FRAN_NP_009915",
"SubmissionAgencyIdentifier": "FRAN_NP_005061",
"AcquisitionInformation": "Versement",
"LegalStatus": "Archives privées",
"Comment": "Versement du service producteur : Cabinet de Michel Mercier",
"UnitUp": "aeaqaaaaaahgnz5dabg42amava5kfoqaaaba",
"#tenant": 0
}
],
"$facetResults": [],
"$context": {}
}
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 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
get /projects
- request body : JSON object
- response : JSON of saved project / HTTP CODE 200
Based on Platform Secret
Headers
- x-tenant-id: 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
Body
Media type: application/json
Type: object
Example:
{
"httpCode": 200,
"$hits": {
"total": 1,
"offset": 0,
"limit": 0,
"size": 1
},
"$results": [
[
{
"id": "aeeaaaaaachguhgcabg2kambqwah7zaaaaaq",
"ArchivalAgreement": "IC-000001",
"MessageIdentifier": "20220302-000005",
"ArchivalAgencyIdentifier": "Identifier0",
"TransferingAgencyIdentifier": "Identifier3",
"OriginatingAgencyIdentifier": "FRAN_NP_009915",
"SubmissionAgencyIdentifier": "FRAN_NP_005061",
"Comment": "Versement du service producteur : Cabinet de Michel Mercier",
"tenant": 0,
"unitUp": "aeaqaaaaaahgnz5dabg42amava5kfoqaaaba"
}
]
],
"$facetResults": [],
"$context": {}
}
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 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- 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 de collecte. Ce point d'entrée permet de supprimer un projet.
delete /projects/{id}
Based on Platform Secret
URI Parameters
- id: required(string)
Identifiant du projet
Headers
- x-tenant-id: 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
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 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- 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 retourner la liste des unités archivistique associés à l'identifiant du projet
get /projects/{id}/units
Permet de retourner la liste des unités archivistique associés à l'identifiant du projet
Based on Platform Secret
URI Parameters
- id: required(string)
Identifiant du projet
Headers
- X-tenant-Id: 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
Body
Media type: application/json
Type: object
Example:
{
"$roots": [],
"$query": [
{
"$gt": {
"#approximate_creation_date": "2022-01-01"
}
}
],
"$projection": {
"$fields": {
}
},
"$facets": [],
"$threshold": 500000
}
HTTP status code 200
Body
Media type: application/json
Type: object
Example:
{
"httpCode": 201,
"$hits": {
"total": 1,
"offset": 0,
"limit": 0,
"size": 1
},
"$results": [
{
"#unitups": [],
"#min": 1,
"#max": 1,
"#allunitups": [],
"DescriptionLevel": "Item",
"Title": "My title3",
"Description": "Allemant. - Au chemin des Dames : le chateau et la ferme de la Motte totalement detruits.",
"Descriptions": {
"fr": "La legendes traduites en anglais."
},
"Status": "Pret",
"Tag": [
"Grande Collecte"
],
"Source": "Famille Herve, CP1",
"CreatedDate": "2014-06-12T09:31:00",
"TransactedDate": "2014-06-12T09:31:00",
"#management": {},
"#originating_agencies": [],
"#id": "aeeaaaaaach2brfeabbykal7ds6p33qaaaaq",
"#opi": "aeeaaaaaach2brfeabbykal7ds53vdqaaaaq"
}
],
"$facetResults": [],
"$context": {}
}
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 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
SESSION-ID-00001
- X-Tenant-Id: (number)
Unique Tenant Identifier
Example:
0
Secured by VitamPlatform
Headers
- X-Vitam-Key: required(string)
Vitam Platform Key
- request body : JSON object
- response : JSON of saved transactions / HTTP CODE 200
- request body : JSON object
- response : JSON of saved transaction / HTTP CODE 200
get /projects/{id}/transactions
- request body : JSON object
- response : JSON of saved transactions / HTTP CODE 200
Based on Platform Secret
URI Parameters
- id: required(string)
Identifiant du projet
Headers
- x-tenant-id: 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
Body
Media type: application/json
Type: object
Example:
{
"httpCode": 200,
"$hits": {
"total": 1,
"offset": 0,
"limit": 0,
"size": 1
},
"$results": [
{
"#id": "aeeaaaaaachago4caajvgamet3sv5riaaaaq",
"ArchivalAgreement": "IC-000001",
"MessageIdentifier": "20220302-000005",
"ArchivalAgencyIdentifier": "Vitam",
"TransferringAgencyIdentifier": "AN",
"OriginatingAgencyIdentifier": "MICHEL_MERCIER",
"SubmissionAgencyIdentifier": "MICHEL_MERCIER",
"Comment": "Versement du service producteur : Cabinet de Michel Mercier",
"#tenant": 0
}
],
"$facetResults": [],
"$context": {}
}
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 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- 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 /projects/{id}/transactions
- request body : JSON object
- response : JSON of saved transaction / HTTP CODE 200
Based on Platform Secret
URI Parameters
- id: required(string)
Identifiant du projet
Headers
- x-tenant-id: 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
- X-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
Body
Media type: application/json
Type: object
Example:
{
"ArchivalAgencyIdentifier": "Vitam",
"TransferingAgencyIdentifier": "AN",
"OriginatingAgencyIdentifier": "MICHEL_MERCIER",
"SubmissionAgencyIdentifier": "MICHEL_MERCIER",
"MessageIdentifier": "20220302-000005",
"ArchivalAgreement":"IC-000001",
"Comment": "Versement du service producteur : Cabinet de Michel Mercier"
}
HTTP status code 200
Returns the saved transaction
Body
Media type: application/json
Type: object
Example:
{
"httpCode": 200,
"$hits": {
"total": 1,
"offset": 0,
"limit": 0,
"size": 1
},
"$results": [
{
"#id": "aeeaaaaaachago4caajvgamet3sv5riaaaaq",
"ArchivalAgreement": "IC-000001",
"MessageIdentifier": "20220302-000005",
"ArchivalAgencyIdentifier": "Vitam",
"TransferringAgencyIdentifier": "AN",
"OriginatingAgencyIdentifier": "MICHEL_MERCIER",
"SubmissionAgencyIdentifier": "MICHEL_MERCIER",
"Comment": "Versement du service producteur : Cabinet de Michel Mercier",
"#tenant": 0
}
],
"$facetResults": [],
"$context": {}
}
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 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- 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 soumettre un ensemble de binaire au format Zip. L'arborescence est rattachée à une transaction auto-générée dont l'identifiant est retourné à l'appelant. Optionnellement, le Zip peut contenir un fichier "metadata.csv" ou "metadata.jsonl" décrivant l'ensemble des métadonnées de l'arborescence.
Il est à noter que dans le cas d'un fichier de métadonnées au format JSONL (metadata.jsonl), la sélection des métadonnées peut se faire uniquement via le champ File
ou via un sélecteur (champ Selector
), limité à la clé #uploadFile
.
Attention : Cette API est alpha / expérimentale.
post /projects/{id}/upload
Permet de soumettre un ensemble de binaire au format Zip. L'arborescence est rattachée à une transaction auto-générée dont l'identifiant est retourné à l'appelant. Optionnellement, le Zip peut contenir un fichier "metadata.csv" ou "metadata.jsonl" décrivant l'ensemble des métadonnées de l'arborescence.
Il est à noter que dans le cas d'un fichier de métadonnées au format JSONL (metadata.jsonl), la sélection des métadonnées peut se faire uniquement via le champ File
ou via un sélecteur (champ Selector
), limité à la clé #uploadFile
.
Attention : Cette API est alpha / expérimentale.
Based on Platform Secret
URI Parameters
- id: required(string)
Headers
- X-tenant-Id: required(string)
- X-Encoding: (string)
Encodage du zip, par default VITAM utilise UTF-8
- 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/zip
Type: any
HTTP status code 200
Body
Media type: application/json
Type: object
Example:
Can not resolve libraries/examples/uploadZipToProjectResponseExample.json
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 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- 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
Transactions
- request body : JSON object
- response : JSON of saved transaction / HTTP CODE 200
put /transactions
- request body : JSON object
- response : JSON of saved transaction / HTTP CODE 200
Based on Platform Secret
Headers
- x-tenant-id: 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
- X-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
Body
Media type: application/json
Type: object
Example:
{
"#id": "aeeaaaaaachago4caajvgamet3sv5riaaaaq",
"ArchivalAgreement": "IC-000001",
"MessageIdentifier": "20220302-000005",
"ArchivalAgencyIdentifier": "Vitam",
"TransferringAgencyIdentifier": "AN",
"OriginatingAgencyIdentifier": "MICHEL_MERCIER",
"SubmissionAgencyIdentifier": "MICHEL_MERCIER",
"Comment": "Versement du service producteur : Cabinet de Michel Mercier",
"#tenant": 0
}
HTTP status code 200
Returns the saved transaction
Body
Media type: application/json
Type: object
Example:
{
"httpCode": 200,
"$hits": {
"total": 1,
"offset": 0,
"limit": 0,
"size": 1
},
"$results": [
{
"#id": "aeeaaaaaachago4caajvgamet3sv5riaaaaq",
"ArchivalAgreement": "IC-000001",
"MessageIdentifier": "20220302-000005",
"ArchivalAgencyIdentifier": "Vitam",
"TransferringAgencyIdentifier": "AN",
"OriginatingAgencyIdentifier": "MICHEL_MERCIER",
"SubmissionAgencyIdentifier": "MICHEL_MERCIER",
"Comment": "Versement du service producteur : Cabinet de Michel Mercier",
"#tenant": 0
}
],
"$facetResults": [],
"$context": {}
}
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 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- 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 soumettre une unité archivistique
post /transactions/{id}/units
Permet de soumettre une unité archivistique
Based on Platform Secret
URI Parameters
- id: required(string)
Identifiant de la transaction
Headers
- X-tenant-Id: 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
- X-Cursor: (boolean)
If present and true means the query could use a cursor as response if necessary
Body
Media type: application/json
Type: object
Example:
{
"#unitups": [],
"#min": 1,
"#max": 1,
"#allunitups": [],
"DescriptionLevel": "Item",
"Title": "My title3",
"Description": "Allemant. - Au chemin des Dames : le chateau et la ferme de la Motte totalement detruits.",
"Descriptions": {
"fr": "La legendes traduites en anglais."
},
"Status": "Pret",
"Tag": ["Grande Collecte"],
"Source": "Famille Herve, CP1",
"CreatedDate": "2014-06-12T09:31:00",
"TransactedDate": "2014-06-12T09:31:00",
"#management": {
},
"#originating_agencies": []
}
HTTP status code 200
Returns the saved transaction
Body
Media type: application/json
Type: object
Example:
{
"httpCode": 201,
"$hits": {
"total": 1,
"offset": 0,
"limit": 0,
"size": 1
},
"$results": [
{
"#unitups": [],
"#min": 1,
"#max": 1,
"#allunitups": [],
"DescriptionLevel": "Item",
"Title": "My title3",
"Description": "Allemant. - Au chemin des Dames : le chateau et la ferme de la Motte totalement detruits.",
"Descriptions": {
"fr": "La legendes traduites en anglais."
},
"Status": "Pret",
"Tag": [
"Grande Collecte"
],
"Source": "Famille Herve, CP1",
"CreatedDate": "2014-06-12T09:31:00",
"TransactedDate": "2014-06-12T09:31:00",
"#management": {},
"#originating_agencies": [],
"#id": "aeeaaaaaach2brfeabbykal7ds6p33qaaaaq",
"#opi": "aeeaaaaaach2brfeabbykal7ds53vdqaaaaq"
}
],
"$facetResults": [],
"$context": {}
}
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 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- 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 pour accéder aux Unités d'archives liées à une transaction avec leurs règles de gestion héritées . La requête utilise le langage de requête DSL de Vitam en entrée et retourne une liste d'Unités d'archives avec leurs règles de gestion selon le DSL Vitam en cas de succès.
get /transactions/{id}/unitsWithInheritedRules
API pour accéder aux Unités d'archives liées à une transaction avec leurs règles de gestion héritées . La requête utilise le langage de requête DSL de Vitam en entrée et retourne une liste d'Unités d'archives avec leurs règles de gestion selon le DSL Vitam en cas de succès.
Based on Platform Secret
URI Parameters
- id: required(string)
Identifiant de la transaction
Headers
- X-tenant-Id: 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
Body
Media type: application/json
Type: object
Example:
{
"httpCode": 200,
"$hits": {
"total": 1,
"offset": 0,
"limit": 10000,
"size": 1
},
"$results": [
{
"Title": "BP_123457_20230131.pdf",
"#id": "aeaqaaaaaehmdzhmaayjqamhbiwrgnaaaaaq",
"InheritedRules": {
"GlobalProperties": [],
"HoldRule": {
"Rules": [],
"Properties": []
},
"StorageRule": {
"Rules": [],
"Properties": []
},
"AppraisalRule": {
"Rules": [
{
"UnitId": "aeaqaaaaaehmdzhmaayjqamhbiwrgnaaaaaq",
"Paths": [
[
"aeaqaaaaaehmdzhmaayjqamhbiwrgnaaaaaq"
]
],
"Rule": "APP-00002"
}
],
"Properties": [
{
"UnitId": "aeaqaaaaaehmdzhmaayjqamhbiwrgnaaaaaq",
"Paths": [
[
"aeaqaaaaaehmdzhmaayjqamhbiwrgnaaaaaq"
]
],
"PropertyName": "FinalAction",
"PropertyValue": "Destroy"
}
]
},
"DisseminationRule": {
"Rules": [],
"Properties": []
},
"ReuseRule": {
"Rules": [],
"Properties": []
},
"ClassificationRule": {
"Rules": [],
"Properties": []
},
"AccessRule": {
"Rules": [
{
"UnitId": "aeaqaaaaaehmdzhmaayjqamhbiwrgnaaaaaq",
"Paths": [
[
"aeaqaaaaaehmdzhmaayjqamhbiwrgnaaaaaq"
]
],
"Rule": "ACC-00016",
"StartDate": "2023-01-20"
},
{
"UnitId": "aeaqaaaaaehmdzhmaayjqamhbiwrfoiaaaaq",
"Paths": [
[
"aeaqaaaaaehmdzhmaayjqamhbiwrgnaaaaaq",
"aeaqaaaaaehmdzhmaayjqamhbiwrfoiaaaaq"
]
],
"Rule": "ACC-00001",
"StartDate": "2023-01-27"
}
],
"Properties": []
}
}
}
],
"$facetResults": [],
"$context": {
"$roots": [],
"$query": [
{
"$eq": {
"#id": "aeaqaaaaaehmdzhmaayjqamhbiwrgnaaaaaq"
}
}
],
"$filter": {},
"$projection": {
"$fields": {
"#id": 1,
"Title": 1
}
}
}
}
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 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- 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 fermer une transaction
post /transactions/{id}/close
Permet de fermer une transaction
Based on Platform Secret
URI Parameters
- id: required(string)
Identifiant de la transaction
Headers
- X-tenant-Id: 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
Body
Media type: application/json
Type: any
HTTP status code 200
Body
Media type: application/json
Type: object
Example:
{
"httpCode": 200,
"$hits": {
"total": 0,
"offset": 0,
"limit": 0,
"size": 0
},
"$results": [],
"$facetResults": [],
"$context": {}
}
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 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- 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 génerer un SIP et l'envoyer a Vitam (Ingest)
post /transactions/{id}/send
Permet de génerer un SIP et l'envoyer a Vitam (Ingest)
Based on Platform Secret
URI Parameters
- id: required(string)
Identifiant de la transaction
Headers
- X-tenant-Id: 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
Body
Media type: application/json
Type: any
HTTP status code 200
Body
Media type: application/json
Type: object
Example:
{
"httpCode": 200,
"$hits": {
"total": 1,
"offset": 0,
"limit": 0,
"size": 1
},
"$results": [
{
"id": "aeeaaaaaachbhe3yabli6al7eymg7iqaaaaq"
}
],
"$facetResults": [],
"$context": {}
}
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 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- 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 de collecte. Ce point d'entrée permet de supprimer une transaction.
delete /transactions/{id}
Based on Platform Secret
URI Parameters
- id: required(string)
Identifiant de la transaction
Headers
- x-tenant-id: 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
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 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- 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 soumettre un ensemble de binaire au format Zip
post /transactions/{id}/upload
Permet de soumettre un ensemble de binaire au format Zip
Based on Platform Secret
URI Parameters
- id: required(string)
Identifiant de la transaction
Headers
- X-tenant-Id: required(string)
- X-Encoding: (string)
Encodage du zip, par default VITAM utilise UTF-8
- 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/zip
Type: any
HTTP status code 200
Body
Media type: application/json
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 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- 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
Units
API de collecte. Ce point d'entrée permet de gérer une unité archivistique et les groupe d'objets.
Permet de récuperer une ou plusieurs unité archivistique par DSL QUERY
get /units
Permet de récuperer une ou plusieurs unité archivistique par DSL QUERY
Based on Platform Secret
Headers
- X-tenant-Id: 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
Body
Media type: application/json
Type: object
Example:
{
"$roots": [],
"$query": [
{
"$eq": {
"#opi": "aeeaaaaaacggvocrabzt6ama3soizdqaaaaq"
}
}
],
"$filter": {
"$offset": 0,
"$limit": 100
},
"$projection": {}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Example:
{
"httpCode": 200,
"$hits": {
"total": 1,
"offset": 0,
"limit": 0,
"size": 1
},
"$results": [
{
"Title": "OK_regles_CSV.csv",
"DescriptionLevel": "Item",
"#id": "aeeaaaaaaghguhgcabg2kambq44wthaaaaaq",
"#tenant": 1,
"#object": "aeeaaaaaaghguhgcabg2kambq44wucyaaaaq",
"#unitups": [
"aeeaaaaaaghguhgcabg2kambq44wshyaaaaq"
],
"#min": 1,
"#max": 3,
"#allunitups": [
"aeeaaaaaaghguhgcabg2kambq44vqxaaaaaq",
"aeeaaaaaaghguhgcabg2kambq44wshyaaaaq"
],
"#management": {},
"#opi": "aeeaaaaaaghguhgcabg2kambq4vdhmqaaaaq",
"#originating_agencies": [],
"#version": 1,
"#approximate_creation_date": "2022-06-21T17:04:55.739",
"#approximate_update_date": "2022-06-21T17:04:55.908"
},
{
"Title": "AU3",
"DescriptionLevel": "RecordGrp",
"#id": "aeeaaaaaaghguhgcabg2kambq44wshyaaaaq",
"#tenant": 1,
"#unitups": [
"aeeaaaaaaghguhgcabg2kambq44vqxaaaaaq"
],
"#min": 1,
"#max": 2,
"#allunitups": [
"aeeaaaaaaghguhgcabg2kambq44vqxaaaaaq"
],
"#management": {},
"#opi": "aeeaaaaaaghguhgcabg2kambq4vdhmqaaaaq",
"#originating_agencies": [],
"#version": 0,
"#approximate_creation_date": "2022-06-21T17:04:55.603",
"#approximate_update_date": "2022-06-21T17:04:55.603"
},
{
"Title": "OK_regles_CSV.csv",
"DescriptionLevel": "Item",
"#id": "aeeaaaaaaghguhgcabg2kambq44v2hyaaaaq",
"#tenant": 1,
"#object": "aeeaaaaaaghguhgcabg2kambq44waraaaaaq",
"#unitups": [
"aeeaaaaaaghguhgcabg2kambq44vwtaaaaaq"
],
"#min": 1,
"#max": 3,
"#allunitups": [
"aeeaaaaaaghguhgcabg2kambq44vqxaaaaaq",
"aeeaaaaaaghguhgcabg2kambq44vwtaaaaaq"
],
"#management": {},
"#opi": "aeeaaaaaaghguhgcabg2kambq4vdhmqaaaaq",
"#originating_agencies": [],
"#version": 1,
"#approximate_creation_date": "2022-06-21T17:04:52.528",
"#approximate_update_date": "2022-06-21T17:04:53.650"
},
{
"Title": "AU2",
"DescriptionLevel": "RecordGrp",
"#id": "aeeaaaaaaghguhgcabg2kambq44vwtaaaaaq",
"#tenant": 1,
"#unitups": [
"aeeaaaaaaghguhgcabg2kambq44vqxaaaaaq"
],
"#min": 1,
"#max": 2,
"#allunitups": [
"aeeaaaaaaghguhgcabg2kambq44vqxaaaaaq"
],
"#management": {},
"#opi": "aeeaaaaaaghguhgcabg2kambq4vdhmqaaaaq",
"#originating_agencies": [],
"#version": 0,
"#approximate_creation_date": "2022-06-21T17:04:52.202",
"#approximate_update_date": "2022-06-21T17:04:52.202"
},
{
"Title": "AU de Rattachement",
"DescriptionLevel": "Series",
"#id": "aeeaaaaaaghguhgcabg2kambq44vqxaaaaaq",
"#tenant": 1,
"#unitups": [],
"#min": 1,
"#max": 1,
"#allunitups": [],
"#management": {
"UpdateOperation": {
"SystemId": "aeaqaaaaaahejxmxaaxqiambqkuggoaaaabq"
}
},
"#opi": "aeeaaaaaaghguhgcabg2kambq4vdhmqaaaaq",
"#originating_agencies": [],
"#version": 0,
"#approximate_creation_date": "2022-06-21T17:04:51.524",
"#approximate_update_date": "2022-06-21T17:04:51.524"
}
],
"$facetResults": [],
"$context": {
"$roots": [],
"$query": [
{
"$eq": {
"#opi": "aeeaaaaaaghguhgcabg2kambq4vdhmqaaaaq"
}
}
],
"$filter": {
"$offset": 0,
"$limit": 100
},
"$projection": {}
}
}
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 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- 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 retourner une unité archivistique par son id
get /units/{id}
Permet de retourner une unité archivistique par son id
Based on Platform Secret
URI Parameters
- id: required(string)
Identifiant de l'unité archivistique
Headers
- X-tenant-Id: 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
Body
Media type: application/json
Type: object
Example:
{
"httpCode": 201,
"$hits": {
"total": 1,
"offset": 0,
"limit": 0,
"size": 1
},
"$results": [
{
"#unitups": [],
"#min": 1,
"#max": 1,
"#allunitups": [],
"DescriptionLevel": "Item",
"Title": "My title3",
"Description": "Allemant. - Au chemin des Dames : le chateau et la ferme de la Motte totalement detruits.",
"Descriptions": {
"fr": "La legendes traduites en anglais."
},
"Status": "Pret",
"Tag": [
"Grande Collecte"
],
"Source": "Famille Herve, CP1",
"CreatedDate": "2014-06-12T09:31:00",
"TransactedDate": "2014-06-12T09:31:00",
"#management": {},
"#originating_agencies": [],
"#id": "aeeaaaaaach2brfeabbykal7ds6p33qaaaaq",
"#opi": "aeeaaaaaach2brfeabbykal7ds53vdqaaaaq"
}
],
"$facetResults": [],
"$context": {}
}
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 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- 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 rajouter un groupe d'objects
post /units/{id}/objects/{usage}/{version}
Permet de rajouter un groupe d'objects
Based on Platform Secret
URI Parameters
- id: required(string)
Identifiant de l'unité archivistique
- usage: required(string)
Usage du groupe d'objects
- version: required(string)
Version du groupe d'objects
Headers
- X-tenant-Id: 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
Body
Media type: application/json
Type: object
Example:
{
"fileInfo": {
"filename": "plan.txt"
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Example:
{
"httpCode": 200,
"$hits": {
"total": 1,
"offset": 0,
"limit": 0,
"size": 1
},
"$results": [
{
"id": "aeeaaaaaach2brfeabbykal7egm5ysyaaaaq",
"fileInfo": {
"lastModified": "2022-02-22T13:23:25.846",
"filename": "plan.txt"
}
}
],
"$facetResults": [],
"$context": {}
}
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 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- 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 un binaire
Permet de rajouter un binaire
get /units/{id}/objects/{usage}/{version}/binary
Permet de télécharger un binaire
Based on Platform Secret
URI Parameters
- id: required(string)
Identifiant de l'unité archivistique
- usage: required(string)
Usage du groupe d'objects
- version: required(string)
Version du groupe d'objects
Headers
- X-tenant-Id: 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
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 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- 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 /units/{id}/objects/{usage}/{version}/binary
Permet de rajouter un binaire
Based on Platform Secret
URI Parameters
- id: required(string)
Identifiant de l'unité archivistique
- usage: required(string)
Usage du groupe d'objects
- version: required(string)
Version du groupe d'objects
Headers
- X-tenant-Id: 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
Body
Media type: application/octet-stream
Type: any
HTTP status code 200
Body
Media type: application/json
Type: object
Example:
{
"httpCode": 200,
"$hits": {
"total": 0,
"offset": 0,
"limit": 0,
"size": 0
},
"$results": [],
"$facetResults": [],
"$context": {}
}
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 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required(string)
Unique Request Identifier
Example:
AbDUh67jj
- FullApiVersion: required(string)
Complete Version of the API.
Example:
V1.25
- 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