API-Vitam - Administration Management API documentation version v1
https://api.vitam.gouv.fr/admin-external/{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.
Pour le détail du modèle de chaque collection, se référer à la documentation du modèle de données.
Licence
Ce document est distribué sous les termes de la Licence Ouverte V2.0
API Registre des fonds
L'API additionnelle sur le Registre des fonds propose les points d'entrées et les méthodes pour requêter et récupérer les informations des collections suivantes :
- Registre des Fonds
- Sommaire
- Détails
Registre des Fonds
Celui-ci est alimenté automatiquement par le processus d'entrée.
- Le Sommaire inclut les informations générales du fond
- Le Détail inclut les informations détaillées, entrée par entrée du fond concerné
API Administration
L'API d'administration fonctionnelle propose les points d'entrées et les méthodes pour requêter et récupérer les informations des collections suivantes :
- Référentiel des Formats basé sur PRONOM (TNA)
- Référentiel des Règles de Gestion
- Référentiel des Contrats d'Entrées
- Référentiel des Contrats d'Accès
- Référentiel des Contextes
- Référentiel des Profiles de Sécurité
- Registre des Fonds
- Référentiel des Services Agents
- Opérations
Tenant d'administration
Certaines APIs dites "cross-tenants" nécessitent une vérification spécifique. Ces opérations doivent être exécutées à partir d'un tenant dit tenant d'administration (configuré comme tel à l'intérieur de VITAM). Il s'agit de s'assurer que pour les collections Formats, Contextes et Profils de sécurité, le tenant utilisé pour l'import soit conforme à celui configuré dans VITAM. En cas de différence, une erreur 401 sera retournée.
Référentiel des Formats
Ce référentiel est basé sur PRONOM (TNA) mais il peut être étendu. Il est trans-tenant.
- L'extension est à ce jour non supporté (UNSUPPORTED)
- Il est possible de mettre à jour ce référentiel via les API.
- Notez cependant que la mise à jour des outils utilisant ce référentiel n'est pas encore opérationnelle. Il n'est donc pas recommandé de mettre à jour ce référentiel avec une autre version que celle livrée par Vitam.
Référentiel des Règles de Gestion
Il est possible de mettre à jour ce référentiel via les API. Il est par tenant.
Actuellement ce référentiel est utilisé lors du processus d'entrée mais il n'est pas encore utilisé par les accès.
Référentiel des Contrats d'Entrées
Il est possible de mettre à jour ce référentiel via les API. Il est par tenant.
Actuellement ce référentiel est utilisé lors du processus d'entrées.
Référentiel des Contrats d'Accès
Il est possible de mettre à jour ce référentiel via les API. Il est par tenant.
Actuellement ce référentiel est utilisé lors des accès.
Référentiel des Contextes
Il est possible de mettre à jour ce référentiel via les API. Il est par tenant.
Actuellement ce référentiel n'est pas utilisé lors du processus d'entrée ou des accès.
Il doit faire le lien entre l'authentification (TLS) et les droits et contrats de l'application externe partenaire.
Référentiel des Profiles de Sécurité
Il est possible de mettre à jour ce référentiel via les API.
Actuellement ce référentiel pour le contrôle d'accès aux API.
Référentiel des Services Agents
Actuellement ce référentiel est utilisé lors du processus d'entrées.
Registre des Fonds
Ce référentiel est utilisé et mis à jour lors du processus d'entrée.
Gestion des processus
Il est possible de gérer les processus en mode administrateur (CANCEL, PAUSE, NEXT, REPLAY, RESUME).
Sécurisation des journaux - vérification
traceability/checks est le point d'entrée pour la vérification de la sécurisation des journaux d'opérations dans Vitam.
FileFormats
API qui définit les requêtes pour accéder au référentiel des Formats. La requête utilise le langage de requête (DSL) de Vitam en entrée et retourne une liste de formats selon le DSL Vitam en cas de succès.
Requête qui retourne des résultats contenant des Formats. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Formats selon le DSL Vitam en cas de succès.
Requête qui retourne des résultats contenant des Formats si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe à partir d'un fichier PRONOM (see TNA) un nouveau référentiel.
get /formats
Requête qui retourne des résultats contenant des Formats. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Formats selon le DSL Vitam en cas de succès.
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
HTTP status code 200
Renvoie la liste des résultats de type Formats correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Formats
Media type: application/json
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
post /formats
Requête qui retourne des résultats contenant des Formats si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe à partir d'un fichier PRONOM (see TNA) un nouveau référentiel.
Headers
- X-Http-Method-Override: (GET)
- X-Filename: (string)
Name of the file uploaded
Examples:
Rules_v5.csv
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
Description: Contient le fichier source Formats au format XML (Formats from PRONOM registry)
Media type: application/xml
Type: object
Description: Contient le fichier source Formats au format CSV (Rules)
Media type: application/csv
Type: object
Description: Contient le fichier source Formats au format InputStream (for all)
Media type: application/octet-stream
Type: object
HTTP status code 200
Renvoie la liste des résultats de type Formats correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Formats
Media type: application/json
HTTP status code 201
Réponse si le versement ou la vérification de Formats est OK
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
API qui définit les requêtes pour accéder à un format dans le référentiel des Formats.
Retourne une liste de Formats contenant 1 seul résultat en cas de succès.
Retourne une liste de Formats contenant 1 seul résultat en cas de succès. La requête utilise POST avec X-Http-Method-Override: GET
get /formats/{idf}
Retourne une liste de Formats contenant 1 seul résultat en cas de succès.
URI Parameters
- idf: required (string)
Identifiant du format
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
HTTP status code 200
Retourne un élément de type Formats
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: un élément de type Formats
Media type: application/json
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
post /formats/{idf}
Retourne une liste de Formats contenant 1 seul résultat en cas de succès. La requête utilise POST avec X-Http-Method-Override: GET
URI Parameters
- idf: required (string)
Identifiant du format
Headers
- X-Http-Method-Override: required (GET)
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
HTTP status code 200
Retourne un élément de type Formats
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: un élément de type Formats
Media type: application/json
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
FileFormats check
API qui permet de vérifier que le fichier est correct, et peut être importé.
Vérifie si un fichier source PRONOM (see TNA) peut être importé comme nouveau Référentiel.
post /formatsfilecheck
Vérifie si un fichier source PRONOM (see TNA) peut être importé comme nouveau Référentiel.
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient le fichier source Formatsfilecheck au format XML (Formats from PRONOM registry)
Media type: application/xml
Type: object
Description: Contient le fichier source Formatsfilecheck au format CSV (Rules)
Media type: application/csv
Type: object
Description: Contient le fichier source Formatsfilecheck au format Json (ingestcontracts, accesscontracts, contexts, profiles)
Media type: application/json
Type: object
Description: Contient le fichier source Formatsfilecheck au format InputStream (for all)
Media type: application/octet-stream
Type: object
HTTP status code 200
OK, operation in success
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 201
Réponse si le versement ou la vérification de Formatsfilecheck est OK
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Rules
API qui définit les requêtes pour accéder au référentiel des Règles de gestion. La requête utilise le langage de requête (DSL) de Vitam en entrée et retourne une liste de règles selon le DSL Vitam en cas de succès.
Requête qui retourne des résultats contenant des Règles de gestion. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Règles de gestion selon le DSL Vitam en cas de succès.
Requête qui retourne des résultats contenant des Règles de gestion si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe à partir d'un fichier CSV contenant les définitions des Règles de gestion un nouveau référentiel.
get /rules
Requête qui retourne des résultats contenant des Règles de gestion. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Règles de gestion selon le DSL Vitam en cas de succès.
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
HTTP status code 200
Renvoie la liste des résultats de type Rules correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Rules
Media type: application/json
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
post /rules
Requête qui retourne des résultats contenant des Règles de gestion si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe à partir d'un fichier CSV contenant les définitions des Règles de gestion un nouveau référentiel.
Headers
- X-Http-Method-Override: (GET)
- X-Filename: (string)
Name of the file uploaded
Examples:
Rules_v5.csv
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
Description: Contient le fichier source Rules au format XML (Formats from PRONOM registry)
Media type: application/xml
Type: object
Description: Contient le fichier source Rules au format CSV (Rules)
Media type: application/csv
Type: object
Description: Contient le fichier source Rules au format InputStream (for all)
Media type: application/octet-stream
Type: object
HTTP status code 200
Renvoie la liste des résultats de type Rules correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Rules
Media type: application/json
HTTP status code 201
Réponse si le versement ou la vérification de Rules est OK
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
API qui définit les requêtes pour accéder à une Règle dans le référentiel des Règles de gestion.
Retourne une liste de Règles de gestion contenant 1 seul résultat en cas de succès.
Retourne une liste de Règles de gestion contenant 1 seul résultat en cas de succès. La requête utilise POST avec X-Http-Method-Override: GET
get /rules/{idr}
Retourne une liste de Règles de gestion contenant 1 seul résultat en cas de succès.
URI Parameters
- idr: required (string)
Identifiant de la règle de gestion
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
HTTP status code 200
Retourne un élément de type Rules
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: un élément de type Rules
Media type: application/json
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
post /rules/{idr}
Retourne une liste de Règles de gestion contenant 1 seul résultat en cas de succès. La requête utilise POST avec X-Http-Method-Override: GET
URI Parameters
- idr: required (string)
Identifiant de la règle de gestion
Headers
- X-Http-Method-Override: required (GET)
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
HTTP status code 200
Retourne un élément de type Rules
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: un élément de type Rules
Media type: application/json
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
FileRules check
API qui permet de vérifier que le fichier est correct, et peut être importé.
Vérifie si un fichier source CSV contenant les définitions des Règles de gestion peut être importé comme nouveau Référentiel.
put /rulesfilecheck
Vérifie si un fichier source CSV contenant les définitions des Règles de gestion peut être importé comme nouveau Référentiel.
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient le fichier source Rulesfilecheck au format XML (Formats from PRONOM registry)
Media type: application/xml
Type: object
Description: Contient le fichier source Rulesfilecheck au format CSV (Rules)
Media type: application/csv
Type: object
Description: Contient le fichier source Rulesfilecheck au format Json (ingestcontracts, accesscontracts, contexts, profiles)
Media type: application/json
Type: object
Description: Contient le fichier source Rulesfilecheck au format InputStream (for all)
Media type: application/octet-stream
Type: object
HTTP status code 200
OK, operation in success
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 201
Réponse si le versement ou la vérification de Rulesfilecheck est OK
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Rules report
Permet de télécharger un objet représentant le rapport d'import des règles en fonction de l'id de l'opération
Permet de télécharger un objet représentant le rapport d'import des règles en fonction de l'id de l'opération
Requête qui permet de télécharger un objet représentant le rapport d'import des règles en fonction de l'id de l'opération. La requête utilise POST avec X-Http-Method-Override: GET
get /rulesreport/{idop}
Permet de télécharger un objet représentant le rapport d'import des règles en fonction de l'id de l'opération
URI Parameters
- idop: required (string)
Identifiant de l'opération concernée
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
HTTP status code 200
Retourne un fichier de type Rulesreport
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: un fichier de type Rulesreport
Media type: application/octet-stream
Type: object
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
post /rulesreport/{idop}
Requête qui permet de télécharger un objet représentant le rapport d'import des règles en fonction de l'id de l'opération. La requête utilise POST avec X-Http-Method-Override: GET
URI Parameters
- idop: required (string)
Identifiant de l'opération concernée
Headers
- X-Http-Method-Override: required (GET)
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
HTTP status code 200
Retourne un élément de type Rulesreport
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: un élément de type Rulesreport
Media type: application/json
Description: un fichier de type Rulesreport
Media type: application/octet-stream
Type: object
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
AccessionRegisters
API qui définit les requêtes pour accéder au Registre des Fonds. La requête utilise le langage de requête (DSL) de Vitam en entrée et retourne une liste de registres selon le DSL Vitam en cas de succès.
Requête qui retourne des résultats contenant des Registres de Fonds. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Registres de Fonds selon le DSL Vitam en cas de succès.
Requête qui retourne des résultats contenant des Registres de Fonds. La requête utilise POST avec X-Http-Method-Override: GET. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Registres de Fonds selon le DSL Vitam en cas de succès.
get /accessionregisters
Requête qui retourne des résultats contenant des Registres de Fonds. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Registres de Fonds selon le DSL Vitam en cas de succès.
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
HTTP status code 200
Renvoie la liste des résultats de type Accessionregisters correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Accessionregisters
Media type: application/json
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
post /accessionregisters
Requête qui retourne des résultats contenant des Registres de Fonds. La requête utilise POST avec X-Http-Method-Override: GET. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Registres de Fonds selon le DSL Vitam en cas de succès.
Headers
- X-Http-Method-Override: required (GET)
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
HTTP status code 200
Renvoie la liste des résultats de type Accessionregisters correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Accessionregisters
Media type: application/json
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
API qui définit les requêtes pour accéder au détail d'un Fond dans le Registre des Fonds.
Retourne une liste de Détails d'un Registre de Fonds contenant 1 seul résultat en cas de succès. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée.
Retourne une liste de Détails d'un Registre de Fonds contenant 1 seul résultat en cas de succès. La requête utilise POST avec X-Http-Method-Override: GET. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée.
get /accessionregisters/{idar}/accessionregisterdetails
Retourne une liste de Détails d'un Registre de Fonds contenant 1 seul résultat en cas de succès. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée.
URI Parameters
- idar: required (string)
Identifiant du registre des fonds
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
HTTP status code 200
Renvoie la liste des résultats de type Accessionregisterdetails correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Accessionregisterdetails
Media type: application/json
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
post /accessionregisters/{idar}/accessionregisterdetails
Retourne une liste de Détails d'un Registre de Fonds contenant 1 seul résultat en cas de succès. La requête utilise POST avec X-Http-Method-Override: GET. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée.
URI Parameters
- idar: required (string)
Identifiant du registre des fonds
Headers
- X-Http-Method-Override: required (GET)
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
HTTP status code 200
Renvoie la liste des résultats de type Accessionregisterdetails correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Accessionregisterdetails
Media type: application/json
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Access contracts
API qui définit les requêtes pour accéder aux contracs d'accès La requête utilise le langage de requête (DSL) de Vitam en entrée et retourne une liste de contrats d'accès selon le DSL Vitam en cas de succès.
Requête qui retourne des résultats contenant des Contrats d'accès. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Contrats d'accès selon le DSL Vitam en cas de succès.
Requête qui retourne des résultats contenant des Contrats d'accès si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe un ensemble de contrats d'accès qui sont sauvegardés et indexés en cas de succès
get /accesscontracts
Requête qui retourne des résultats contenant des Contrats d'accès. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Contrats d'accès selon le DSL Vitam en cas de succès.
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
HTTP status code 200
Renvoie la liste des résultats de type Accesscontracts correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Accesscontracts
Media type: application/json
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
post /accesscontracts
Requête qui retourne des résultats contenant des Contrats d'accès si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe un ensemble de contrats d'accès qui sont sauvegardés et indexés en cas de succès
Headers
- X-Http-Method-Override: (GET)
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
Description: Contient le fichier source Accesscontracts au format XML (Formats from PRONOM registry)
Media type: application/xml
Type: object
Description: Contient le fichier source Accesscontracts au format CSV (Rules)
Media type: application/csv
Type: object
Description: Contient le fichier source Accesscontracts au format InputStream (for all)
Media type: application/octet-stream
Type: object
HTTP status code 200
Renvoie la liste des résultats de type Accesscontracts correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Accesscontracts
Media type: application/json
HTTP status code 201
Réponse si le versement ou la vérification de Accesscontracts est OK
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
API qui permet de mettre à jour un contrat d'accès via une requête de mise à jour ou d'accéder à un contrat d'accès
Retourne une liste de Contrats d'accès contenant 1 seul résultat en cas de succès.
Requête qui modifie un Contrat d'accès. La requête utilise le langage de requête DSL de type modification unitaire (UPDATE BY ID) de Vitam en entrée et retourne le statut de la mise à jour en résultat selon le DSL Vitam en cas de succès.
get /accesscontracts/{idac}
Retourne une liste de Contrats d'accès contenant 1 seul résultat en cas de succès.
URI Parameters
- idac: required (string)
Identifiant du contrat d'accès
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
HTTP status code 200
Renvoie la liste des résultats de type Accesscontracts correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Accesscontracts
Media type: application/json
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
put /accesscontracts/{idac}
Requête qui modifie un Contrat d'accès. La requête utilise le langage de requête DSL de type modification unitaire (UPDATE BY ID) de Vitam en entrée et retourne le statut de la mise à jour en résultat selon le DSL Vitam en cas de succès.
URI Parameters
- idac: required (string)
Identifiant du contrat d'accès
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient le fichier source Accesscontracts au format XML (Formats from PRONOM registry)
Media type: application/xml
Type: object
Description: Contient le fichier source Accesscontracts au format CSV (Rules)
Media type: application/csv
Type: object
Description: Contient le fichier source Accesscontracts au format Json (ingestcontracts, accesscontracts, contexts, profiles)
Media type: application/json
Type: object
Description: Contient le fichier source Accesscontracts au format InputStream (for all)
Media type: application/octet-stream
Type: object
HTTP status code 200
OK, operation in success
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 201
Réponse si le versement ou la vérification de Accesscontracts est OK
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Ingest contracts
API qui définit les requêtes pour accéder aux contrats d'entrée La requête utilise le langage de requête (DSL) de Vitam en entrée et retourne une liste de contrats d'entrée selon le DSL Vitam en cas de succès.
Requête qui retourne des résultats contenant des Contrats d'entrée. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Contrats d'entrée selon le DSL Vitam en cas de succès.
Requête qui retourne des résultats contenant des Contrats d'entrée si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe un ensemble de contrats d'entrée qui sont sauvegardés et indexés en cas de succès
get /ingestcontracts
Requête qui retourne des résultats contenant des Contrats d'entrée. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Contrats d'entrée selon le DSL Vitam en cas de succès.
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
HTTP status code 200
Renvoie la liste des résultats de type Ingestcontracts correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Ingestcontracts
Media type: application/json
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
post /ingestcontracts
Requête qui retourne des résultats contenant des Contrats d'entrée si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe un ensemble de contrats d'entrée qui sont sauvegardés et indexés en cas de succès
Headers
- X-Http-Method-Override: (GET)
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
Description: Contient le fichier source Ingestcontracts au format XML (Formats from PRONOM registry)
Media type: application/xml
Type: object
Description: Contient le fichier source Ingestcontracts au format CSV (Rules)
Media type: application/csv
Type: object
Description: Contient le fichier source Ingestcontracts au format InputStream (for all)
Media type: application/octet-stream
Type: object
HTTP status code 200
Renvoie la liste des résultats de type Ingestcontracts correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Ingestcontracts
Media type: application/json
HTTP status code 201
Réponse si le versement ou la vérification de Ingestcontracts est OK
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
API qui permet de mettre à jour un contrat d'entrée via une requête de mise à jour ou d'accéder à un contrat d'entrée
Retourne une liste de Contrats d'entrée contenant 1 seul résultat en cas de succès.
Requête qui modifie un Contrat d'entrée. La requête utilise le langage de requête DSL de type modification unitaire (UPDATE BY ID) de Vitam en entrée et retourne le statut de la mise à jour en résultat selon le DSL Vitam en cas de succès.
get /ingestcontracts/{idic}
Retourne une liste de Contrats d'entrée contenant 1 seul résultat en cas de succès.
URI Parameters
- idic: required (string)
Identifiant du contrat d'entrée
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
HTTP status code 200
Renvoie la liste des résultats de type Ingestcontracts correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Ingestcontracts
Media type: application/json
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
put /ingestcontracts/{idic}
Requête qui modifie un Contrat d'entrée. La requête utilise le langage de requête DSL de type modification unitaire (UPDATE BY ID) de Vitam en entrée et retourne le statut de la mise à jour en résultat selon le DSL Vitam en cas de succès.
URI Parameters
- idic: required (string)
Identifiant du contrat d'entrée
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient le fichier source Ingestcontracts au format XML (Formats from PRONOM registry)
Media type: application/xml
Type: object
Description: Contient le fichier source Ingestcontracts au format CSV (Rules)
Media type: application/csv
Type: object
Description: Contient le fichier source Ingestcontracts au format Json (ingestcontracts, accesscontracts, contexts, profiles)
Media type: application/json
Type: object
Description: Contient le fichier source Ingestcontracts au format InputStream (for all)
Media type: application/octet-stream
Type: object
HTTP status code 200
OK, operation in success
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 201
Réponse si le versement ou la vérification de Ingestcontracts est OK
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Contexts
API qui définit les requêtes pour accéder aux contextes d'applications externes La requête utilise le langage de requête (DSL) de Vitam en entrée et retourne une liste de contextes selon le DSL Vitam en cas de succès.
Requête qui retourne des résultats contenant des Contextes. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Contextes selon le DSL Vitam en cas de succès.
Requête qui retourne des résultats contenant des Contextes si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe un ensemble de contextes qui sont sauvegardés et indexés en cas de succès
get /contexts
Requête qui retourne des résultats contenant des Contextes. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Contextes selon le DSL Vitam en cas de succès.
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
HTTP status code 200
Renvoie la liste des résultats de type Contexts correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Contexts
Media type: application/json
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
post /contexts
Requête qui retourne des résultats contenant des Contextes si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe un ensemble de contextes qui sont sauvegardés et indexés en cas de succès
Headers
- X-Http-Method-Override: (GET)
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
Description: Contient le fichier source Contexts au format XML (Formats from PRONOM registry)
Media type: application/xml
Type: object
Description: Contient le fichier source Contexts au format CSV (Rules)
Media type: application/csv
Type: object
Description: Contient le fichier source Contexts au format InputStream (for all)
Media type: application/octet-stream
Type: object
HTTP status code 200
Renvoie la liste des résultats de type Contexts correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Contexts
Media type: application/json
HTTP status code 201
Réponse si le versement ou la vérification de Contexts est OK
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
API qui permet de mettre à jour un contexte via une requête de mise à jour ou d'accéder à un contexte
Retourne une liste de Contexte contenant 1 seul résultat en cas de succès.
Requête qui modifie un Contexte. La requête utilise le langage de requête DSL de type modification unitaire (UPDATE BY ID) de Vitam en entrée et retourne le statut de la mise à jour en résultat selon le DSL Vitam en cas de succès.
get /contexts/{idc}
Retourne une liste de Contexte contenant 1 seul résultat en cas de succès.
URI Parameters
- idc: required (string)
Identifiant du contexte
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
HTTP status code 200
Renvoie la liste des résultats de type Contexts correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Contexts
Media type: application/json
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
put /contexts/{idc}
Requête qui modifie un Contexte. La requête utilise le langage de requête DSL de type modification unitaire (UPDATE BY ID) de Vitam en entrée et retourne le statut de la mise à jour en résultat selon le DSL Vitam en cas de succès.
URI Parameters
- idc: required (string)
Identifiant du contexte
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient le fichier source Contexts au format XML (Formats from PRONOM registry)
Media type: application/xml
Type: object
Description: Contient le fichier source Contexts au format CSV (Rules)
Media type: application/csv
Type: object
Description: Contient le fichier source Contexts au format Json (ingestcontracts, accesscontracts, contexts, profiles)
Media type: application/json
Type: object
Description: Contient le fichier source Contexts au format InputStream (for all)
Media type: application/octet-stream
Type: object
HTTP status code 200
OK, operation in success
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 201
Réponse si le versement ou la vérification de Contexts est OK
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Profiles
API qui définit les requêtes pour accéder aux profils La requête utilise le langage de requête (DSL) de Vitam en entrée et retourne une liste de profils selon le DSL Vitam en cas de succès.
Requête qui retourne des résultats contenant des Profils. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Profils selon le DSL Vitam en cas de succès.
Requête qui retourne des résultats contenant des Profils si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe un ensemble de profils qui sont sauvegardés et indexés en cas de succès
get /profiles
Requête qui retourne des résultats contenant des Profils. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Profils selon le DSL Vitam en cas de succès.
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
HTTP status code 200
Renvoie la liste des résultats de type Profiles correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Profiles
Media type: application/json
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
post /profiles
Requête qui retourne des résultats contenant des Profils si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe un ensemble de profils qui sont sauvegardés et indexés en cas de succès
Headers
- X-Http-Method-Override: (GET)
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient le fichier source Profiles au format XML (Formats from PRONOM registry)
Media type: application/xml
Type: object
Description: Contient le fichier source Profiles au format CSV (Rules)
Media type: application/csv
Type: object
Description: Contient le fichier source Profiles au format Json (ingestcontracts, accesscontracts, contexts, profiles)
Media type: application/json
Type: object
Description: Contient le fichier source Profiles au format InputStream (for all)
Media type: application/octet-stream
Type: object
HTTP status code 200
Retourne un élément de type Profiles
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: un élément de type Profiles
Media type: application/json
HTTP status code 201
Réponse si le versement ou la vérification de Profiles est OK
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
API qui permet de mettre à jour un profil via une requête de mise à jour ou d'accéder à un profil
API qui définit les requêtes pour accéder à un profil ou à son schéma XSD ou RNG
Requête qui modifie un Profil. La requête utilise le langage de requête DSL de type modification unitaire (UPDATE BY ID) de Vitam en entrée et retourne le statut de la mise à jour en résultat selon le DSL Vitam en cas de succès.
Upload un profil au format XSD ou RNG
get /profiles/{idp}
API qui définit les requêtes pour accéder à un profil ou à son schéma XSD ou RNG
URI Parameters
- idp: required (string)
Identifiant du profil
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
HTTP status code 200
Renvoie la liste des résultats de type Profiles correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Profiles
Media type: application/json
Description: un fichier de type Profiles
Media type: application/octet-stream
Type: object
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
put /profiles/{idp}
Requête qui modifie un Profil. La requête utilise le langage de requête DSL de type modification unitaire (UPDATE BY ID) de Vitam en entrée et retourne le statut de la mise à jour en résultat selon le DSL Vitam en cas de succès.
URI Parameters
- idp: required (string)
Identifiant du profil
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient le fichier source Profiles au format XML (Formats from PRONOM registry)
Media type: application/xml
Type: object
Description: Contient le fichier source Profiles au format CSV (Rules)
Media type: application/csv
Type: object
Description: Contient le fichier source Profiles au format Json (ingestcontracts, accesscontracts, contexts, profiles)
Media type: application/json
Type: object
Description: Contient le fichier source Profiles au format InputStream (for all)
Media type: application/octet-stream
Type: object
HTTP status code 200
OK, operation in success
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 201
Réponse si le versement ou la vérification de Profiles est OK
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
post /profiles/{idp}
Upload un profil au format XSD ou RNG
URI Parameters
- idp: required (string)
Identifiant du profil
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient le fichier source Profiles au format InputStream (for Profile as XSD or RNG format)
Media type: application/octet-stream
Type: object
HTTP status code 200
OK, operation in success
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 201
Réponse si le versement ou la vérification de Profiles est OK
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Archive Unit Profiles
API qui définit les requêtes pour accéder aux document types La requête utilise le langage de requête (DSL) de Vitam en entrée et retourne une liste de document types selon le DSL Vitam en cas de succès.
Requête qui retourne des résultats contenant des Document types. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Document types selon le DSL Vitam en cas de succès.
La requête importe un ensemble de Document types qui sont sauvegardés et indexés en cas de succès
get /archiveunitprofiles
Requête qui retourne des résultats contenant des Document types. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Document types selon le DSL Vitam en cas de succès.
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
HTTP status code 200
Renvoie la liste des résultats de type Archiveunitprofiles correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Archiveunitprofiles
Media type: application/json
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
post /archiveunitprofiles
La requête importe un ensemble de Document types qui sont sauvegardés et indexés en cas de succès
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient le fichier source Archiveunitprofiles au format XML (Formats from PRONOM registry)
Media type: application/xml
Type: object
Description: Contient le fichier source Archiveunitprofiles au format CSV (Rules)
Media type: application/csv
Type: object
Description: Contient le fichier source Archiveunitprofiles au format Json (ingestcontracts, accesscontracts, contexts, profiles)
Media type: application/json
Type: object
Description: Contient le fichier source Archiveunitprofiles au format InputStream (for all)
Media type: application/octet-stream
Type: object
HTTP status code 200
OK, operation in success
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 201
Réponse si le versement ou la vérification de Archiveunitprofiles est OK
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
API qui permet de mettre à jour un document type via une requête de mise à jour ou d'accéder à un document type
API qui définit les requêtes pour accéder à un document type via son ID
Requête qui modifie un Document type. La requête utilise le langage de requête DSL de type modification unitaire (UPDATE BY ID) de Vitam en entrée et retourne le statut de la mise à jour en résultat selon le DSL Vitam en cas de succès.
get /archiveunitprofiles/{idp}
API qui définit les requêtes pour accéder à un document type via son ID
URI Parameters
- idp: required (string)
Identifiant du document type
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
HTTP status code 200
Renvoie la liste des résultats de type Archiveunitprofiles correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Archiveunitprofiles
Media type: application/json
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
put /archiveunitprofiles/{idp}
Requête qui modifie un Document type. La requête utilise le langage de requête DSL de type modification unitaire (UPDATE BY ID) de Vitam en entrée et retourne le statut de la mise à jour en résultat selon le DSL Vitam en cas de succès.
URI Parameters
- idp: required (string)
Identifiant du document type
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient le fichier source Archiveunitprofiles au format XML (Formats from PRONOM registry)
Media type: application/xml
Type: object
Description: Contient le fichier source Archiveunitprofiles au format CSV (Rules)
Media type: application/csv
Type: object
Description: Contient le fichier source Archiveunitprofiles au format Json (ingestcontracts, accesscontracts, contexts, profiles)
Media type: application/json
Type: object
Description: Contient le fichier source Archiveunitprofiles au format InputStream (for all)
Media type: application/octet-stream
Type: object
HTTP status code 200
OK, operation in success
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 201
Réponse si le versement ou la vérification de Archiveunitprofiles est OK
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Security Profiles
API qui définit les requêtes pour accéder aux Profils de Sécurité. La requête utilise le langage de requête (DSL) de Vitam en entrée et retourne une liste de profils de sécurité selon le DSL Vitam en cas de succès.
Requête qui retourne des résultats contenant des Profils de sécurité. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Profils de sécurité selon le DSL Vitam en cas de succès.
Requête qui retourne des résultats contenant des Profils de sécurité si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe un nouveau Profil de sécurité.
get /securityprofiles
Requête qui retourne des résultats contenant des Profils de sécurité. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Profils de sécurité selon le DSL Vitam en cas de succès.
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
HTTP status code 200
Renvoie la liste des résultats de type Securityprofiles correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Securityprofiles
Media type: application/json
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
post /securityprofiles
Requête qui retourne des résultats contenant des Profils de sécurité si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe un nouveau Profil de sécurité.
Headers
- X-Http-Method-Override: (GET)
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
Description: Contient le fichier source Securityprofiles au format XML (Formats from PRONOM registry)
Media type: application/xml
Type: object
Description: Contient le fichier source Securityprofiles au format CSV (Rules)
Media type: application/csv
Type: object
Description: Contient le fichier source Securityprofiles au format InputStream (for all)
Media type: application/octet-stream
Type: object
HTTP status code 200
Renvoie la liste des résultats de type Securityprofiles correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Securityprofiles
Media type: application/json
HTTP status code 201
Réponse si le versement ou la vérification de Securityprofiles est OK
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
API qui permet de mettre à jour un profil de sécurité via une requête de mise à jour ou d'accéder à un profil de sécurité
Retourne une liste de Profils de sécurité contenant 1 seul résultat en cas de succès.
Requête qui modifie un Profil de sécurité. La requête utilise le langage de requête DSL de type modification unitaire (UPDATE BY ID) de Vitam en entrée et retourne le statut de la mise à jour en résultat selon le DSL Vitam en cas de succès.
Retourne une liste de Profils de sécurité contenant 1 seul résultat en cas de succès. La requête utilise POST avec X-Http-Method-Override: GET.
get /securityprofiles/{identifier}
Retourne une liste de Profils de sécurité contenant 1 seul résultat en cas de succès.
URI Parameters
- identifier: required (string)
Identifiant du profil de sécurité
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
HTTP status code 200
Retourne un élément de type Securityprofiles
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: un élément de type Securityprofiles
Media type: application/json
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
put /securityprofiles/{identifier}
Requête qui modifie un Profil de sécurité. La requête utilise le langage de requête DSL de type modification unitaire (UPDATE BY ID) de Vitam en entrée et retourne le statut de la mise à jour en résultat selon le DSL Vitam en cas de succès.
URI Parameters
- identifier: required (string)
Identifiant du profil de sécurité
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient le fichier source Securityprofiles au format XML (Formats from PRONOM registry)
Media type: application/xml
Type: object
Description: Contient le fichier source Securityprofiles au format CSV (Rules)
Media type: application/csv
Type: object
Description: Contient le fichier source Securityprofiles au format Json (ingestcontracts, accesscontracts, contexts, profiles)
Media type: application/json
Type: object
Description: Contient le fichier source Securityprofiles au format InputStream (for all)
Media type: application/octet-stream
Type: object
HTTP status code 200
OK, operation in success
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 201
Réponse si le versement ou la vérification de Securityprofiles est OK
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
post /securityprofiles/{identifier}
Retourne une liste de Profils de sécurité contenant 1 seul résultat en cas de succès. La requête utilise POST avec X-Http-Method-Override: GET.
URI Parameters
- identifier: required (string)
Identifiant du profil de sécurité
Headers
- X-Http-Method-Override: required (GET)
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
HTTP status code 200
Retourne un élément de type Securityprofiles
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: un élément de type Securityprofiles
Media type: application/json
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Agencies
API qui définit les requêtes pour accéder au référentiel des Agencies. La requête utilise le langage de requête (DSL) de Vitam en entrée et retourne une liste d'agencies selon le DSL Vitam en cas de succès.
Requête qui retourne des résultats contenant des Agencies. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste d'Agencies selon le DSL Vitam en cas de succès.
Request that will return results composed of Agencies si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe un nouveau Référentiel d'Agencies.
get /agencies
Requête qui retourne des résultats contenant des Agencies. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste d'Agencies selon le DSL Vitam en cas de succès.
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
HTTP status code 200
Renvoie la liste des résultats de type Agencies correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Agencies
Media type: application/json
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
post /agencies
Request that will return results composed of Agencies si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe un nouveau Référentiel d'Agencies.
Headers
- X-Http-Method-Override: (GET)
- X-Filename: (string)
Name of the file uploaded
Examples:
Rules_v5.csv
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
Description: Contient le fichier source Agencies au format XML (Formats from PRONOM registry)
Media type: application/xml
Type: object
Description: Contient le fichier source Agencies au format CSV (Rules)
Media type: application/csv
Type: object
Description: Contient le fichier source Agencies au format InputStream (for all)
Media type: application/octet-stream
Type: object
HTTP status code 200
Renvoie la liste des résultats de type Agencies correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Agencies
Media type: application/json
HTTP status code 201
Réponse si le versement ou la vérification de Agencies est OK
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
API qui définit les requêtes pour accéder à un Agency dans le référentiel des Agencies.
Retourne une liste d'Agencies contenant 1 seul résultat en cas de succès.
Retourne une liste d'Agencies contenant 1 seul résultat en cas de succès. La requête utilise POST avec X-Http-Method-Override: GET.
get /agencies/{ida}
Retourne une liste d'Agencies contenant 1 seul résultat en cas de succès.
URI Parameters
- ida: required (string)
Identifiant de l'agency
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
HTTP status code 200
Retourne un élément de type Agencies
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: un élément de type Agencies
Media type: application/json
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
post /agencies/{ida}
Retourne une liste d'Agencies contenant 1 seul résultat en cas de succès. La requête utilise POST avec X-Http-Method-Override: GET.
URI Parameters
- ida: required (string)
Identifiant de l'agency
Headers
- X-Http-Method-Override: required (GET)
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
HTTP status code 200
Retourne un élément de type Agencies
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: un élément de type Agencies
Media type: application/json
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
FileAgencies check
API qui permet de vérifier que le fichier est correct, et peut être importé.
Vérifie si un fichier source Agencies (see TNA) peut être importé comme nouveau Référentiel.
post /agenciesfilecheck
Vérifie si un fichier source Agencies (see TNA) peut être importé comme nouveau Référentiel.
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient le fichier source Agenciesfilecheck au format XML (Formats from PRONOM registry)
Media type: application/xml
Type: object
Description: Contient le fichier source Agenciesfilecheck au format CSV (Rules)
Media type: application/csv
Type: object
Description: Contient le fichier source Agenciesfilecheck au format Json (ingestcontracts, accesscontracts, contexts, profiles)
Media type: application/json
Type: object
Description: Contient le fichier source Agenciesfilecheck au format InputStream (for all)
Media type: application/octet-stream
Type: object
HTTP status code 200
OK, operation in success
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 201
Réponse si le versement ou la vérification de Agenciesfilecheck est OK
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Operations
Administration des Workflows Asynchrones (opérations). Certaines opérations devraient être limitées aux seuls administrateurs car elles impactent le back-office.
Requête qui retourne des résultats contenant des opérations.
get /operations
Requête qui retourne des résultats contenant des opérations.
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Body containing a Query in DSL Vitam to filter the Ingest operations
Media type: application/json
Examples:
{
"id": "",
"states": [
"RUNNING"
],
"statuses": [
"OK",
"WARNING"
],
"workflows": [
"DefaultIngestWorkflow"
],
"listSteps": [
"STP_OG_STORING",
"STP_UNIT_STORING"
],
"startDateMin": "01/02/2017",
"startDateMax": "01/02/2017"
}HTTP status code 200
Returns the list of selected ingest operations
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Selected Ingest operations
Media type: application/json
Examples:
{
"httpCode": 200,
"$hits": {
"total": 3,
"size": 3,
"offset": 0,
"limit": 100
},
"$context": {
"$query": {
"$range": {
"start_date": {
"$gte": "2014-01-10",
"$lte": "2014-03-10"
}
}
},
"$filter": {
"$limit": 100
},
"$projection": {
"$fields": {
"#id": 1,
"start_date": 1,
"state": 1
}
}
},
"$results": [
{
"previousStep": "STP_INGEST_CONTROL_SIP",
"nextStep": "STP_OG_CHECK_AND_TRANSFORME",
"operation_id": "aedqaaaaacgbcaacabry4ak45ig4cwyaaaaq",
"processType": "INGEST",
"stepByStep": true,
"globalState": "PAUSE",
"stepStatus": "OK",
"processDate": "2017-06-27T14:56:29+0000"
},
{
"previousStep": "STP_INGEST_CONTROL_SIP",
"nextStep": "STP_OG_CHECK_AND_TRANSFORME",
"operation_id": "aedqaaaaacgbcaacabry4ak45cvfn5aaaaaq",
"processType": "INGEST",
"stepByStep": true,
"globalState": "PAUSE",
"stepStatus": "OK",
"processDate": "2017-06-27T08:28:16+0000"
}
]
}
HTTP status code 206
Returns the list of selected ingest operations using Cursor
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Selected Ingest operations
Media type: application/json
Examples:
{
"httpCode": 200,
"$hits": {
"total": 3,
"size": 3,
"offset": 0,
"limit": 100
},
"$context": {
"$query": {
"$range": {
"start_date": {
"$gte": "2014-01-10",
"$lte": "2014-03-10"
}
}
},
"$filter": {
"$limit": 100
},
"$projection": {
"$fields": {
"#id": 1,
"start_date": 1,
"state": 1
}
}
},
"$results": [
{
"previousStep": "STP_INGEST_CONTROL_SIP",
"nextStep": "STP_OG_CHECK_AND_TRANSFORME",
"operation_id": "aedqaaaaacgbcaacabry4ak45ig4cwyaaaaq",
"processType": "INGEST",
"stepByStep": true,
"globalState": "PAUSE",
"stepStatus": "OK",
"processDate": "2017-06-27T14:56:29+0000"
},
{
"previousStep": "STP_INGEST_CONTROL_SIP",
"nextStep": "STP_OG_CHECK_AND_TRANSFORME",
"operation_id": "aedqaaaaacgbcaacabry4ak45cvfn5aaaaaq",
"processType": "INGEST",
"stepByStep": true,
"globalState": "PAUSE",
"stepStatus": "OK",
"processDate": "2017-06-27T08:28:16+0000"
}
]
}
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Permet de récupérer le statut de l'opération dont l'identifiant est passée en paramètre
Permet de mettre à jour une opération lancée en précisant l'action à exécuter dans le header X-Action-Id; PAUSE pour la mettre en pause, NEXT pour exécuter l'étape suivante, RESUME pour continuer l'exécution de l'opération jusqu'au bout. Cette opération ne devrait être ouverte qu'aux administrateurs
Permet d'annuler un workflow lancé. Cette opération ne devrait être ouverte qu'aux administrateurs
Permet d'obtenir le statut d'une opération
get /operations/{idop}
Permet de récupérer le statut de l'opération dont l'identifiant est passée en paramètre
URI Parameters
- idop: required (string)
Identifiant de l'opération
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
put /operations/{idop}
Permet de mettre à jour une opération lancée en précisant l'action à exécuter dans le header X-Action-Id; PAUSE pour la mettre en pause, NEXT pour exécuter l'étape suivante, RESUME pour continuer l'exécution de l'opération jusqu'au bout. Cette opération ne devrait être ouverte qu'aux administrateurs
URI Parameters
- idop: required (string)
Identifiant de l'opération
Headers
- X-Action: required (one of RESUME, NEXT, PAUSE, REPLAY)
Permet d'influer sur le workflow. RESUME permet de poursuivre le workflow jusqu'à la fin. NEXT permet d'exécuter la prochaine étape pour ensuite se mettre en pause. PAUSE permet de demander la mise en pause du workflow à la fin de l'étape en cours. REPLAY permet de rejouer la dernière étape exécutée.
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
delete /operations/{idop}
Permet d'annuler un workflow lancé. Cette opération ne devrait être ouverte qu'aux administrateurs
URI Parameters
- idop: required (string)
Identifiant de l'opération
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
head /operations/{idop}
Permet d'obtenir le statut d'une opération
URI Parameters
- idop: required (string)
Identifiant de l'opération
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
HTTP status code 200
L'opération existe et est terminé, le statut est retourné
HTTP status code 202
L'opération existe mais n'est pas terminée
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Opération introuvable
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Workflows
Gestion des définitions des Workflows disponibles.
Requête qui retourne des résultats contenant des définitions de workflow.
get /workflows
Requête qui retourne des résultats contenant des définitions de workflow.
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
- X-Callback: (string)
UNSUPPORTED Callback uri when the operation will be done
Examples:
https://callback-host:port/uri/idcallback?status={status}&id={id}
HTTP status code 200
Returns the list of workflow definitions
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Select Workflows
Media type: application/json
Examples:
{
"httpCode" : 200,
"$hits": {
"total": 3,
"size": 3,
"offset": 0,
"limit": 100
},
"$context": {
"$query": {
"$range": {
"start_date": {
"$gte": "2014-01-10",
"$lte": "2014-03-10"
}
}
},
"$filter": {
"$limit": 100
},
"$projection": {
"$fields": {
"#id": 1,
"start_date": 1,
"state": 1
}
}
},
"$results": [
{
"SampleWorkflow": {
"id": "SampleWorkflow",
"comment": "Sample Workflow V1",
"steps": [
{
"id": null,
"workerGroupId": "DefaultWorker",
"stepName": "STP_PREPARE_CHECK",
"behavior": "BLOCKING",
"distribution": {
"kind": "REF",
"element": ""
},
"actions": [
{
"action": {
"actionKey": "PREPARE_1_CHECK",
"behavior": "BLOCKING",
"in": null,
"out": null
}
},
{
"action": {
"actionKey": "PREPARE_2_CHECK",
"behavior": "BLOCKING",
"in": null,
"out": null
}
}
]
}
]
},
"DefaultCheckTraceability": {
"id": "DefaultCheckTraceability",
"comment": "Default Check logbook traceability Workflow V1",
"steps": [
{
"id": null,
"workerGroupId": "DefaultWorker",
"stepName": "STP_PREPARE_TRACEABILITY_CHECK",
"behavior": "BLOCKING",
"distribution": {
"kind": "REF",
"element": ""
},
"actions": [
{
"action": {
"actionKey": "PREPARE_TRACEABILITY_CHECK",
"behavior": "BLOCKING",
"in": null,
"out": [
{
"value": null,
"name": "traceabilityevent.file",
"uri": {
"prefix": "WORKSPACE",
"path": "TraceabilityOperationDetails/EVENT_DETAIL_DATA.json"
},
"optional": false
}
]
}
}
]
},
{
"id": null,
"workerGroupId": "DefaultWorker",
"stepName": "STP_MERKLE_TREE",
"behavior": "BLOCKING",
"distribution": {
"kind": "REF",
"element": ""
},
"actions": [
{
"action": {
"actionKey": "CHECK_MERKLE_TREE",
"behavior": "BLOCKING",
"in": [
{
"value": null,
"name": "traceabilityevent.file",
"uri": {
"prefix": "WORKSPACE",
"path": "TraceabilityOperationDetails/EVENT_DETAIL_DATA.json"
},
"optional": false
}
],
"out": null
}
}
]
},
{
"id": null,
"workerGroupId": "DefaultWorker",
"stepName": "STP_VERIFY_STAMP",
"behavior": "BLOCKING",
"distribution": {
"kind": "REF",
"element": ""
},
"actions": [
{
"action": {
"actionKey": "VERIFY_TIMESTAMP",
"behavior": "BLOCKING",
"in": [
{
"value": null,
"name": "traceabilityevent.file",
"uri": {
"prefix": "WORKSPACE",
"path": "TraceabilityOperationDetails/EVENT_DETAIL_DATA.json"
},
"optional": false
}
],
"out": null
}
}
]
}
]
}
}
]
}
HTTP status code 202
Headers
- X-Callback: (string)
UNSUPPORTED Callback uri when the operation will be done
Examples:
https://callback-host:port/uri/idcallback?status={status}&id={id}
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Audits
API d'audits (Ingest). Ce point d'entrée permet de créer une opération d'audit. Une opération d'audit est volatile, c'est à dire qu'elle disparaîtra dès qu'elle sera terminée. Sa terminaison est liée à la production du rapport et sa récupération par le service ayant effectué l'opération.
response : JSON asynchronous state / HTTP CODE 200 or 500 for KO
post /audits
response : JSON asynchronous state / HTTP CODE 200 or 500 for KO
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
- X-Callback: (string)
UNSUPPORTED Callback uri when the operation will be done
Examples:
https://callback-host:port/uri/idcallback?status={status}&id={id}
Body
Description: Contient la requête spécifique au format JSON.
Media type: application/json
Type: object
Examples:
{
auditType:"tenant",
objectId:"0"
}
HTTP status code 202
Retourne le status de ACCEPTED en cas de succès de la création de l'opération d'Audit
Headers
- X-Callback: (string)
UNSUPPORTED Callback uri when the operation will be done
Examples:
https://callback-host:port/uri/idcallback?status={status}&id={id} - X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Audit operation accepted
Media type: application/json
Examples:
{
"#id": "idAudit",
"httpCode" : 202,
"code" : "vitamcode",
"context": "audit",
"state": "Running",
"message": "The audit is in progress",
"description": "The application 'Xxxx' requested a audit operation and this operation is in progress.",
"start_date": "2014-01-10T03:06:17.396Z"
}
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 500
Retourne le status de KO en cas d'erreur de la création de l'opération d'Audit
Body
Description: Final Audit report
Media type: application/json
Type: object
Traceability
API de sécurisation des journaux. Ce point d'entrée permet de vérifier et télécharger une opération de sécurisation des journaux
Permet de télécharger un objet représentant la sécurisation des journaux d'opérations
Permet de télécharger un objet représentant la sécurisation des journaux d'opérations en fonction de l'identificant de l'opération à l'origine.
get /traceability/{idop}/datafiles
Permet de télécharger un objet représentant la sécurisation des journaux d'opérations en fonction de l'identificant de l'opération à l'origine.
URI Parameters
- idop: required (string)
Identifiant de l'opération concernée
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
HTTP status code 200
Retourne un fichier de type Datafiles
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: un fichier de type Datafiles
Media type: application/octet-stream
Type: object
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Vérification de la sécurisation des journaux
Permet de lancer un processus de vérification d'une opération de sécurisation
response : JSON asynchronous state / HTTP CODE 200 or 500 for KO La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée.
post /traceabilitychecks
response : JSON asynchronous state / HTTP CODE 200 or 500 for KO La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée.
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
- X-Callback: (string)
UNSUPPORTED Callback uri when the operation will be done
Examples:
https://callback-host:port/uri/idcallback?status={status}&id={id}
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"eventDateTime": {
"$gte": "2014-01-10", "$lte": "2016-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": {}
}
HTTP status code 202
Retourne le statut ACCEPTED en cas de succès de l'opération Traceability Check
Headers
- X-Callback: (string)
UNSUPPORTED Callback uri when the operation will be done
Examples:
https://callback-host:port/uri/idcallback?status={status}&id={id} - X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Traceability operation accepted
Media type: application/json
Examples:
{
"#id": "idTraceabilityCheck",
"httpCode" : 202,
"code" : "vitamcode",
"context": "audit",
"state": "Running",
"message": "The TraceabilityCheck is in progress",
"description": "The application 'Xxxx' requested a TraceabilityCheck operation and this operation is in progress.",
"start_date": "2014-01-10T03:06:17.396Z"
}
HTTP status code 500
Returns the final result of the Traceability operation in KO status
Body
Description: Final Traceability report
Media type: application/json
Type: object
Référentiel des rêgles de gestion
API qui permet de récupérer le fichier original des rêgles de gestion sous forme de csv
Récupére le fichier original des rêgles de gestion sous forme de csv à partir de l'id de l'opération
get /rulesreferential/{opId}
Récupére le fichier original des rêgles de gestion sous forme de csv à partir de l'id de l'opération
URI Parameters
- opId: required (string)
Identifiant de l'opération
Headers
- Accept: required (application/octet-stream)
HTTP status code 200
Returns the csv file
Body
Description: Binary object as a csv file
Media type: application/octet-stream
Type: object
HTTP status code 404
Not found, operation could not be found, or csv file attached does not exist
Body
Media type: application/json
Type: object
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Body
Media type: application/json
Type: object
Référentiel des services agents
API qui permet de récupérer le fichier original des services agents sous forme de csv
Récupére le fichier original des services agents sous forme de csv à partir de l'id de l'opération
get /agenciesreferential/{opId}
Récupére le fichier original des services agents sous forme de csv à partir de l'id de l'opération
URI Parameters
- opId: required (string)
Identifiant de l'opération
Headers
- Accept: required (application/octet-stream)
HTTP status code 200
Returns the csv file
Body
Description: Binary object as a csv file
Media type: application/octet-stream
Type: object
HTTP status code 404
Not found, operation could not be found, or csv file attached does not exist
Body
Media type: application/json
Type: object
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Body
Media type: application/json
Type: object
Ontologies
API qui définit les requêtes pour accéder au référentiel des Ontologies. La requête utilise le langage de requête (DSL) de Vitam en entrée et retourne une liste d'ontologies selon le DSL Vitam en cas de succès.
Requête qui retourne des résultats contenant des Agencies. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste d'Ontologies selon le DSL Vitam en cas de succès.
Requête qui retourne des résultats contenant des Ontologies si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe un nouveau Référentiel d'Ontologies.
get /ontologies
Requête qui retourne des résultats contenant des Agencies. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste d'Ontologies selon le DSL Vitam en cas de succès.
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
HTTP status code 200
Renvoie la liste des résultats de type Ontologies correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Ontologies
Media type: application/json
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
post /ontologies
Requête qui retourne des résultats contenant des Ontologies si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe un nouveau Référentiel d'Ontologies.
Headers
- X-Http-Method-Override: (GET)
- X-Filename: (string)
Name of the file uploaded
Examples:
Rules_v5.csv
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient la requête DSL simple au format JSON.
Media type: application/json
Examples:
{
"$query":
{ "$range": {
"start_date": {
"$gte": "2014-01-10", "$lte": "2014-03-10"
}
}
},
"$filter": { "$limit": 100, "$offset": 10 },
"$projection": { "$fields": { "#id": 1, "start_date": 1, "state": 1 } }
}
Description: Contient le fichier source Ontologies au format XML (Formats from PRONOM registry)
Media type: application/xml
Type: object
Description: Contient le fichier source Ontologies au format CSV (Rules)
Media type: application/csv
Type: object
Description: Contient le fichier source Ontologies au format InputStream (for all)
Media type: application/octet-stream
Type: object
HTTP status code 200
Renvoie la liste des résultats de type Ontologies correspondant à la requête DSL
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: Réponse DSL multiple pour Access contenant les Ontologies
Media type: application/json
HTTP status code 201
Réponse si le versement ou la vérification de Ontologies est OK
HTTP status code 206
Partial Content, pagination involved
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
API qui définit les requêtes pour accéder à une ontologie dans le référentiel des Ontologies.
Retourne une liste d'Ontologies contenant 1 seul résultat en cas de succès.
Retourne une liste d'Ontologies contenant 1 seul résultat en cas de succès. La requête utilise POST avec X-Http-Method-Override: GET.
Requête qui modifie une Ontologie. La requête utilise le langage de requête DSL de type modification unitaire (UPDATE BY ID) de Vitam en entrée et retourne le statut de la mise à jour en résultat selon le DSL Vitam en cas de succès.
get /ontologies/{ido}
Retourne une liste d'Ontologies contenant 1 seul résultat en cas de succès.
URI Parameters
- ido: required (string)
Identifiant de l'ontologie
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
HTTP status code 200
Retourne un élément de type Ontologies
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: un élément de type Ontologies
Media type: application/json
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
post /ontologies/{ido}
Retourne une liste d'Ontologies contenant 1 seul résultat en cas de succès. La requête utilise POST avec X-Http-Method-Override: GET.
URI Parameters
- ido: required (string)
Identifiant de l'ontologie
Headers
- X-Http-Method-Override: required (GET)
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
HTTP status code 200
Retourne un élément de type Ontologies
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Body
Description: un élément de type Ontologies
Media type: application/json
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
put /ontologies/{ido}
Requête qui modifie une Ontologie. La requête utilise le langage de requête DSL de type modification unitaire (UPDATE BY ID) de Vitam en entrée et retourne le statut de la mise à jour en résultat selon le DSL Vitam en cas de succès.
URI Parameters
- ido: required (string)
Identifiant de l'ontologie
Headers
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0 - X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Examples:
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
Body
Description: Contient le fichier source Ontologies au format XML (Formats from PRONOM registry)
Media type: application/xml
Type: object
Description: Contient le fichier source Ontologies au format CSV (Rules)
Media type: application/csv
Type: object
Description: Contient le fichier source Ontologies au format Json (ingestcontracts, accesscontracts, contexts, profiles)
Media type: application/json
Type: object
Description: Contient le fichier source Ontologies au format InputStream (for all)
Media type: application/octet-stream
Type: object
HTTP status code 200
OK, operation in success
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 201
Réponse si le versement ou la vérification de Ontologies est OK
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 409
Conflict, operation requested is in conflict with existing data
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 412
Precondition Failed, some predicates are incorrect, therefore the operation is not possible
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
Endpoints
API qui liste les endpoints de la ressource /admin-external/{version}.
Request that will return list of endpoints
options /
Request that will return list of endpoints
HTTP status code 200
OK, operation in success
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 503
Service Unavailable, the requested service is unavailable
/status
get /status
HTTP status code 204
No Content, Used to test existence or for Status
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 401
Unauthorized (restricted operation), authentication in error
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 404
Not Found, requested resource does not exist
Headers
- X-Request-Id: required (string)
Unique Request Identifier
Examples:
AbDUh67jj
- FullApiVersion: (string)
Complete Version of the API.
Examples:
V1.25
- X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
SESSION-ID-00001
- X-Tenant-Id: required (number)
Unique Tenant Identifier
Examples:
0
HTTP status code 503
Service Unavailable, the requested service is unavailable