1. Vue générale

This API is used to manage referential

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

  • access-contract-internal-controller : Access Contract Internal Controller

  • accession-register-internal-controller : Accession Register Internal Controller

  • agency-internal-controller : Agency Internal Controller

  • context-internal-controller : Context Internal Controller

  • file-format-internal-controller : File Format Internal Controller

  • ingest-contract-internal-controller : Ingest Contract Internal Controller

  • management-contract-internal-controller : Management Contract Internal Controller

  • ontology-internal-controller : Ontology Internal Controller

  • operation-internal-controller : Operation Internal Controller

  • profile-internal-controller : Profile Internal Controller

  • rule-internal-controller : Rule Internal Controller

  • security-profile-internal-controller : Security Profile Internal Controller

  • status : Status check and autotest

  • unit-internal-controller : Unit Internal Controller

1.6. Produit

  • application/json

2. Ressources

2.1. Access-contract-internal-controller

Access Contract Internal Controller

2.1.1. create

POST /referential/v1/accesscontract
Paramètres
Type Nom Description Schéma

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Body

accessContractDto
requis

accessContractDto

AccessContractDto

Réponses
Code HTTP Description Schéma

200

OK

AccessContractDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/accesscontract
Requête body
{
  "accessLog" : "string",
  "activationDate" : "string",
  "creationDate" : "string",
  "dataObjectVersion" : [ "string" ],
  "deactivationDate" : "string",
  "description" : "string",
  "everyDataObjectVersion" : true,
  "everyOriginatingAgency" : true,
  "excludedRootUnits" : [ "string" ],
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "name" : "string",
  "originatingAgencies" : [ "string" ],
  "rootUnits" : [ "string" ],
  "ruleCategoryToFilter" : [ "string" ],
  "status" : "string",
  "tenant" : 0,
  "version" : 0,
  "writingPermission" : true,
  "writingRestrictedDesc" : true
}
Exemple de réponse HTTP
Réponse 200
{
  "accessLog" : "string",
  "activationDate" : "string",
  "creationDate" : "string",
  "dataObjectVersion" : [ "string" ],
  "deactivationDate" : "string",
  "description" : "string",
  "everyDataObjectVersion" : true,
  "everyOriginatingAgency" : true,
  "excludedRootUnits" : [ "string" ],
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "name" : "string",
  "originatingAgencies" : [ "string" ],
  "rootUnits" : [ "string" ],
  "ruleCategoryToFilter" : [ "string" ],
  "status" : "string",
  "tenant" : 0,
  "version" : 0,
  "writingPermission" : true,
  "writingRestrictedDesc" : true
}

2.1.2. getAll

GET /referential/v1/accesscontract
Paramètres
Type Nom Description Schéma

Query

criteria
requis

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

< AccessContractDto > array

Exemple de requête HTTP
Requête path
/referential/v1/accesscontract
Requête query
{
  "criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
  "accessLog" : "string",
  "activationDate" : "string",
  "creationDate" : "string",
  "dataObjectVersion" : [ "string" ],
  "deactivationDate" : "string",
  "description" : "string",
  "everyDataObjectVersion" : true,
  "everyOriginatingAgency" : true,
  "excludedRootUnits" : [ "string" ],
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "name" : "string",
  "originatingAgencies" : [ "string" ],
  "rootUnits" : [ "string" ],
  "ruleCategoryToFilter" : [ "string" ],
  "status" : "string",
  "tenant" : 0,
  "version" : 0,
  "writingPermission" : true,
  "writingRestrictedDesc" : true
} ]

2.1.3. checkExist

POST /referential/v1/accesscontract/check
Paramètres
Type Nom Description Schéma

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Body

accessContractDto
requis

accessContractDto

AccessContractDto

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/accesscontract/check
Requête body
{
  "accessLog" : "string",
  "activationDate" : "string",
  "creationDate" : "string",
  "dataObjectVersion" : [ "string" ],
  "deactivationDate" : "string",
  "description" : "string",
  "everyDataObjectVersion" : true,
  "everyOriginatingAgency" : true,
  "excludedRootUnits" : [ "string" ],
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "name" : "string",
  "originatingAgencies" : [ "string" ],
  "rootUnits" : [ "string" ],
  "ruleCategoryToFilter" : [ "string" ],
  "status" : "string",
  "tenant" : 0,
  "version" : 0,
  "writingPermission" : true,
  "writingRestrictedDesc" : true
}

2.1.4. getOne

GET /referential/v1/accesscontract/{identifier}
Paramètres
Type Nom Description Schéma

Path

identifier
requis

identifier

string

Réponses
Code HTTP Description Schéma

200

OK

AccessContractDto

Exemple de requête HTTP
Requête path
/referential/v1/accesscontract/string
Exemple de réponse HTTP
Réponse 200
{
  "accessLog" : "string",
  "activationDate" : "string",
  "creationDate" : "string",
  "dataObjectVersion" : [ "string" ],
  "deactivationDate" : "string",
  "description" : "string",
  "everyDataObjectVersion" : true,
  "everyOriginatingAgency" : true,
  "excludedRootUnits" : [ "string" ],
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "name" : "string",
  "originatingAgencies" : [ "string" ],
  "rootUnits" : [ "string" ],
  "ruleCategoryToFilter" : [ "string" ],
  "status" : "string",
  "tenant" : 0,
  "version" : 0,
  "writingPermission" : true,
  "writingRestrictedDesc" : true
}

2.1.5. patch

PATCH /referential/v1/accesscontract/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Body

partialDto
requis

partialDto

object

Réponses
Code HTTP Description Schéma

200

OK

AccessContractDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/accesscontract/string
Exemple de réponse HTTP
Réponse 200
{
  "accessLog" : "string",
  "activationDate" : "string",
  "creationDate" : "string",
  "dataObjectVersion" : [ "string" ],
  "deactivationDate" : "string",
  "description" : "string",
  "everyDataObjectVersion" : true,
  "everyOriginatingAgency" : true,
  "excludedRootUnits" : [ "string" ],
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "name" : "string",
  "originatingAgencies" : [ "string" ],
  "rootUnits" : [ "string" ],
  "ruleCategoryToFilter" : [ "string" ],
  "status" : "string",
  "tenant" : 0,
  "version" : 0,
  "writingPermission" : true,
  "writingRestrictedDesc" : true
}

2.1.6. findHistoryById

GET /referential/v1/accesscontract/{id}/history
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

Exemple de requête HTTP
Requête path
/referential/v1/accesscontract/string/history

2.2. Accession-register-internal-controller

Accession Register Internal Controller

2.2.1. getAll

GET /referential/v1/accession-register
Paramètres
Type Nom Description Schéma

Header

X-Access-Contract-Id
requis

X-Access-Contract-Id

string

Query

criteria
requis

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

< AccessionRegisterSummaryDto > array

Exemple de requête HTTP
Requête path
/referential/v1/accession-register
Requête header
"string"
Requête query
{
  "criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
  "creationDate" : "string",
  "id" : "string",
  "objectSize" : {
    "deleted" : 0,
    "ingested" : 0,
    "remained" : 0
  },
  "originatingAgency" : "string",
  "tenant" : 0,
  "totalObjects" : {
    "deleted" : 0,
    "ingested" : 0,
    "remained" : 0
  },
  "totalObjectsGroups" : {
    "deleted" : 0,
    "ingested" : 0,
    "remained" : 0
  },
  "totalUnits" : {
    "deleted" : 0,
    "ingested" : 0,
    "remained" : 0
  },
  "version" : 0
} ]

2.3. Agency-internal-controller

Agency Internal Controller

2.3.1. create

POST /referential/v1/agency
Paramètres
Type Nom Description Schéma

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Body

accessContractDto
requis

accessContractDto

AgencyDto

Réponses
Code HTTP Description Schéma

200

OK

AgencyDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/agency
Requête body
{
  "Identifier" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "Identifier" : "string"
}

2.3.2. getAllPaginated

GET /referential/v1/agency
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«AgencyDto»

Exemple de requête HTTP
Requête path
/referential/v1/agency
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" : [ {
    "Identifier" : "string"
  } ]
}

2.3.3. checkExist

POST /referential/v1/agency/check
Paramètres
Type Nom Description Schéma

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Body

accessContractDto
requis

accessContractDto

AgencyDto

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/agency/check
Requête body
{
  "Identifier" : "string"
}

2.3.4. export

GET /referential/v1/agency/export
Réponses
Code HTTP Description Schéma

200

OK

Resource

Exemple de requête HTTP
Requête path
/referential/v1/agency/export
Exemple de réponse HTTP
Réponse 200
{
  "description" : "string",
  "file" : "file",
  "filename" : "string",
  "inputStream" : { },
  "open" : true,
  "readable" : true,
  "uri" : "string",
  "url" : "string"
}

2.3.5. importAgencies

POST /referential/v1/agency/import
Paramètres
Type Nom Description Schéma

Query

fileName
requis

fileName

string

Body

file
requis

file

string (binary)

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

Consomme
  • multipart/form-data

