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.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
requis

criteria

string

Query

direction
requis

direction

enum (ASC, DESC)

Query

orderBy
requis

orderBy

string

Query

page
requis

page

string

Query

size
requis

size

string

Réponses
Code HTTP Description Schéma

200

OK

PaginatedValuesDto«LogbookOperationDto»

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
requis

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

2.1.3. Upload an SIP

POST /ingest-api/ingest/upload
Paramètres
Type Nom Description Schéma

Header

X-Action
requis

X-Action

string

Header

X-Chunk-Offset
requis

X-Chunk-Offset

string

Header

X-Context-Id
requis

X-Context-Id

string

Header

X-Request-Id
requis

X-Request-Id

string

Header

X-Size-Total
requis

X-Size-Total

string

Header

X-Tenant-Id
requis

X-Tenant-Id

string

Body

uploadedFile
requis

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"

2.1.4. Get one ingest operation details

GET /ingest-api/ingest/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

LogbookOperationDto

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
optionnel

Exemple : "string"

string

agIdApp
optionnel

Exemple : "string"

string

agIdExt
optionnel

Exemple : "string"

string

evDateTime
optionnel

Exemple : "string"

string

evDetData
optionnel

Exemple : "string"

string

evId
optionnel

Exemple : "string"

string

evIdAppSession
optionnel

Exemple : "string"

string

evIdReq
optionnel

Exemple : "string"

string

evParentId
optionnel

Exemple : "string"

string

evType
optionnel

Exemple : "string"

string

evTypeProc
optionnel

Exemple : "string"

string

id
optionnel

Exemple : "string"

string

obId
optionnel

Exemple : "string"

string

obIdReq
optionnel

Exemple : "string"

string

outDetail
optionnel

Exemple : "string"

string

outMessg
optionnel

Exemple : "string"

string

outcome
optionnel

Exemple : "string"

string

rightsStatementIdentifier
optionnel

Exemple : "string"

string

3.2. LogbookOperationDto

Nom Description Schéma

agId
optionnel

Exemple : "string"

string

agIdApp
optionnel

Exemple : "string"

string

agIdExt
optionnel

Exemple : "string"

string

evDateTime
optionnel

Exemple : "string"

string

evDetData
optionnel

Exemple : "string"

string

evId
optionnel

Exemple : "string"

string

evIdAppSession
optionnel

Exemple : "string"

string

evIdReq
optionnel

Exemple : "string"

string

evParentId
optionnel

Exemple : "string"

string

evType
optionnel

Exemple : "string"

string

evTypeProc
optionnel

Exemple : "string"

string

events
optionnel

Exemple : [ "LogbookEventDto" ]

< LogbookEventDto > array

id
optionnel

Exemple : "string"

string

obId
optionnel

Exemple : "string"

string

obIdIn
optionnel

Exemple : "string"

string

obIdReq
optionnel

Exemple : "string"

string

outDetail
optionnel

Exemple : "string"

string

outMessg
optionnel

Exemple : "string"

string

outcome
optionnel

Exemple : "string"

string

rightsStatementIdentifier
optionnel

Exemple : "string"

string

3.3. PaginatedValuesDto«LogbookOperationDto»

Nom Description Schéma

hasMore
optionnel

Exemple : true

boolean

pageNum
optionnel

Exemple : 0

integer (int32)

pageSize
optionnel

Exemple : 0

integer (int32)

values
optionnel

Exemple : [ "LogbookOperationDto" ]

< LogbookOperationDto > array