1. Vue générale
This API is used by the Ingest UI to send archives to external Vitam UI layers and than to Vitam. This API should be used by the Ingest UI only.
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
-
ingest : Ingest Controller
1.6. Produit
-
application/json
2. Ressources
2.1. Ingest
Ingest Controller
2.1.1. Get entities paginated
GET /ingest-api/ingest
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Query |
criteria |
criteria |
string |
Query |
direction |
direction |
enum (ASC, DESC) |
Query |
orderBy |
orderBy |
string |
Query |
page |
page |
string |
Query |
size |
size |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Exemple de requête HTTP
Requête path
/ingest-api/ingest
Requête query
{
"criteria" : "string",
"direction" : "string",
"orderBy" : "string",
"page" : "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.1.2. download ODT Report for an ingest operation
GET /ingest-api/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
/ingest-api/ingest/odtreport/string
Exemple de réponse HTTP
Réponse 200
"string"
2.1.3. Upload an SIP
POST /ingest-api/ingest/upload
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Action |
X-Action |
string |
Header |
X-Chunk-Offset |
X-Chunk-Offset |
string |
Header |
X-Context-Id |
X-Context-Id |
string |
Header |
X-Request-Id |
X-Request-Id |
string |
Header |
X-Size-Total |
X-Size-Total |
string |
Header |
X-Tenant-Id |
X-Tenant-Id |
string |
Body |
uploadedFile |
uploadedFile |
string (binary) |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
Consomme
-
application/octet-stream
-
multipart/form-data
Exemple de requête HTTP
Requête path
/ingest-api/ingest/upload
Requête header
"string"
Requête body
{ }
2.1.4. Get one ingest operation details
GET /ingest-api/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
/ingest-api/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. 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.2. 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.3. PaginatedValuesDto«LogbookOperationDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< LogbookOperationDto > array |