Exemple de requête HTTP
Requête path
/referential/v1/agency/import
Requête query
{
  "fileName" : "string"
}

2.3.6. getOne

GET /referential/v1/agency/{identifier}
Paramètres
Type Nom Description Schéma

Path

identifier
requis

identifier

string

Réponses
Code HTTP Description Schéma

200

OK

AgencyDto

Exemple de requête HTTP
Requête path
/referential/v1/agency/string
Exemple de réponse HTTP
Réponse 200
{
  "Identifier" : "string"
}

2.3.7. delete

DELETE /referential/v1/agency/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

boolean

Exemple de requête HTTP
Requête path
/referential/v1/agency/string

2.3.8. patch

PATCH /referential/v1/agency/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Body

partialDto
requis

partialDto

object

Réponses
Code HTTP Description Schéma

200

OK

AgencyDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/agency/string
Exemple de réponse HTTP
Réponse 200
{
  "Identifier" : "string"
}

2.3.9. findHistoryById

GET /referential/v1/agency/{id}/history
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

Exemple de requête HTTP
Requête path
/referential/v1/agency/string/history

2.4. Context-internal-controller

Context Internal Controller

2.4.1. create

POST /referential/v1/context
Paramètres
Type Nom Description Schéma

Body

contextDto
requis

contextDto

ContextDto

Réponses
Code HTTP Description Schéma

200

OK

ContextDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/context
Requête body
{
  "activationDate" : "string",
  "creationDate" : "string",
  "deactivationDate" : "string",
  "enableControl" : true,
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "name" : "string",
  "permissions" : [ {
    "accessContracts" : [ "string" ],
    "ingestContracts" : [ "string" ],
    "tenant" : "string"
  } ],
  "securityProfile" : "string",
  "status" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "activationDate" : "string",
  "creationDate" : "string",
  "deactivationDate" : "string",
  "enableControl" : true,
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "name" : "string",
  "permissions" : [ {
    "accessContracts" : [ "string" ],
    "ingestContracts" : [ "string" ],
    "tenant" : "string"
  } ],
  "securityProfile" : "string",
  "status" : "string"
}

2.4.2. getAllPaginated

GET /referential/v1/context
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«ContextDto»

Exemple de requête HTTP
Requête path
/referential/v1/context
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" : [ {
    "activationDate" : "string",
    "creationDate" : "string",
    "deactivationDate" : "string",
    "enableControl" : true,
    "id" : "string",
    "identifier" : "string",
    "lastUpdate" : "string",
    "name" : "string",
    "permissions" : [ {
      "accessContracts" : [ "string" ],
      "ingestContracts" : [ "string" ],
      "tenant" : "string"
    } ],
    "securityProfile" : "string",
    "status" : "string"
  } ]
}

2.4.3. checkExist

POST /referential/v1/context/check
Paramètres
Type Nom Description Schéma

Body

contextDto
requis

contextDto

ContextDto

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/context/check
Requête body
{
  "activationDate" : "string",
  "creationDate" : "string",
  "deactivationDate" : "string",
  "enableControl" : true,
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "name" : "string",
  "permissions" : [ {
    "accessContracts" : [ "string" ],
    "ingestContracts" : [ "string" ],
    "tenant" : "string"
  } ],
  "securityProfile" : "string",
  "status" : "string"
}

2.4.4. getOne

GET /referential/v1/context/{identifier}
Paramètres
Type Nom Description Schéma

Path

identifier
requis

identifier

string

Réponses
Code HTTP Description Schéma

200

OK

ContextDto

Exemple de requête HTTP
Requête path
/referential/v1/context/string
Exemple de réponse HTTP
Réponse 200
{
  "activationDate" : "string",
  "creationDate" : "string",
  "deactivationDate" : "string",
  "enableControl" : true,
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "name" : "string",
  "permissions" : [ {
    "accessContracts" : [ "string" ],
    "ingestContracts" : [ "string" ],
    "tenant" : "string"
  } ],
  "securityProfile" : "string",
  "status" : "string"
}

2.4.5. patch

PATCH /referential/v1/context/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Body

partialDto
requis

partialDto

ContextDto

Réponses
Code HTTP Description Schéma

200

OK

ContextDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/context/string
Requête body
{
  "activationDate" : "string",
  "creationDate" : "string",
  "deactivationDate" : "string",
  "enableControl" : true,
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "name" : "string",
  "permissions" : [ {
    "accessContracts" : [ "string" ],
    "ingestContracts" : [ "string" ],
    "tenant" : "string"
  } ],
  "securityProfile" : "string",
  "status" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "activationDate" : "string",
  "creationDate" : "string",
  "deactivationDate" : "string",
  "enableControl" : true,
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "name" : "string",
  "permissions" : [ {
    "accessContracts" : [ "string" ],
    "ingestContracts" : [ "string" ],
    "tenant" : "string"
  } ],
  "securityProfile" : "string",
  "status" : "string"
}

2.4.6. findHistoryById

GET /referential/v1/context/{id}/history
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

Exemple de requête HTTP
Requête path
/referential/v1/context/string/history

2.5. File-format-internal-controller

File Format Internal Controller

2.5.1. create

POST /referential/v1/fileformats
Paramètres
Type Nom Description Schéma

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Body

fileFormat
requis

fileFormat

FileFormatDto

Réponses
Code HTTP Description Schéma

200

OK

FileFormatDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/fileformats
Requête body
{
  "alert" : true,
  "comment" : "string",
  "createdDate" : "string",
  "documentVersion" : 0,
  "extensions" : [ "string" ],
  "group" : "string",
  "hasPriorityOverFileFormatIDs" : [ "string" ],
  "id" : "string",
  "mimeType" : "string",
  "name" : "string",
  "puid" : "string",
  "version" : "string",
  "versionPronom" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "alert" : true,
  "comment" : "string",
  "createdDate" : "string",
  "documentVersion" : 0,
  "extensions" : [ "string" ],
  "group" : "string",
  "hasPriorityOverFileFormatIDs" : [ "string" ],
  "id" : "string",
  "mimeType" : "string",
  "name" : "string",
  "puid" : "string",
  "version" : "string",
  "versionPronom" : "string"
}

2.5.2. getAllPaginated

GET /referential/v1/fileformats
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«FileFormatDto»

Exemple de requête HTTP
Requête path
/referential/v1/fileformats
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" : [ {
    "alert" : true,
    "comment" : "string",
    "createdDate" : "string",
    "documentVersion" : 0,
    "extensions" : [ "string" ],
    "group" : "string",
    "hasPriorityOverFileFormatIDs" : [ "string" ],
    "id" : "string",
    "mimeType" : "string",
    "name" : "string",
    "puid" : "string",
    "version" : "string",
    "versionPronom" : "string"
  } ]
}

2.5.3. checkExist

POST /referential/v1/fileformats/check
Paramètres
Type Nom Description Schéma

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Body

fileFormat
requis

fileFormat

FileFormatDto

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/fileformats/check
Requête body
{
  "alert" : true,
  "comment" : "string",
  "createdDate" : "string",
  "documentVersion" : 0,
  "extensions" : [ "string" ],
  "group" : "string",
  "hasPriorityOverFileFormatIDs" : [ "string" ],
  "id" : "string",
  "mimeType" : "string",
  "name" : "string",
  "puid" : "string",
  "version" : "string",
  "versionPronom" : "string"
}

2.5.4. export

GET /referential/v1/fileformats/export
Réponses
Code HTTP Description Schéma

200

OK

Resource

Exemple de requête HTTP
Requête path
/referential/v1/fileformats/export
Exemple de réponse HTTP
Réponse 200
{
  "description" : "string",
  "file" : "file",
  "filename" : "string",
  "inputStream" : { },
  "open" : true,
  "readable" : true,
  "uri" : "string",
  "url" : "string"
}

2.5.5. importFileFormats

POST /referential/v1/fileformats/import
Paramètres
Type Nom Description Schéma

Query

fileName
requis

fileName

string

Body

file
requis

file

string (binary)

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

Consomme
  • multipart/form-data

Exemple de requête HTTP
Requête path
/referential/v1/fileformats/import
Requête query
{
  "fileName" : "string"
}

2.5.6. getOne

GET /referential/v1/fileformats/{identifier}
Paramètres
Type Nom Description Schéma

Path

identifier
requis

identifier

string

Réponses
Code HTTP Description Schéma

200

OK

FileFormatDto

Exemple de requête HTTP
Requête path
/referential/v1/fileformats/string
Exemple de réponse HTTP
Réponse 200
{
  "alert" : true,
  "comment" : "string",
  "createdDate" : "string",
  "documentVersion" : 0,
  "extensions" : [ "string" ],
  "group" : "string",
  "hasPriorityOverFileFormatIDs" : [ "string" ],
  "id" : "string",
  "mimeType" : "string",
  "name" : "string",
  "puid" : "string",
  "version" : "string",
  "versionPronom" : "string"
}

2.5.7. delete

DELETE /referential/v1/fileformats/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Exemple de requête HTTP
Requête path
/referential/v1/fileformats/string

