1. Vue générale
API externe de gestion des ingests
1.1. Information de version
Version : v1
1.2. Information de contact
Contact : Direction de la diffusion et des partenariats
Email de contact : contact@programmevitam.fr
1.3. Information de licence
Licence : License to be defined …
Licence URL : URL not defined.
Conditions de service : Terms of service
1.4. Schéma d’URI
Serveur : localhost
Chemin de base : /
1.5. Tags
-
basic-error-controller : Basic Error Controller
-
ingest : Ingest External Controller $ Mockito Mock $1177643453
1.6. Produit
-
application/json
2. Ressources
2.1. Basic-error-controller
Basic Error Controller
2.1.1. error
POST /error
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
< string, object > map |
Consomme
-
application/json
Exemple de réponse HTTP
Réponse 200
"object"
2.1.2. error
GET /error
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
< string, object > map |
Exemple de réponse HTTP
Réponse 200
"object"
2.1.3. error
PUT /error
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
< string, object > map |
Consomme
-
application/json
Exemple de réponse HTTP
Réponse 200
"object"
2.1.4. error
DELETE /error
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
< string, object > map |
Exemple de réponse HTTP
Réponse 200
"object"
2.1.5. error
PATCH /error
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
< string, object > map |
Consomme
-
application/json
Exemple de réponse HTTP
Réponse 200
"object"
2.1.6. error
HEAD /error
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
< string, object > map |
Consomme
-
application/json
Exemple de réponse HTTP
Réponse 200
"object"
2.1.7. error
OPTIONS /error
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
< string, object > map |
Consomme
-
application/json
Exemple de réponse HTTP
Réponse 200
"object"
2.2. Ingest
Ingest External Controller $ Mockito Mock $1177643453
2.2.1. getAllPaginated
GET /iam/v1/ingest
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Query |
page |
string |
|
Query |
param0 |
param0 |
integer (int32) |
Query |
param1 |
param1 |
integer (int32) |
Query |
param2 |
param2 |
string |
Query |
param3 |
param3 |
string |
Query |
param4 |
param4 |
enum (ASC, DESC) |
Query |
size |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Exemple de requête HTTP
Requête path
/iam/v1/ingest
Requête query
{
"page" : "string",
"param0" : 0,
"param1" : 0,
"param2" : "string",
"param3" : "string",
"param4" : "string",
"size" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
"hasMore" : true,
"pageNum" : 0,
"pageSize" : 0,
"values" : [ {
"agId" : "string",
"agIdApp" : "string",
"agIdExt" : "string",
"evDateTime" : "string",
"evDetData" : "string",
"evId" : "string",
"evIdAppSession" : "string",
"evIdReq" : "string",
"evParentId" : "string",
"evType" : "string",
"evTypeProc" : "string",
"events" : [ {
"agId" : "string",
"agIdApp" : "string",
"agIdExt" : "string",
"evDateTime" : "string",
"evDetData" : "string",
"evId" : "string",
"evIdAppSession" : "string",
"evIdReq" : "string",
"evParentId" : "string",
"evType" : "string",
"evTypeProc" : "string",
"id" : "string",
"obId" : "string",
"obIdReq" : "string",
"outDetail" : "string",
"outMessg" : "string",
"outcome" : "string",
"rightsStatementIdentifier" : "string"
} ],
"id" : "string",
"obId" : "string",
"obIdIn" : "string",
"obIdReq" : "string",
"outDetail" : "string",
"outMessg" : "string",
"outcome" : "string",
"rightsStatementIdentifier" : "string"
} ]
}
2.2.2. generateODTReport
GET /iam/v1/ingest/odtreport/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Path |
id |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
string (byte) |
Exemple de requête HTTP
Requête path
/iam/v1/ingest/odtreport/string
Exemple de réponse HTTP
Réponse 200
"string"
2.2.3. upload
POST /iam/v1/ingest/upload
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Action |
X-Action |
string |
Header |
X-Context-Id |
X-Context-Id |
string |
Body |
uploadedFile |
uploadedFile |
string (binary) |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Consomme
-
multipart/form-data
2.2.4. getOne
GET /iam/v1/ingest/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Path |
id |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Exemple de requête HTTP
Requête path
/iam/v1/ingest/string
Exemple de réponse HTTP
Réponse 200
{
"agId" : "string",
"agIdApp" : "string",
"agIdExt" : "string",
"evDateTime" : "string",
"evDetData" : "string",
"evId" : "string",
"evIdAppSession" : "string",
"evIdReq" : "string",
"evParentId" : "string",
"evType" : "string",
"evTypeProc" : "string",
"events" : [ {
"agId" : "string",
"agIdApp" : "string",
"agIdExt" : "string",
"evDateTime" : "string",
"evDetData" : "string",
"evId" : "string",
"evIdAppSession" : "string",
"evIdReq" : "string",
"evParentId" : "string",
"evType" : "string",
"evTypeProc" : "string",
"id" : "string",
"obId" : "string",
"obIdReq" : "string",
"outDetail" : "string",
"outMessg" : "string",
"outcome" : "string",
"rightsStatementIdentifier" : "string"
} ],
"id" : "string",
"obId" : "string",
"obIdIn" : "string",
"obIdReq" : "string",
"outDetail" : "string",
"outMessg" : "string",
"outcome" : "string",
"rightsStatementIdentifier" : "string"
}
3. Définitions
3.1. DatabaseCursor
Nom | Description | Schéma |
---|---|---|
limit |
Exemple : |
integer (int64) |
offset |
Exemple : |
integer (int64) |
scrollId |
Exemple : |
string |
size |
Exemple : |
integer (int64) |
total |
Exemple : |
integer (int64) |
3.2. FacetBucket
Nom | Description | Schéma |
---|---|---|
count |
Exemple : |
integer (int64) |
value |
Exemple : |
string |
3.3. FacetResult
Nom | Description | Schéma |
---|---|---|
buckets |
Exemple : |
< FacetBucket > array |
name |
Exemple : |
string |
3.4. JsonNode
Type : object
3.5. LogbookEventDto
Nom | Description | Schéma |
---|---|---|
agId |
Exemple : |
string |
agIdApp |
Exemple : |
string |
agIdExt |
Exemple : |
string |
evDateTime |
Exemple : |
string |
evDetData |
Exemple : |
string |
evId |
Exemple : |
string |
evIdAppSession |
Exemple : |
string |
evIdReq |
Exemple : |
string |
evParentId |
Exemple : |
string |
evType |
Exemple : |
string |
evTypeProc |
Exemple : |
string |
id |
Exemple : |
string |
obId |
Exemple : |
string |
obIdReq |
Exemple : |
string |
outDetail |
Exemple : |
string |
outMessg |
Exemple : |
string |
outcome |
Exemple : |
string |
rightsStatementIdentifier |
Exemple : |
string |
3.6. LogbookOperationDto
Nom | Description | Schéma |
---|---|---|
agId |
Exemple : |
string |
agIdApp |
Exemple : |
string |
agIdExt |
Exemple : |
string |
evDateTime |
Exemple : |
string |
evDetData |
Exemple : |
string |
evId |
Exemple : |
string |
evIdAppSession |
Exemple : |
string |
evIdReq |
Exemple : |
string |
evParentId |
Exemple : |
string |
evType |
Exemple : |
string |
evTypeProc |
Exemple : |
string |
events |
Exemple : |
< LogbookEventDto > array |
id |
Exemple : |
string |
obId |
Exemple : |
string |
obIdIn |
Exemple : |
string |
obIdReq |
Exemple : |
string |
outDetail |
Exemple : |
string |
outMessg |
Exemple : |
string |
outcome |
Exemple : |
string |
rightsStatementIdentifier |
Exemple : |
string |
3.7. ModelAndView
Nom | Description | Schéma |
---|---|---|
empty |
Exemple : |
boolean |
model |
Exemple : |
object |
modelMap |
Exemple : |
< string, object > map |
reference |
Exemple : |
boolean |
status |
Exemple : |
enum (ACCEPTED, ALREADY_REPORTED, BAD_GATEWAY, BAD_REQUEST, BANDWIDTH_LIMIT_EXCEEDED, CHECKPOINT, CONFLICT, CONTINUE, CREATED, DESTINATION_LOCKED, EXPECTATION_FAILED, FAILED_DEPENDENCY, FORBIDDEN, FOUND, GATEWAY_TIMEOUT, GONE, HTTP_VERSION_NOT_SUPPORTED, IM_USED, INSUFFICIENT_SPACE_ON_RESOURCE, INSUFFICIENT_STORAGE, INTERNAL_SERVER_ERROR, I_AM_A_TEAPOT, LENGTH_REQUIRED, LOCKED, LOOP_DETECTED, METHOD_FAILURE, METHOD_NOT_ALLOWED, MOVED_PERMANENTLY, MOVED_TEMPORARILY, MULTIPLE_CHOICES, MULTI_STATUS, NETWORK_AUTHENTICATION_REQUIRED, NON_AUTHORITATIVE_INFORMATION, NOT_ACCEPTABLE, NOT_EXTENDED, NOT_FOUND, NOT_IMPLEMENTED, NOT_MODIFIED, NO_CONTENT, OK, PARTIAL_CONTENT, PAYLOAD_TOO_LARGE, PAYMENT_REQUIRED, PERMANENT_REDIRECT, PRECONDITION_FAILED, PRECONDITION_REQUIRED, PROCESSING, PROXY_AUTHENTICATION_REQUIRED, REQUESTED_RANGE_NOT_SATISFIABLE, REQUEST_ENTITY_TOO_LARGE, REQUEST_HEADER_FIELDS_TOO_LARGE, REQUEST_TIMEOUT, REQUEST_URI_TOO_LONG, RESET_CONTENT, SEE_OTHER, SERVICE_UNAVAILABLE, SWITCHING_PROTOCOLS, TEMPORARY_REDIRECT, TOO_EARLY, TOO_MANY_REQUESTS, UNAUTHORIZED, UNAVAILABLE_FOR_LEGAL_REASONS, UNPROCESSABLE_ENTITY, UNSUPPORTED_MEDIA_TYPE, UPGRADE_REQUIRED, URI_TOO_LONG, USE_PROXY, VARIANT_ALSO_NEGOTIATES) |
view |
Exemple : |
|
viewName |
Exemple : |
string |
3.8. Mono«RequestResponseOK»
Type : object
3.9. PaginatedValuesDto«LogbookOperationDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< LogbookOperationDto > array |
3.10. RequestResponseOK
Nom | Description | Schéma |
---|---|---|
$context |
Exemple : |
|
$facetResults |
Exemple : |
< FacetResult > array |
$hits |
Exemple : |
|
$results |
Exemple : |
< object > array |
httpCode |
Exemple : |
integer (int32) |
3.11. View
Nom | Description | Schéma |
---|---|---|
contentType |
Exemple : |
string |