1. Vue générale

This API is used to manage Ingest operations

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 an SIP

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

2.1.2. error

GET /error
Réponses
Code HTTP Description Schéma

200

OK

< string, object > map

2.1.3. error

PUT /error
Réponses
Code HTTP Description Schéma

200

OK

< string, object > map

Consomme
  • application/json

2.1.4. error

DELETE /error
Réponses
Code HTTP Description Schéma

200

OK

< string, object > map

2.1.5. error

PATCH /error
Réponses
Code HTTP Description Schéma

200

OK

< string, object > map

Consomme
  • application/json

2.1.6. error

HEAD /error
Réponses
Code HTTP Description Schéma

200

OK

< string, object > map

Consomme
  • application/json

2.1.7. error

OPTIONS /error
Réponses
Code HTTP Description Schéma

200

OK

< string, object > map

Consomme
  • application/json

2.2. Ingest

Ingest an SIP

2.2.1. getAllPaginated

GET /iam/v1/ingest
Paramètres
Type Nom Description Schéma

Query

criteria
optionnel

criteria

string

Query

direction
optionnel

direction

enum (ASC, DESC)

Query

orderBy
optionnel

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
/iam/v1/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.2.2. generateODTReport

GET /iam/v1/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
/iam/v1/ingest/odtreport/string

2.2.3. upload

POST /iam/v1/ingest/upload
Paramètres
Type Nom Description Schéma

Header

X-Action
requis

X-Action

string

Header

X-Context-Id
requis

X-Context-Id

string

Body

uploadedFile
requis

uploadedFile

string (binary)

Réponses
Code HTTP Description Schéma

200

OK

RequestResponseOK

Consomme
  • multipart/form-data

Exemple de réponse HTTP
Réponse 200
{
  "$context" : { },
  "$facetResults" : [ {
    "buckets" : [ {
      "count" : 0,
      "value" : "string"
    } ],
    "name" : "string"
  } ],
  "$hits" : {
    "limit" : 0,
    "offset" : 0,
    "scrollId" : "string",
    "size" : 0,
    "total" : 0
  },
  "$results" : [ "object" ],
  "httpCode" : 0
}

2.2.4. getAllPaginated

GET /iam/v1/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
/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
optionnel

Exemple : 0

integer (int64)

offset
optionnel

Exemple : 0

integer (int64)

scrollId
optionnel

Exemple : "string"

string

size
optionnel

Exemple : 0

integer (int64)

total
optionnel

Exemple : 0

integer (int64)

3.2. FacetBucket

Nom Description Schéma

count
optionnel

Exemple : 0

integer (int64)

value
optionnel

Exemple : "string"

string

3.3. FacetResult

Nom Description Schéma

buckets
optionnel

Exemple : [ "FacetBucket" ]

< FacetBucket > array

name
optionnel

Exemple : "string"

string

3.4. JsonNode

Type : object

3.5. 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.6. 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.7. ModelAndView

Nom Description Schéma

empty
optionnel

Exemple : true

boolean

model
optionnel

Exemple : "object"

object

modelMap
optionnel

Exemple : {
"string" : "object"
}

< string, object > map

reference
optionnel

Exemple : true

boolean

status
optionnel

Exemple : "string"

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
optionnel

Exemple : "View"

View

viewName
optionnel

Exemple : "string"

string

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

3.9. RequestResponseOK

Nom Description Schéma

$context
optionnel

Exemple : "JsonNode"

JsonNode

$facetResults
optionnel

Exemple : [ "FacetResult" ]

< FacetResult > array

$hits
optionnel

Exemple : "DatabaseCursor"

DatabaseCursor

$results
optionnel

Exemple : [ "object" ]

< object > array

httpCode
optionnel

Exemple : 0

integer (int32)

3.10. View

Nom Description Schéma

contentType
optionnel

Exemple : "string"

string