2.5.8. patch

PATCH /referential/v1/fileformats/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Body

partialDto
requis

partialDto

object

Réponses
Code HTTP Description Schéma

200

OK

FileFormatDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/fileformats/string
Exemple de réponse HTTP
Réponse 200
{
  "alert" : true,
  "comment" : "string",
  "createdDate" : "string",
  "documentVersion" : 0,
  "extensions" : [ "string" ],
  "group" : "string",
  "hasPriorityOverFileFormatIDs" : [ "string" ],
  "id" : "string",
  "mimeType" : "string",
  "name" : "string",
  "puid" : "string",
  "version" : "string",
  "versionPronom" : "string"
}

2.5.9. findHistoryById

GET /referential/v1/fileformats/{id}/history
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

Exemple de requête HTTP
Requête path
/referential/v1/fileformats/string/history

2.6. Ingest-contract-internal-controller

Ingest Contract Internal Controller

2.6.1. create

POST /referential/v1/ingestcontract
Paramètres
Type Nom Description Schéma

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Body

ingestContractDto
requis

ingestContractDto

IngestContractDto

Réponses
Code HTTP Description Schéma

200

OK

IngestContractDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/ingestcontract
Requête body
{
  "activationDate" : "string",
  "archiveProfiles" : [ "string" ],
  "checkParentId" : [ "string" ],
  "checkParentLink" : "string",
  "creationDate" : "string",
  "dataObjectVersion" : [ "string" ],
  "deactivationDate" : "string",
  "description" : "string",
  "everyDataObjectVersion" : true,
  "everyFormatType" : true,
  "formatType" : [ "string" ],
  "formatUnidentifiedAuthorized" : true,
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "linkParentId" : "string",
  "managementContractId" : "string",
  "masterMandatory" : true,
  "name" : "string",
  "status" : "string",
  "tenant" : 0,
  "version" : 0
}
Exemple de réponse HTTP
Réponse 200
{
  "activationDate" : "string",
  "archiveProfiles" : [ "string" ],
  "checkParentId" : [ "string" ],
  "checkParentLink" : "string",
  "creationDate" : "string",
  "dataObjectVersion" : [ "string" ],
  "deactivationDate" : "string",
  "description" : "string",
  "everyDataObjectVersion" : true,
  "everyFormatType" : true,
  "formatType" : [ "string" ],
  "formatUnidentifiedAuthorized" : true,
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "linkParentId" : "string",
  "managementContractId" : "string",
  "masterMandatory" : true,
  "name" : "string",
  "status" : "string",
  "tenant" : 0,
  "version" : 0
}

2.6.2. getAllPaginated

GET /referential/v1/ingestcontract
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«IngestContractDto»

Exemple de requête HTTP
Requête path
/referential/v1/ingestcontract
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" : [ {
    "activationDate" : "string",
    "archiveProfiles" : [ "string" ],
    "checkParentId" : [ "string" ],
    "checkParentLink" : "string",
    "creationDate" : "string",
    "dataObjectVersion" : [ "string" ],
    "deactivationDate" : "string",
    "description" : "string",
    "everyDataObjectVersion" : true,
    "everyFormatType" : true,
    "formatType" : [ "string" ],
    "formatUnidentifiedAuthorized" : true,
    "id" : "string",
    "identifier" : "string",
    "lastUpdate" : "string",
    "linkParentId" : "string",
    "managementContractId" : "string",
    "masterMandatory" : true,
    "name" : "string",
    "status" : "string",
    "tenant" : 0,
    "version" : 0
  } ]
}

2.6.3. checkExist

POST /referential/v1/ingestcontract/check
Paramètres
Type Nom Description Schéma

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Body

ingestContractDto
requis

ingestContractDto

IngestContractDto

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/ingestcontract/check
Requête body
{
  "activationDate" : "string",
  "archiveProfiles" : [ "string" ],
  "checkParentId" : [ "string" ],
  "checkParentLink" : "string",
  "creationDate" : "string",
  "dataObjectVersion" : [ "string" ],
  "deactivationDate" : "string",
  "description" : "string",
  "everyDataObjectVersion" : true,
  "everyFormatType" : true,
  "formatType" : [ "string" ],
  "formatUnidentifiedAuthorized" : true,
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "linkParentId" : "string",
  "managementContractId" : "string",
  "masterMandatory" : true,
  "name" : "string",
  "status" : "string",
  "tenant" : 0,
  "version" : 0
}

2.6.4. getOne

GET /referential/v1/ingestcontract/{identifier}
Paramètres
Type Nom Description Schéma

Path

identifier
requis

identifier

string

Réponses
Code HTTP Description Schéma

200

OK

IngestContractDto

Exemple de requête HTTP
Requête path
/referential/v1/ingestcontract/string
Exemple de réponse HTTP
Réponse 200
{
  "activationDate" : "string",
  "archiveProfiles" : [ "string" ],
  "checkParentId" : [ "string" ],
  "checkParentLink" : "string",
  "creationDate" : "string",
  "dataObjectVersion" : [ "string" ],
  "deactivationDate" : "string",
  "description" : "string",
  "everyDataObjectVersion" : true,
  "everyFormatType" : true,
  "formatType" : [ "string" ],
  "formatUnidentifiedAuthorized" : true,
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "linkParentId" : "string",
  "managementContractId" : "string",
  "masterMandatory" : true,
  "name" : "string",
  "status" : "string",
  "tenant" : 0,
  "version" : 0
}

2.6.5. update

PUT /referential/v1/ingestcontract/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Body

dto
requis

dto

IngestContractDto

Réponses
Code HTTP Description Schéma

200

OK

IngestContractDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/ingestcontract/string
Requête body
{
  "activationDate" : "string",
  "archiveProfiles" : [ "string" ],
  "checkParentId" : [ "string" ],
  "checkParentLink" : "string",
  "creationDate" : "string",
  "dataObjectVersion" : [ "string" ],
  "deactivationDate" : "string",
  "description" : "string",
  "everyDataObjectVersion" : true,
  "everyFormatType" : true,
  "formatType" : [ "string" ],
  "formatUnidentifiedAuthorized" : true,
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "linkParentId" : "string",
  "managementContractId" : "string",
  "masterMandatory" : true,
  "name" : "string",
  "status" : "string",
  "tenant" : 0,
  "version" : 0
}
Exemple de réponse HTTP
Réponse 200
{
  "activationDate" : "string",
  "archiveProfiles" : [ "string" ],
  "checkParentId" : [ "string" ],
  "checkParentLink" : "string",
  "creationDate" : "string",
  "dataObjectVersion" : [ "string" ],
  "deactivationDate" : "string",
  "description" : "string",
  "everyDataObjectVersion" : true,
  "everyFormatType" : true,
  "formatType" : [ "string" ],
  "formatUnidentifiedAuthorized" : true,
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "linkParentId" : "string",
  "managementContractId" : "string",
  "masterMandatory" : true,
  "name" : "string",
  "status" : "string",
  "tenant" : 0,
  "version" : 0
}

2.6.6. patch

PATCH /referential/v1/ingestcontract/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Body

partialDto
requis

partialDto

object

Réponses
Code HTTP Description Schéma

200

OK

IngestContractDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/ingestcontract/string
Exemple de réponse HTTP
Réponse 200
{
  "activationDate" : "string",
  "archiveProfiles" : [ "string" ],
  "checkParentId" : [ "string" ],
  "checkParentLink" : "string",
  "creationDate" : "string",
  "dataObjectVersion" : [ "string" ],
  "deactivationDate" : "string",
  "description" : "string",
  "everyDataObjectVersion" : true,
  "everyFormatType" : true,
  "formatType" : [ "string" ],
  "formatUnidentifiedAuthorized" : true,
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "linkParentId" : "string",
  "managementContractId" : "string",
  "masterMandatory" : true,
  "name" : "string",
  "status" : "string",
  "tenant" : 0,
  "version" : 0
}

2.6.7. findHistoryById

GET /referential/v1/ingestcontract/{id}/history
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

Exemple de requête HTTP
Requête path
/referential/v1/ingestcontract/string/history

2.7. Management-contract-internal-controller

Management Contract Internal Controller

2.7.1. getAll

GET /referential/v1/managementcontract
Paramètres
Type Nom Description Schéma

Query

criteria
requis

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

< ManagementContractDto > array

Exemple de requête HTTP
Requête path
/referential/v1/managementcontract
Requête query
{
  "criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
  "activationDate" : "string",
  "creationDate" : "string",
  "description" : "string",
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "name" : "string",
  "status" : "string",
  "storage" : {
    "strategyId" : "string"
  },
  "tenant" : 0,
  "version" : 0
} ]

2.8. Ontology-internal-controller

Ontology Internal Controller

2.8.1. create

POST /referential/v1/ontology
Paramètres
Type Nom Description Schéma

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Body

ontologyDto
requis

ontologyDto

OntologyDto

Réponses
Code HTTP Description Schéma

200

OK

OntologyDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/ontology
Requête body
{
  "apiField" : "string",
  "collections" : [ "string" ],
  "creationDate" : "string",
  "description" : "string",
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "origin" : "string",
  "sedaField" : "string",
  "shortName" : "string",
  "tenant" : 0,
  "type" : "string",
  "version" : 0
}
Exemple de réponse HTTP
Réponse 200
{
  "apiField" : "string",
  "collections" : [ "string" ],
  "creationDate" : "string",
  "description" : "string",
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "origin" : "string",
  "sedaField" : "string",
  "shortName" : "string",
  "tenant" : 0,
  "type" : "string",
  "version" : 0
}

2.8.2. getAllPaginated

GET /referential/v1/ontology
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«OntologyDto»

Exemple de requête HTTP
Requête path
/referential/v1/ontology
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" : [ {
    "apiField" : "string",
    "collections" : [ "string" ],
    "creationDate" : "string",
    "description" : "string",
    "id" : "string",
    "identifier" : "string",
    "lastUpdate" : "string",
    "origin" : "string",
    "sedaField" : "string",
    "shortName" : "string",
    "tenant" : 0,
    "type" : "string",
    "version" : 0
  } ]
}

2.8.3. checkExist

POST /referential/v1/ontology/check
Paramètres
Type Nom Description Schéma

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Body

ontologyDto
requis

ontologyDto

OntologyDto

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/ontology/check
Requête body
{
  "apiField" : "string",
  "collections" : [ "string" ],
  "creationDate" : "string",
  "description" : "string",
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "origin" : "string",
  "sedaField" : "string",
  "shortName" : "string",
  "tenant" : 0,
  "type" : "string",
  "version" : 0
}

2.8.4. importOntology

POST /referential/v1/ontology/import
Paramètres
Type Nom Description Schéma

Query

fileName
requis

fileName

string

Body

file
requis

file

string (binary)

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

Consomme
  • multipart/form-data

Exemple de requête HTTP
Requête path
/referential/v1/ontology/import
Requête query
{
  "fileName" : "string"
}

2.8.5. getOne

GET /referential/v1/ontology/{identifier}
Paramètres
Type Nom Description Schéma

Path

identifier
requis

identifier

string

Réponses
Code HTTP Description Schéma

200

OK

OntologyDto

Exemple de requête HTTP
Requête path
/referential/v1/ontology/string
Exemple de réponse HTTP
Réponse 200
{
  "apiField" : "string",
  "collections" : [ "string" ],
  "creationDate" : "string",
  "description" : "string",
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "origin" : "string",
  "sedaField" : "string",
  "shortName" : "string",
  "tenant" : 0,
  "type" : "string",
  "version" : 0
}

2.8.6. delete

DELETE /referential/v1/ontology/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Exemple de requête HTTP
Requête path
/referential/v1/ontology/string

2.8.7. patch

PATCH /referential/v1/ontology/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Body

partialDto
requis

partialDto

object

Réponses
Code HTTP Description Schéma

200

OK

OntologyDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/ontology/string
Exemple de réponse HTTP
Réponse 200
{
  "apiField" : "string",
  "collections" : [ "string" ],
  "creationDate" : "string",
  "description" : "string",
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "origin" : "string",
  "sedaField" : "string",
  "shortName" : "string",
  "tenant" : 0,
  "type" : "string",
  "version" : 0
}

2.8.8. findHistoryById

GET /referential/v1/ontology/{id}/history
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

Exemple de requête HTTP
Requête path
/referential/v1/ontology/string/history

2.9. Operation-internal-controller

Operation Internal Controller

2.9.1. create

POST /referential/v1/operations
Paramètres
Type Nom Description Schéma

Header

X-Access-Contract-Id
requis

X-Access-Contract-Id

string

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Body

auditOptions
requis

auditOptions

AuditOptions

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/operations
Requête body
{
  "auditActions" : "string",
  "auditType" : "string",
  "objectId" : "string",
  "query" : { }
}

2.9.2. getAllPaginated

GET /referential/v1/operations
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
/referential/v1/operations
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",
    "collectionName" : "string",
    "data" : "string",
    "dateTime" : "string",
    "events" : [ {
      "agId" : "string",
      "agIdApp" : "string",
      "agIdExt" : "string",
      "collectionName" : "string",
      "data" : "string",
      "dateTime" : "string",
      "id" : "string",
      "idAppSession" : "string",
      "idRequest" : "string",
      "objectId" : "string",
      "outDetail" : "string",
      "outMessage" : "string",
      "outcome" : "string",
      "parentId" : "string",
      "rightsStatementIdentifier" : "string",
      "type" : "string",
      "typeProc" : "string"
    } ],
    "id" : "string",
    "idAppSession" : "string",
    "idRequest" : "string",
    "objectId" : "string",
    "outDetail" : "string",
    "outMessage" : "string",
    "outcome" : "string",
    "parentId" : "string",
    "rightsStatementIdentifier" : "string",
    "type" : "string",
    "typeProc" : "string"
  } ]
}

2.9.3. checkTraceabilityOperation

GET /referential/v1/operations/check/{id}
Paramètres
Type Nom Description Schéma

Header

X-Access-Contract-Id
requis

X-Access-Contract-Id

string

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

Exemple de requête HTTP
Requête path
/referential/v1/operations/check/string
Requête header
"string"

2.9.4. runProbativeValue

POST /referential/v1/operations/probativeValue
Paramètres
Type Nom Description Schéma

Header

X-Access-Contract-Id
requis

X-Access-Contract-Id

string

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Body

probativeValueRequest
requis

probativeValueRequest

ProbativeValueRequest

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/operations/probativeValue
Requête body
{
  "dslQuery" : { },
  "usage" : "string",
  "version" : "string"
}

2.9.5. exportProbativeValue

GET /referential/v1/operations/probativeValue/{id}
Paramètres
Type Nom Description Schéma

Header

X-Access-Contract-Id
requis

X-Access-Contract-Id

string

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

Resource

Exemple de requête HTTP
Requête path
/referential/v1/operations/probativeValue/string
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
{
  "description" : "string",
  "file" : "file",
  "filename" : "string",
  "inputStream" : { },
  "open" : true,
  "readable" : true,
  "uri" : "string",
  "url" : "string"
}

2.9.6. exportEventById

GET /referential/v1/operations/{id}/download/{type}
Paramètres
Type Nom Description Schéma

Header

X-Access-Contract-Id
requis

X-Access-Contract-Id

string

Path

id
requis

id

string

Path

type
requis

type

enum (AUDIT, PROBATIVE_VALUE, TRACEABILITY)

Réponses
Code HTTP Description Schéma

200

OK

Resource

Exemple de requête HTTP
Requête path
/referential/v1/operations/string/download/string
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
{
  "description" : "string",
  "file" : "file",
  "filename" : "string",
  "inputStream" : { },
  "open" : true,
  "readable" : true,
  "uri" : "string",
  "url" : "string"
}

2.9.7. findHistoryById

GET /referential/v1/operations/{id}/history
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

Exemple de requête HTTP
Requête path
/referential/v1/operations/string/history

2.10. Profile-internal-controller

Profile Internal Controller

2.10.1. getAll

GET /referential/v1/profile
Paramètres
Type Nom Description Schéma

Query

criteria
requis

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

< ProfileDto > array

Exemple de requête HTTP
Requête path
/referential/v1/profile
Requête query
{
  "criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
  "activationdate" : "string",
  "creationdate" : "string",
  "deactivationdate" : "string",
  "description" : "string",
  "format" : "string",
  "id" : "string",
  "identifier" : "string",
  "lastupdate" : "string",
  "name" : "string",
  "path" : "string",
  "status" : "string",
  "tenant" : 0,
  "version" : 0
} ]

2.11. Rule-internal-controller

Rule Internal Controller

2.11.1. create

POST /referential/v1/rules
Paramètres
Type Nom Description Schéma

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Body

ruleDto
requis

ruleDto

RuleDto

Réponses
Code HTTP Description Schéma

200

OK

RuleDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/rules
Requête body
{
  "EndDate" : "string",
  "Rule" : "string",
  "StartDate" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "EndDate" : "string",
  "Rule" : "string",
  "StartDate" : "string"
}

2.11.2. getAllPaginated

GET /referential/v1/rules
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«RuleDto»

Exemple de requête HTTP
Requête path
/referential/v1/rules
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" : [ {
    "EndDate" : "string",
    "Rule" : "string",
    "StartDate" : "string"
  } ]
}

2.11.3. checkExist

POST /referential/v1/rules/check
Paramètres
Type Nom Description Schéma

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Body

ruleDto
requis

ruleDto

RuleDto

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/rules/check
Requête body
{
  "EndDate" : "string",
  "Rule" : "string",
  "StartDate" : "string"
}

2.11.4. export

GET /referential/v1/rules/export
Réponses
Code HTTP Description Schéma

200

OK

Resource

Exemple de requête HTTP
Requête path
/referential/v1/rules/export
Exemple de réponse HTTP
Réponse 200
{
  "description" : "string",
  "file" : "file",
  "filename" : "string",
  "inputStream" : { },
  "open" : true,
  "readable" : true,
  "uri" : "string",
  "url" : "string"
}

2.11.5. getOne

GET /referential/v1/rules/{identifier}
Paramètres
Type Nom Description Schéma

Path

identifier
requis

identifier

string

Réponses
Code HTTP Description Schéma

200

OK

RuleDto

Exemple de requête HTTP
Requête path
/referential/v1/rules/string
Exemple de réponse HTTP
Réponse 200
{
  "EndDate" : "string",
  "Rule" : "string",
  "StartDate" : "string"
}

2.11.6. delete

DELETE /referential/v1/rules/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Exemple de requête HTTP
Requête path
/referential/v1/rules/string

2.11.7. patch

PATCH /referential/v1/rules/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Body

partialDto
requis

partialDto

object

Réponses
Code HTTP Description Schéma

200

OK

RuleDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/rules/string
Exemple de réponse HTTP
Réponse 200
{
  "EndDate" : "string",
  "Rule" : "string",
  "StartDate" : "string"
}

2.11.8. findHistoryById

GET /referential/v1/rules/{id}/history
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

Exemple de requête HTTP
Requête path
/referential/v1/rules/string/history

2.12. Security-profile-internal-controller

Security Profile Internal Controller

2.12.1. create

POST /referential/v1/security-profile
Paramètres
Type Nom Description Schéma

Body

accessContractDto
requis

accessContractDto

SecurityProfileDto

Réponses
Code HTTP Description Schéma

200

OK

SecurityProfileDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/security-profile
Requête body
{
  "fullAccess" : true,
  "id" : "string",
  "identifier" : "string",
  "name" : "string",
  "permissions" : [ "string" ]
}
Exemple de réponse HTTP
Réponse 200
{
  "fullAccess" : true,
  "id" : "string",
  "identifier" : "string",
  "name" : "string",
  "permissions" : [ "string" ]
}

2.12.2. getAll

GET /referential/v1/security-profile
Paramètres
Type Nom Description Schéma

Query

criteria
requis

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

< SecurityProfileDto > array

Exemple de requête HTTP
Requête path
/referential/v1/security-profile
Requête query
{
  "criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
  "fullAccess" : true,
  "id" : "string",
  "identifier" : "string",
  "name" : "string",
  "permissions" : [ "string" ]
} ]

2.12.3. checkExist

POST /referential/v1/security-profile/check
Paramètres
Type Nom Description Schéma

Body

accessContractDto
requis

accessContractDto

SecurityProfileDto

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/security-profile/check
Requête body
{
  "fullAccess" : true,
  "id" : "string",
  "identifier" : "string",
  "name" : "string",
  "permissions" : [ "string" ]
}

2.12.4. getOne

GET /referential/v1/security-profile/{identifier}
Paramètres
Type Nom Description Schéma

Path

identifier
requis

identifier

string

Réponses
Code HTTP Description Schéma

200

OK

SecurityProfileDto

Exemple de requête HTTP
Requête path
/referential/v1/security-profile/string
Exemple de réponse HTTP
Réponse 200
{
  "fullAccess" : true,
  "id" : "string",
  "identifier" : "string",
  "name" : "string",
  "permissions" : [ "string" ]
}

2.12.5. delete

DELETE /referential/v1/security-profile/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Exemple de requête HTTP
Requête path
/referential/v1/security-profile/string

2.12.6. patch

PATCH /referential/v1/security-profile/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Body

partialDto
requis

partialDto

object

Réponses
Code HTTP Description Schéma

200

OK

SecurityProfileDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential/v1/security-profile/string
Exemple de réponse HTTP
Réponse 200
{
  "fullAccess" : true,
  "id" : "string",
  "identifier" : "string",
  "name" : "string",
  "permissions" : [ "string" ]
}

2.12.7. findHistoryById

GET /referential/v1/security-profile/{id}/history
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

Exemple de requête HTTP
Requête path
/referential/v1/security-profile/string/history

2.13. Status

Status check and autotest

2.13.1. autotest

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

200

OK

string

2.13.2. status

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

200

OK

string

2.14. Unit-internal-controller

Unit Internal Controller

2.14.1. findByDsl

POST /units/dsl
Paramètres
Type Nom Description Schéma

Header

X-Access-Contract-Id
requis

X-Access-Contract-Id

string

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Path

id
requis

id

string

Body

dsl
requis

dsl

JsonNode

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

Consomme
  • application/json

2.14.2. findByDsl

POST /units/dsl/{id}
Paramètres
Type Nom Description Schéma

Header

X-Access-Contract-Id
requis

X-Access-Contract-Id

string

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Path

id
requis

id

string

Body

dsl
requis

dsl

JsonNode

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

Consomme
  • application/json

2.14.3. getFillingPlan

GET /units/filingplan
Paramètres
Type Nom Description Schéma

Header

X-Access-Contract-Id
requis

X-Access-Contract-Id

string

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Réponses
Code HTTP Description Schéma

200

OK

VitamUISearchResponseDto

Exemple de réponse HTTP
Réponse 200
{
  "$context" : {
    "$filter" : {
      "$limit" : 0,
      "$orderby" : {
        "TransactedDate" : 0
      }
    },
    "$projection" : {
      "$fields" : {
        "Description" : 0,
        "Title" : 0
      }
    },
    "$query" : [ {
      "$filter" : {
        "$limit" : 0,
        "$offset" : 0,
        "$orderby" : {
          "string" : 0
        }
      },
      "$projection" : {
        "$fields" : {
          "string" : 0
        }
      },
      "$query" : [ { } ],
      "$roots" : [ "string" ]
    } ],
    "$roots" : [ "string" ]
  },
  "$facetResults" : [ {
    "buckets" : [ {
      "count" : 0,
      "value" : "string"
    } ],
    "name" : "string"
  } ],
  "$hits" : {
    "limit" : 0,
    "offset" : 0,
    "size" : 0,
    "total" : 0
  },
  "$results" : [ {
    "#allunitups" : [ "string" ],
    "#id" : "string",
    "#management" : {
      "AppraisalRule" : {
        "FinalAction" : "string",
        "Rules" : [ {
          "EndDate" : "string",
          "Rule" : "string",
          "StartDate" : "string"
        } ]
      }
    },
    "#max" : 0,
    "#min" : 0,
    "#nbobjects" : 0,
    "#nbunits" : 0,
    "#object" : "string",
    "#operations" : [ "string" ],
    "#opi" : "string",
    "#originating_agencies" : [ "string" ],
    "#originating_agency" : "string",
    "#qualifiers" : [ {
      "qualifier" : "string",
      "versions" : [ {
        "#id" : "string",
        "#rank" : 0,
        "#storage" : {
          "#nbc" : "string",
          "offerIds" : [ "string" ],
          "strategyId" : "string"
        },
        "Algorithm" : "string",
        "DataObjectGroupId" : "string",
        "DataObjectVersion" : "string",
        "FileInfo" : {
          "CreatingApplicationName" : "string",
          "CreatingApplicationVersion" : "string",
          "CreatingOs" : "string",
          "CreatingOsVersion" : "string",
          "DateCreatedByApplication" : "string",
          "Filename" : "string",
          "LastModified" : "string"
        },
        "FormatIdentification" : {
          "Encoding" : "string",
          "FormatId" : "string",
          "FormatLitteral" : "string",
          "MimeType" : "string"
        },
        "MessageDigest" : "string",
        "Metadata" : {
          "Audio" : "object",
          "Document" : "object",
          "Image" : "object",
          "Text" : "object",
          "Video" : "object"
        },
        "OtherMetadata" : "object",
        "PhysicalDimensions" : {
          "Depth" : {
            "dValue" : 0.0,
            "dvalue" : 0.0,
            "unit" : "string"
          },
          "Diameter" : {
            "dValue" : 0.0,
            "dvalue" : 0.0,
            "unit" : "string"
          },
          "Height" : {
            "dValue" : 0.0,
            "dvalue" : 0.0,
            "unit" : "string"
          },
          "Length" : {
            "dValue" : 0.0,
            "dvalue" : 0.0,
            "unit" : "string"
          },
          "NumberOfPage" : 0,
          "Shape" : "string",
          "Thickness" : {
            "dValue" : 0.0,
            "dvalue" : 0.0,
            "unit" : "string"
          },
          "Weight" : {
            "dValue" : 0.0,
            "dvalue" : 0.0,
            "unit" : "string"
          },
          "Width" : {
            "dValue" : 0.0,
            "dvalue" : 0.0,
            "unit" : "string"
          },
          "any" : [ "object" ]
        },
        "PhysicalId" : "string",
        "Size" : 0,
        "Uri" : "string"
      } ]
    } ],
    "#storage" : {
      "strategyId" : "string"
    },
    "#tenant" : 0,
    "#unitType" : "string",
    "#unitups" : [ "string" ],
    "AcquiredDate" : "string",
    "CreatedDate" : "string",
    "Description" : "string",
    "DescriptionLevel" : "string",
    "DocumentType" : "string",
    "EndDate" : "string",
    "FileInfo" : {
      "CreatingApplicationName" : "string",
      "CreatingApplicationVersion" : "string",
      "CreatingOs" : "string",
      "CreatingOsVersion" : "string",
      "DateCreatedByApplication" : "string",
      "Filename" : "string",
      "LastModified" : "string"
    },
    "InheritedRules" : {
      "AppraisalRule" : {
        "Properties" : [ {
          "PropertyName" : "string",
          "PropertyValue" : "object"
        } ],
        "Rules" : [ {
          "EndDate" : "string",
          "Rule" : "string",
          "StartDate" : "string"
        } ]
      }
    },
    "Keyword" : [ {
      "KeywordContent" : "string",
      "KeywordReference" : "string"
    } ],
    "OriginatingAgencyArchiveUnitIdentifier" : [ "string" ],
    "OriginatingSystemId" : [ "string" ],
    "PhysicalAgency" : [ "string" ],
    "PhysicalStatus" : [ "string" ],
    "PhysicalType" : [ "string" ],
    "ReceivedDate" : "string",
    "RegisteredDate" : "string",
    "SentDate" : "string",
    "StartDate" : "string",
    "Status" : "string",
    "SubmissionAgency" : {
      "Identifier" : "string"
    },
    "Title" : "string",
    "Title_" : {
      "en" : "string",
      "fr" : "string"
    },
    "TransactedDate" : "string",
    "Version" : "string",
    "Vtag" : [ {
      "Key" : [ "string" ],
      "Value" : [ "string" ]
    } ],
    "Xtag" : [ {
      "Key" : [ "string" ],
      "Value" : [ "string" ]
    } ]
  } ]
}

2.14.4. findUnitById

GET /units/{id}
Paramètres
Type Nom Description Schéma

Header

X-Access-Contract-Id
requis

X-Access-Contract-Id

string

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

2.14.5. findObjectMetadataById

POST /units/{id}/objects
Paramètres
Type Nom Description Schéma

Header

X-Access-Contract-Id
requis

X-Access-Contract-Id

string

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Path

id
requis

id

string

Body

dsl
requis

dsl

JsonNode

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

Consomme
  • application/json

3. Définitions

3.1. AccessContractDto

Nom Description Schéma

accessLog
optionnel

Exemple : "string"

string

activationDate
optionnel

Exemple : "string"

string

creationDate
optionnel

Exemple : "string"

string

dataObjectVersion
optionnel

Exemple : [ "string" ]

< string > array

deactivationDate
optionnel

Exemple : "string"

string

description
optionnel

Exemple : "string"

string

everyDataObjectVersion
optionnel

Exemple : true

boolean

everyOriginatingAgency
optionnel

Exemple : true

boolean

excludedRootUnits
optionnel

Exemple : [ "string" ]

< string > array

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

lastUpdate
optionnel

Exemple : "string"

string

name
optionnel

Exemple : "string"

string

originatingAgencies
optionnel

Exemple : [ "string" ]

< string > array

rootUnits
optionnel

Exemple : [ "string" ]

< string > array

ruleCategoryToFilter
optionnel

Exemple : [ "string" ]

< string > array

status
optionnel

Exemple : "string"

string

tenant
optionnel

Exemple : 0

integer (int32)

version
optionnel

Exemple : 0

integer (int32)

writingPermission
optionnel

Exemple : true

boolean

writingRestrictedDesc
optionnel

Exemple : true

boolean

3.2. AccessionRegisterSummaryDto

Nom Description Schéma

creationDate
optionnel

Exemple : "string"

string

id
optionnel

Exemple : "string"

string

objectSize
optionnel

Exemple : "RegisterValueDetailModel"

RegisterValueDetailModel

originatingAgency
optionnel

Exemple : "string"

string

tenant
optionnel

Exemple : 0

integer (int32)

totalObjects
optionnel

Exemple : "RegisterValueDetailModel"

RegisterValueDetailModel

totalObjectsGroups
optionnel

Exemple : "RegisterValueDetailModel"

RegisterValueDetailModel

totalUnits
optionnel

Exemple : "RegisterValueDetailModel"

RegisterValueDetailModel

version
optionnel

Exemple : 0

integer (int32)

3.3. AgencyDto

Nom Description Schéma

Identifier
optionnel

Exemple : "string"

string

3.4. AuditOptions

Nom Description Schéma

auditActions
optionnel

Exemple : "string"

string

auditType
optionnel

Exemple : "string"

string

objectId
optionnel

Exemple : "string"

string

query
optionnel

Exemple : "JsonNode"

JsonNode

3.5. ContextDto

Nom Description Schéma

activationDate
optionnel

Exemple : "string"

string

creationDate
optionnel

Exemple : "string"

string

deactivationDate
optionnel

Exemple : "string"

string

enableControl
optionnel

Exemple : true

boolean

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

lastUpdate
optionnel

Exemple : "string"

string

name
optionnel

Exemple : "string"

string

permissions
optionnel

Exemple : [ "PermissionDto" ]

< PermissionDto > array

securityProfile
optionnel

Exemple : "string"

string

status
optionnel

Exemple : "string"

string

3.6. FacetBucketDto

Nom Description Schéma

count
optionnel

Exemple : 0

integer (int64)

value
optionnel

Exemple : "string"

string

3.7. FacetResultsDto

Nom Description Schéma

buckets
optionnel

Exemple : [ "FacetBucketDto" ]

< FacetBucketDto > array

name
optionnel

Exemple : "string"

string

3.8. FieldsDto

Nom Description Schéma

Description
optionnel

Exemple : 0

integer (int32)

Title
optionnel

Exemple : 0

integer (int32)

3.9. FileFormatDto

Nom Description Schéma

alert
optionnel

Exemple : true

boolean

comment
optionnel

Exemple : "string"

string

createdDate
optionnel

Exemple : "string"

string

documentVersion
optionnel

Exemple : 0

integer (int32)

extensions
optionnel

Exemple : [ "string" ]

< string > array

group
optionnel

Exemple : "string"

string

hasPriorityOverFileFormatIDs
optionnel

Exemple : [ "string" ]

< string > array

id
optionnel

Exemple : "string"

string

mimeType
optionnel

Exemple : "string"

string

name
optionnel

Exemple : "string"

string

puid
optionnel

Exemple : "string"

string

version
optionnel

Exemple : "string"

string

versionPronom
optionnel

Exemple : "string"

string

3.10. FileInfoDto

Nom Description Schéma

CreatingApplicationName
optionnel

Exemple : "string"

string

CreatingApplicationVersion
optionnel

Exemple : "string"

string

CreatingOs
optionnel

Exemple : "string"

string

CreatingOsVersion
optionnel

Exemple : "string"

string

DateCreatedByApplication
optionnel

Exemple : "string"

string

Filename
optionnel

Exemple : "string"

string

LastModified
optionnel

Exemple : "string"

string

3.11. FileInfoModel

Nom Description Schéma

CreatingApplicationName
optionnel

Exemple : "string"

string

CreatingApplicationVersion
optionnel

Exemple : "string"

string

CreatingOs
optionnel

Exemple : "string"

string

CreatingOsVersion
optionnel

Exemple : "string"

string

DateCreatedByApplication
optionnel

Exemple : "string"

string

Filename
optionnel

Exemple : "string"

string

LastModified
optionnel

Exemple : "string"

string

3.12. FilterDto

Nom Description Schéma

$limit
optionnel

Exemple : 0

integer (int32)

$orderby
optionnel

Exemple : "OrderbyDto"

OrderbyDto

3.13. FormatIdentificationModel

Nom Description Schéma

Encoding
optionnel

Exemple : "string"

string

FormatId
optionnel

Exemple : "string"

string

FormatLitteral
optionnel

Exemple : "string"

string

MimeType
optionnel

Exemple : "string"

string

3.14. HitsDto

Nom Description Schéma

limit
optionnel

Exemple : 0

integer (int32)

offset
optionnel

Exemple : 0

integer (int32)

size
optionnel

Exemple : 0

integer (int32)

total
optionnel

Exemple : 0

integer (int32)

3.15. IngestContractDto

Nom Description Schéma

activationDate
optionnel

Exemple : "string"

string

archiveProfiles
optionnel

Exemple : [ "string" ]

< string > array

checkParentId
optionnel

Exemple : [ "string" ]

< string > array

checkParentLink
optionnel

Exemple : "string"

string

creationDate
optionnel

Exemple : "string"

string

dataObjectVersion
optionnel

Exemple : [ "string" ]

< string > array

deactivationDate
optionnel

Exemple : "string"

string

description
optionnel

Exemple : "string"

string

everyDataObjectVersion
optionnel

Exemple : true

boolean

everyFormatType
optionnel

Exemple : true

boolean

formatType
optionnel

Exemple : [ "string" ]

< string > array

formatUnidentifiedAuthorized
optionnel

Exemple : true

boolean

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

lastUpdate
optionnel

Exemple : "string"

string

linkParentId
optionnel

Exemple : "string"

string

managementContractId
optionnel

Exemple : "string"

string

masterMandatory
optionnel

Exemple : true

boolean

name
optionnel

Exemple : "string"

string

status
optionnel

Exemple : "string"

enum (ACTIVE, INACTIVE)

tenant
optionnel

Exemple : 0

integer (int32)

version
optionnel

Exemple : 0

integer (int32)

3.16. InheritedPropertyDto

Nom Description Schéma

PropertyName
optionnel

Exemple : "string"

string

PropertyValue
optionnel

Exemple : "object"

object

3.17. InheritedRuleCategoryDto

Nom Description Schéma

Properties
optionnel

Exemple : [ "InheritedPropertyDto" ]

< InheritedPropertyDto > array

Rules
optionnel

Exemple : [ "RuleDto" ]

< RuleDto > array

3.18. InheritedRulesDto

Nom Description Schéma

AppraisalRule
optionnel

Exemple : "InheritedRuleCategoryDto"

InheritedRuleCategoryDto

3.19. InputStream

Type : object

3.20. JsonNode

Type : object

3.21. KeywordDto

Nom Description Schéma

KeywordContent
optionnel

Exemple : "string"

string

KeywordReference
optionnel

Exemple : "string"

string

3.22. LogbookEventDto

Nom Description Schéma

agId
optionnel

Exemple : "string"

string

agIdApp
optionnel

Exemple : "string"

string

agIdExt
optionnel

Exemple : "string"

string

collectionName
optionnel

Exemple : "string"

string

data
optionnel

Exemple : "string"

string

dateTime
optionnel

Exemple : "string"

string

id
optionnel

Exemple : "string"

string

idAppSession
optionnel

Exemple : "string"

string

idRequest
optionnel

Exemple : "string"

string

objectId
optionnel

Exemple : "string"

string

outDetail
optionnel

Exemple : "string"

string

outMessage
optionnel

Exemple : "string"

string

outcome
optionnel

Exemple : "string"

string

parentId
optionnel

Exemple : "string"

string

rightsStatementIdentifier
optionnel

Exemple : "string"

string

type
optionnel

Exemple : "string"

string

typeProc
optionnel

Exemple : "string"

string

3.23. LogbookOperationDto

Nom Description Schéma

agId
optionnel

Exemple : "string"

string

agIdApp
optionnel

Exemple : "string"

string

agIdExt
optionnel

Exemple : "string"

string

collectionName
optionnel

Exemple : "string"

string

data
optionnel

Exemple : "string"

string

dateTime
optionnel

Exemple : "string"

string

events
optionnel

Exemple : [ "LogbookEventDto" ]

< LogbookEventDto > array

id
optionnel

Exemple : "string"

string

idAppSession
optionnel

Exemple : "string"

string

idRequest
optionnel

Exemple : "string"

string

objectId
optionnel

Exemple : "string"

string

outDetail
optionnel

Exemple : "string"

string

outMessage
optionnel

Exemple : "string"

string

outcome
optionnel

Exemple : "string"

string

parentId
optionnel

Exemple : "string"

string

rightsStatementIdentifier
optionnel

Exemple : "string"

string

type
optionnel

Exemple : "string"

string

typeProc
optionnel

Exemple : "string"

string

3.24. ManagementContractDto

Nom Description Schéma

activationDate
optionnel

Exemple : "string"

string

creationDate
optionnel

Exemple : "string"

string

description
optionnel

Exemple : "string"

string

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

lastUpdate
optionnel

Exemple : "string"

string

name
optionnel

Exemple : "string"

string

status
optionnel

Exemple : "string"

string

storage
optionnel

Exemple : "StorageDto"

StorageDto

tenant
optionnel

Exemple : 0

integer (int32)

version
optionnel

Exemple : 0

integer (int32)

3.25. ManagementDto

Nom Description Schéma

AppraisalRule
optionnel

Exemple : "RuleCategoryDto"

RuleCategoryDto

3.26. MeasurementModel

Nom Description Schéma

dValue
optionnel

Exemple : 0.0

number

dvalue
optionnel

Exemple : 0.0

number

unit
optionnel

Exemple : "string"

string

3.27. MetadataModel

Nom Description Schéma

Audio
optionnel

Exemple : "object"

object

Document
optionnel

Exemple : "object"

object

Image
optionnel

Exemple : "object"

object

Text
optionnel

Exemple : "object"

object

Video
optionnel

Exemple : "object"

object

3.28. OntologyDto

Nom Description Schéma

apiField
optionnel

Exemple : "string"

string

collections
optionnel

Exemple : [ "string" ]

< string > array

creationDate
optionnel

Exemple : "string"

string

description
optionnel

Exemple : "string"

string

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

lastUpdate
optionnel

Exemple : "string"

string

origin
optionnel

Exemple : "string"

enum (EXTERNAL, INTERNAL)

sedaField
optionnel

Exemple : "string"

string

shortName
optionnel

Exemple : "string"

string

tenant
optionnel

Exemple : 0

integer (int32)

type
optionnel

Exemple : "string"

enum (BOOLEAN, DATE, DOUBLE, ENUM, GEO_POINT, KEYWORD, LONG, TEXT)

version
optionnel

Exemple : 0

integer (int32)

3.29. OrderbyDto

Nom Description Schéma

TransactedDate
optionnel

Exemple : 0

integer (int32)

3.30. PaginatedValuesDto«AccessContractDto»

Nom Description Schéma

hasMore
optionnel

Exemple : true

boolean

pageNum
optionnel

Exemple : 0

integer (int32)

pageSize
optionnel

Exemple : 0

integer (int32)

values
optionnel

Exemple : [ "AccessContractDto" ]

< AccessContractDto > array

3.31. PaginatedValuesDto«AgencyDto»

Nom Description Schéma

hasMore
optionnel

Exemple : true

boolean

pageNum
optionnel

Exemple : 0

integer (int32)

pageSize
optionnel

Exemple : 0

integer (int32)

values
optionnel

Exemple : [ "AgencyDto" ]

< AgencyDto > array

3.32. PaginatedValuesDto«ContextDto»

Nom Description Schéma

hasMore
optionnel

Exemple : true

boolean

pageNum
optionnel

Exemple : 0

integer (int32)

pageSize
optionnel

Exemple : 0

integer (int32)

values
optionnel

Exemple : [ "ContextDto" ]

< ContextDto > array

3.33. PaginatedValuesDto«FileFormatDto»

Nom Description Schéma

hasMore
optionnel

Exemple : true

boolean

pageNum
optionnel

Exemple : 0

integer (int32)

pageSize
optionnel

Exemple : 0

integer (int32)

values
optionnel

Exemple : [ "FileFormatDto" ]

< FileFormatDto > array

3.34. PaginatedValuesDto«IngestContractDto»

Nom Description Schéma

hasMore
optionnel

Exemple : true

boolean

pageNum
optionnel

Exemple : 0

integer (int32)

pageSize
optionnel

Exemple : 0

integer (int32)

values
optionnel

Exemple : [ "IngestContractDto" ]

< IngestContractDto > array

3.35. 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.36. PaginatedValuesDto«OntologyDto»

Nom Description Schéma

hasMore
optionnel

Exemple : true

boolean

pageNum
optionnel

Exemple : 0

integer (int32)

pageSize
optionnel

Exemple : 0

integer (int32)

values
optionnel

Exemple : [ "OntologyDto" ]

< OntologyDto > array

3.37. PaginatedValuesDto«RuleDto»

Nom Description Schéma

hasMore
optionnel

Exemple : true

boolean

pageNum
optionnel

Exemple : 0

integer (int32)

pageSize
optionnel

Exemple : 0

integer (int32)

values
optionnel

Exemple : [ "RuleDto" ]

< RuleDto > array

3.38. PaginatedValuesDto«SecurityProfileDto»

Nom Description Schéma

hasMore
optionnel

Exemple : true

boolean

pageNum
optionnel

Exemple : 0

integer (int32)

pageSize
optionnel

Exemple : 0

integer (int32)

values
optionnel

Exemple : [ "SecurityProfileDto" ]

< SecurityProfileDto > array

3.39. PermissionDto

Nom Description Schéma

accessContracts
optionnel

Exemple : [ "string" ]

< string > array

ingestContracts
optionnel

Exemple : [ "string" ]

< string > array

tenant
optionnel

Exemple : "string"

string

3.40. PhysicalDimensionsModel

Nom Description Schéma

Depth
optionnel

Exemple : "MeasurementModel"

MeasurementModel

Diameter
optionnel

Exemple : "MeasurementModel"

MeasurementModel

Height
optionnel

Exemple : "MeasurementModel"

MeasurementModel

Length
optionnel

Exemple : "MeasurementModel"

MeasurementModel

NumberOfPage
optionnel

Exemple : 0

integer (int32)

Shape
optionnel

Exemple : "string"

string

Thickness
optionnel

Exemple : "MeasurementModel"

MeasurementModel

Weight
optionnel

Exemple : "MeasurementModel"

MeasurementModel

Width
optionnel

Exemple : "MeasurementModel"

MeasurementModel

any
optionnel

Exemple : [ "object" ]

< object > array

3.41. ProbativeValueRequest

Nom Description Schéma

dslQuery
optionnel

Exemple : "JsonNode"

JsonNode

usage
optionnel

Exemple : "string"

string

version
optionnel

Exemple : "string"

string

3.42. ProfileDto

Nom Description Schéma

activationdate
optionnel

Exemple : "string"

string

creationdate
optionnel

Exemple : "string"

string

deactivationdate
optionnel

Exemple : "string"

string

description
optionnel

Exemple : "string"

string

format
optionnel

Exemple : "string"

enum (RNG, XSD)

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

lastupdate
optionnel

Exemple : "string"

string

name
optionnel

Exemple : "string"

string

path
optionnel

Exemple : "string"

string

status
optionnel

Exemple : "string"

enum (ACTIVE, INACTIVE)

tenant
optionnel

Exemple : 0

integer (int32)

version
optionnel

Exemple : 0

integer (int32)

3.43. ProjectionDto

Nom Description Schéma

$fields
optionnel

Exemple : "FieldsDto"

FieldsDto

3.44. QualifiersDto

Nom Description Schéma

qualifier
optionnel

Exemple : "string"

string

versions
optionnel

Exemple : [ "VersionsDto" ]

< VersionsDto > array

3.45. QueryDTO

Nom Description Schéma

$filter
optionnel

Exemple : "QueryFilter"

QueryFilter

$projection
optionnel

Exemple : "QueryProjection"

QueryProjection

$query
optionnel

Exemple : [ "JsonNode" ]

< JsonNode > array

$roots
optionnel

Exemple : [ "string" ]

< string > array

3.46. QueryFilter

Nom Description Schéma

$limit
optionnel

Exemple : 0

integer (int32)

$offset
optionnel

Exemple : 0

integer (int32)

$orderby
optionnel

Exemple : {
"string" : 0
}

< string, integer (int32) > map

3.47. QueryProjection

Nom Description Schéma

$fields
optionnel

Exemple : {
"string" : 0
}

< string, integer (int32) > map

3.48. RegisterValueDetailModel

Nom Description Schéma

deleted
optionnel

Exemple : 0

integer (int64)

ingested
optionnel

Exemple : 0

integer (int64)

remained
optionnel

Exemple : 0

integer (int64)

3.49. Resource

Nom Description Schéma

description
optionnel

Exemple : "string"

string

file
optionnel

Exemple : "file"

file

filename
optionnel

Exemple : "string"

string

inputStream
optionnel

Exemple : "InputStream"

InputStream

open
optionnel

Exemple : true

boolean

readable
optionnel

Exemple : true

boolean

uri
optionnel

Exemple : "string"

string (uri)

url
optionnel

Exemple : "string"

string (url)

3.50. ResultsDto

Nom Description Schéma

#allunitups
optionnel

Exemple : [ "string" ]

< string > array

#id
optionnel

Exemple : "string"

string

#management
optionnel

Exemple : "ManagementDto"

ManagementDto

#max
optionnel

Exemple : 0

integer (int32)

#min
optionnel

Exemple : 0

integer (int32)

#nbobjects
optionnel

Exemple : 0

integer (int32)

#nbunits
optionnel

Exemple : 0

integer (int32)

#object
optionnel

Exemple : "string"

string

#operations
optionnel

Exemple : [ "string" ]

< string > array

#opi
optionnel

Exemple : "string"

string

#originating_agencies
optionnel

Exemple : [ "string" ]

< string > array

#originating_agency
optionnel

Exemple : "string"

string

#qualifiers
optionnel

Exemple : [ "QualifiersDto" ]

< QualifiersDto > array

#storage
optionnel

Exemple : "StorageDto"

StorageDto

#tenant
optionnel

Exemple : 0

integer (int32)

#unitType
optionnel

Exemple : "string"

string

#unitups
optionnel

Exemple : [ "string" ]

< string > array

AcquiredDate
optionnel

Exemple : "string"

string

CreatedDate
optionnel

Exemple : "string"

string

Description
optionnel

Exemple : "string"

string

DescriptionLevel
optionnel

Exemple : "string"

string

DocumentType
optionnel

Exemple : "string"

string

EndDate
optionnel

Exemple : "string"

string

FileInfo
optionnel

Exemple : "FileInfoDto"

FileInfoDto

InheritedRules
optionnel

Exemple : "InheritedRulesDto"

InheritedRulesDto

Keyword
optionnel

Exemple : [ "KeywordDto" ]

< KeywordDto > array

OriginatingAgencyArchiveUnitIdentifier
optionnel

Exemple : [ "string" ]

< string > array

OriginatingSystemId
optionnel

Exemple : [ "string" ]

< string > array

PhysicalAgency
optionnel

Exemple : [ "string" ]

< string > array

PhysicalStatus
optionnel

Exemple : [ "string" ]

< string > array

PhysicalType
optionnel

Exemple : [ "string" ]

< string > array

ReceivedDate
optionnel

Exemple : "string"

string

RegisteredDate
optionnel

Exemple : "string"

string

SentDate
optionnel

Exemple : "string"

string

StartDate
optionnel

Exemple : "string"

string

Status
optionnel

Exemple : "string"

string

SubmissionAgency
optionnel

Exemple : "AgencyDto"

AgencyDto

Title
optionnel

Exemple : "string"

string

Title_
optionnel

Exemple : "TitleDto"

TitleDto

TransactedDate
optionnel

Exemple : "string"

string

Version
optionnel

Exemple : "string"

string

Vtag
optionnel

Exemple : [ "VtagDto" ]

< VtagDto > array

Xtag
optionnel

Exemple : [ "XtagDto" ]

< XtagDto > array

3.51. RuleCategoryDto

Nom Description Schéma

FinalAction
optionnel

Exemple : "string"

string

Rules
optionnel

Exemple : [ "RuleDto" ]

< RuleDto > array

3.52. RuleDto

Nom Description Schéma

EndDate
optionnel

Exemple : "string"

string

Rule
optionnel

Exemple : "string"

string

StartDate
optionnel

Exemple : "string"

string

3.53. SecurityProfileDto

Nom Description Schéma

fullAccess
optionnel

Exemple : true

boolean

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

name
optionnel

Exemple : "string"

string

permissions
optionnel

Exemple : [ "string" ]

< string > array

3.54. StorageDto

Nom Description Schéma

strategyId
optionnel

Exemple : "string"

string

3.55. StorageJson

Nom Description Schéma

#nbc
optionnel

Exemple : "string"

string

offerIds
optionnel

Exemple : [ "string" ]

< string > array

strategyId
optionnel

Exemple : "string"

string

3.56. TitleDto

Nom Description Schéma

en
optionnel

Exemple : "string"

string

fr
optionnel

Exemple : "string"

string

3.57. VersionsDto

Nom Description Schéma

#id
optionnel

Exemple : "string"

string

#rank
optionnel

Exemple : 0

integer (int32)

#storage
optionnel

Exemple : "StorageJson"

StorageJson

Algorithm
optionnel

Exemple : "string"

string

DataObjectGroupId
optionnel

Exemple : "string"

string

DataObjectVersion
optionnel

Exemple : "string"

string

FileInfo
optionnel

Exemple : "FileInfoModel"

FileInfoModel

FormatIdentification
optionnel

Exemple : "FormatIdentificationModel"

FormatIdentificationModel

MessageDigest
optionnel

Exemple : "string"

string

Metadata
optionnel

Exemple : "MetadataModel"

MetadataModel

OtherMetadata
optionnel

Exemple : "object"

object

PhysicalDimensions
optionnel

Exemple : "PhysicalDimensionsModel"

PhysicalDimensionsModel

PhysicalId
optionnel

Exemple : "string"

string

Size
optionnel

Exemple : 0

integer (int32)

Uri
optionnel

Exemple : "string"

string

3.58. VitamSearchRequestDto

Nom Description Schéma

$filter
optionnel

Exemple : "FilterDto"

FilterDto

$projection
optionnel

Exemple : "ProjectionDto"

ProjectionDto

$query
optionnel

Exemple : [ "QueryDTO" ]

< QueryDTO > array

$roots
optionnel

Exemple : [ "string" ]

< string > array

3.59. VitamUISearchResponseDto

Nom Description Schéma

$context
optionnel

Exemple : "VitamSearchRequestDto"

VitamSearchRequestDto

$facetResults
optionnel

Exemple : [ "FacetResultsDto" ]

< FacetResultsDto > array

$hits
optionnel

Exemple : "HitsDto"

HitsDto

$results
optionnel

Exemple : [ "ResultsDto" ]

< ResultsDto > array

3.60. VtagDto

Nom Description Schéma

Key
optionnel

Exemple : [ "string" ]

< string > array

Value
optionnel

Exemple : [ "string" ]

< string > array

3.61. XtagDto

Nom Description Schéma

Key
optionnel

Exemple : [ "string" ]

< string > array

Value
optionnel

Exemple : [ "string" ]

< string > array