1. Vue générale

DESCRIPTION HERE.

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

  • accesscontract : Access Contract Controller

  • accession-register : Accession Register Controller

  • agency : Agency Controller

  • context : Context Controller

  • customers : Customer Controller

  • fileformat : File Format Controller

  • ingestcontract : Ingest Contract Controller

  • managementcontract : Management Contract Controller

  • ontology : Ontology Controller

  • operation : Operation Controller

  • profile : Profile Controller

  • rule : Rule Controller

  • securityProfile : Security Profile Controller

  • tenants : Tenant Controller

  • unit-controller : Unit Controller

1.6. Produit

  • application/json

2. Ressources

2.1. Accesscontract

Access Contract Controller

2.1.1. Create entity

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

Body

accessContractDto
requis

accessContractDto

AccessContractDto

Réponses
Code HTTP Description Schéma

201

Created

AccessContractDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential-api/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 201
{
  "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. Get entities paginated

GET /referential-api/accesscontract
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«AccessContractDto»

Exemple de requête HTTP
Requête path
/referential-api/accesscontract
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" : [ {
    "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. Check ability to create entity

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

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-api/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. Get access contract by ID

GET /referential-api/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-api/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 entity

PATCH /referential-api/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-api/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. get history by accessContract’s id

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

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

LogbookOperationsResponseDto

Exemple de requête HTTP
Requête path
/referential-api/accesscontract/string/history
Exemple de réponse HTTP
Réponse 200
{
  "$hits" : {
    "limit" : 0,
    "offset" : 0,
    "size" : 0,
    "total" : 0
  },
  "$results" : [ {
    "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. Accession-register

Accession Register Controller

2.2.1. Get entity

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

Query

criteria
optionnel

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

< AccessionRegisterSummaryDto > array

Exemple de requête HTTP
Requête path
/referential-api/accession-register
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

Agency Controller

2.3.1. Create agency

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

Body

agencyDto
requis

agencyDto

AgencyDto

Réponses
Code HTTP Description Schéma

201

Created

AgencyDto

Consomme
  • application/json

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

2.3.2. Get entities paginated

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

Exemple de requête HTTP
Requête path
/referential-api/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. Check ability to create agency

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

Body

agencyDto
requis

agencyDto

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-api/agency/check
Requête body
{
  "Identifier" : "string"
}

2.3.4. get exported csv for agencies

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

200

OK

Resource

Exemple de requête HTTP
Requête path
/referential-api/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. import an agency file

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

Body

file
optionnel

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-api/agency/import

2.3.6. Get agency by ID

GET /referential-api/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-api/agency/string
Exemple de réponse HTTP
Réponse 200
{
  "Identifier" : "string"
}

2.3.7. delete agency

DELETE /referential-api/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-api/agency/string

2.3.8. Patch entity

PATCH /referential-api/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-api/agency/string
Exemple de réponse HTTP
Réponse 200
{
  "Identifier" : "string"
}

2.3.9. get history by agency’s id

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

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

LogbookOperationsResponseDto

Exemple de requête HTTP
Requête path
/referential-api/agency/string/history
Exemple de réponse HTTP
Réponse 200
{
  "$hits" : {
    "limit" : 0,
    "offset" : 0,
    "size" : 0,
    "total" : 0
  },
  "$results" : [ {
    "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.4. Context

Context Controller

2.4.1. Create context

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

Body

contextDto
requis

contextDto

ContextDto

Réponses
Code HTTP Description Schéma

201

Created

ContextDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential-api/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 201
{
  "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. Get entity

GET /referential-api/context
Paramètres
Type Nom Description Schéma

Query

criteria
optionnel

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

< ContextDto > array

Exemple de requête HTTP
Requête path
/referential-api/context
Requête query
{
  "criteria" : "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.3. Check ability to create context

POST /referential-api/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-api/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. Get context by ID

GET /referential-api/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-api/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 entity

PATCH /referential-api/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-api/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. get history by context’s id

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

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

LogbookOperationsResponseDto

Exemple de requête HTTP
Requête path
/referential-api/context/string/history
Exemple de réponse HTTP
Réponse 200
{
  "$hits" : {
    "limit" : 0,
    "offset" : 0,
    "size" : 0,
    "total" : 0
  },
  "$results" : [ {
    "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.5. Customers

Customer Controller

2.5.1. Get all customers

GET /referential-api/customers
Paramètres
Type Nom Description Schéma

Query

criteria
optionnel

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

< CustomerDto > array

Exemple de requête HTTP
Requête path
/referential-api/customers
Requête query
{
  "criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "defaultEmailDomain" : "string",
  "emailDomains" : [ "string" ],
  "enabled" : true,
  "gdprAlert" : true,
  "gdprAlertDelay" : 0,
  "hasCustomGraphicIdentity" : true,
  "id" : "string",
  "identifier" : "string",
  "internalCode" : "string",
  "language" : "string",
  "name" : "string",
  "otp" : "string",
  "owners" : [ {
    "address" : {
      "city" : "string",
      "country" : "string",
      "street" : "string",
      "zipCode" : "string"
    },
    "code" : "string",
    "companyName" : "string",
    "customerId" : "string",
    "id" : "string",
    "identifier" : "string",
    "internalCode" : "string",
    "name" : "string",
    "readonly" : true
  } ],
  "passwordRevocationDelay" : 0,
  "portalMessage" : "string",
  "portalTitle" : "string",
  "readonly" : true,
  "subrogeable" : true,
  "themeColors" : {
    "string" : "string"
  }
} ]

2.6. Fileformat

File Format Controller

2.6.1. Create file format

POST /referential-api/fileformat
Paramètres
Type Nom Description Schéma

Body

fileformatDto
requis

fileformatDto

FileFormatDto

Réponses
Code HTTP Description Schéma

201

Created

FileFormatDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential-api/fileformat
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 201
{
  "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.6.2. Get entities paginated

GET /referential-api/fileformat
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«FileFormatDto»

Exemple de requête HTTP
Requête path
/referential-api/fileformat
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.6.3. Check ability to create file format

POST /referential-api/fileformat/check
Paramètres
Type Nom Description Schéma

Body

fileformatDto
requis

fileformatDto

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-api/fileformat/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.6.4. get exported csv for file formats

GET /referential-api/fileformat/export
Réponses
Code HTTP Description Schéma

200

OK

Resource

Exemple de requête HTTP
Requête path
/referential-api/fileformat/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.6.5. import a file format xml file

POST /referential-api/fileformat/import
Paramètres
Type Nom Description Schéma

Body

file
optionnel

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-api/fileformat/import

2.6.6. Get file format by ID

GET /referential-api/fileformat/{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-api/fileformat/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.6.7. delete file format

DELETE /referential-api/fileformat/{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-api/fileformat/string

2.6.8. Patch entity

PATCH /referential-api/fileformat/{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-api/fileformat/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.6.9. get history by file format’s id

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

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

LogbookOperationsResponseDto

Exemple de requête HTTP
Requête path
/referential-api/fileformat/string/history
Exemple de réponse HTTP
Réponse 200
{
  "$hits" : {
    "limit" : 0,
    "offset" : 0,
    "size" : 0,
    "total" : 0
  },
  "$results" : [ {
    "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.7. Ingestcontract

Ingest Contract Controller

2.7.1. Create entity

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

Body

ingestContractDto
requis

ingestContractDto

IngestContractDto

Réponses
Code HTTP Description Schéma

201

Created

IngestContractDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential-api/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 201
{
  "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.7.2. Get entity

GET /referential-api/ingestcontract
Paramètres
Type Nom Description Schéma

Query

criteria
optionnel

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

< IngestContractDto > array

Exemple de requête HTTP
Requête path
/referential-api/ingestcontract
Requête query
{
  "criteria" : "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.7.3. Check ability to create entity

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

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-api/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.7.4. Get ingest contract by ID

GET /referential-api/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-api/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.7.5. Patch entity

PATCH /referential-api/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-api/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.7.6. get history by ingestContract’s id

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

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

LogbookOperationsResponseDto

Exemple de requête HTTP
Requête path
/referential-api/ingestcontract/string/history
Exemple de réponse HTTP
Réponse 200
{
  "$hits" : {
    "limit" : 0,
    "offset" : 0,
    "size" : 0,
    "total" : 0
  },
  "$results" : [ {
    "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.8. Managementcontract

Management Contract Controller

2.8.1. Get entity

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

Query

criteria
optionnel

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

< ManagementContractDto > array

Exemple de requête HTTP
Requête path
/referential-api/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.9. Ontology

Ontology Controller

2.9.1. Create ontology

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

Body

ontologyDto
requis

ontologyDto

OntologyDto

Réponses
Code HTTP Description Schéma

201

Created

OntologyDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential-api/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 201
{
  "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.9.2. Get entity

GET /referential-api/ontology
Paramètres
Type Nom Description Schéma

Query

criteria
optionnel

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

< OntologyDto > array

Exemple de requête HTTP
Requête path
/referential-api/ontology
Requête query
{
  "criteria" : "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.9.3. Check ability to create ontology

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

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-api/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.9.4. import an ontology file

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

Body

file
optionnel

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-api/ontology/import

2.9.5. Get ingest contract by ID

GET /referential-api/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-api/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.9.6. delete ontology

DELETE /referential-api/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-api/ontology/string

2.9.7. Patch entity

PATCH /referential-api/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-api/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.9.8. get history by ontology’s id

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

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

LogbookOperationsResponseDto

Exemple de requête HTTP
Requête path
/referential-api/ontology/string/history
Exemple de réponse HTTP
Réponse 200
{
  "$hits" : {
    "limit" : 0,
    "offset" : 0,
    "size" : 0,
    "total" : 0
  },
  "$results" : [ {
    "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.10. Operation

Operation Controller

2.10.1. Create audit

POST /referential-api/operation
Paramètres
Type Nom Description Schéma

Body

auditOptions
requis

auditOptions

AuditOptions

Réponses
Code HTTP Description Schéma

201

Created

boolean

Consomme
  • application/json

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

2.10.2. Get entity

GET /referential-api/operation
Paramètres
Type Nom Description Schéma

Query

criteria
optionnel

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

< LogbookOperationDto0 > array

Exemple de requête HTTP
Requête path
/referential-api/operation
Requête query
{
  "criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
  "agId" : "string",
  "agIdApp" : "string",
  "agIdExt" : "string",
  "collectionName" : "string",
  "data" : "string",
  "dateTime" : "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",
  "idAppSession" : "string",
  "idRequest" : "string",
  "objectId" : "string",
  "outDetail" : "string",
  "outMessage" : "string",
  "outcome" : "string",
  "parentId" : "string",
  "rightsStatementIdentifier" : "string",
  "type" : "string",
  "typeProc" : "string"
} ]

2.10.3. check traceability operation

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

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

LogbookOperationsResponseDto

Exemple de requête HTTP
Requête path
/referential-api/operation/check/string
Exemple de réponse HTTP
Réponse 200
{
  "$hits" : {
    "limit" : 0,
    "offset" : 0,
    "size" : 0,
    "total" : 0
  },
  "$results" : [ {
    "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.10.4. run probative value operation

POST /referential-api/operation/probativeValue
Paramètres
Type Nom Description Schéma

Body

probativeValueOptions
requis

probativeValueOptions

ProbativeValueRequest

Réponses
Code HTTP Description Schéma

200

OK

boolean

Consomme
  • application/json

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

2.10.5. Export probative value as zip

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

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

Resource

Exemple de requête HTTP
Requête path
/referential-api/operation/probativeValue/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.10.6. extract information from timestamp

POST /referential-api/operation/timestamp
Paramètres
Type Nom Description Schéma

Body

timestamp
requis

timestamp

string

Réponses
Code HTTP Description Schéma

200

OK

ObjectNode

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential-api/operation/timestamp

2.10.7. export operation by id

GET /referential-api/operation/{id}/download/{type}
Paramètres
Type Nom Description Schéma

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-api/operation/string/download/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.10.8. get history by operation’s id

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

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

LogbookOperationsResponseDto

Exemple de requête HTTP
Requête path
/referential-api/operation/string/history
Exemple de réponse HTTP
Réponse 200
{
  "$hits" : {
    "limit" : 0,
    "offset" : 0,
    "size" : 0,
    "total" : 0
  },
  "$results" : [ {
    "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.11. Profile

Profile Controller

2.11.1. Get entity

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

Query

criteria
optionnel

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

< ProfileDto > array

Exemple de requête HTTP
Requête path
/referential-api/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.12. Rule

Rule Controller

2.12.1. Create rule

POST /referential-api/rule
Paramètres
Type Nom Description Schéma

Body

ruleDto
requis

ruleDto

RuleDto

Réponses
Code HTTP Description Schéma

201

Created

RuleDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential-api/rule
Requête body
{
  "EndDate" : "string",
  "Rule" : "string",
  "StartDate" : "string"
}
Exemple de réponse HTTP
Réponse 201
{
  "EndDate" : "string",
  "Rule" : "string",
  "StartDate" : "string"
}

2.12.2. Get entities paginated

GET /referential-api/rule
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«RuleDto»

Exemple de requête HTTP
Requête path
/referential-api/rule
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.12.3. Check ability to create rule

POST /referential-api/rule/check
Paramètres
Type Nom Description Schéma

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-api/rule/check
Requête body
{
  "EndDate" : "string",
  "Rule" : "string",
  "StartDate" : "string"
}

2.12.4. get exported csv for rules

GET /referential-api/rule/export
Réponses
Code HTTP Description Schéma

200

OK

Resource

Exemple de requête HTTP
Requête path
/referential-api/rule/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.12.5. Get rule by ID

GET /referential-api/rule/{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-api/rule/string
Exemple de réponse HTTP
Réponse 200
{
  "EndDate" : "string",
  "Rule" : "string",
  "StartDate" : "string"
}

2.12.6. delete rule

DELETE /referential-api/rule/{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-api/rule/string

2.12.7. Patch entity

PATCH /referential-api/rule/{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-api/rule/string
Exemple de réponse HTTP
Réponse 200
{
  "EndDate" : "string",
  "Rule" : "string",
  "StartDate" : "string"
}

2.12.8. get history by rule’s id

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

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

LogbookOperationsResponseDto

Exemple de requête HTTP
Requête path
/referential-api/rule/string/history
Exemple de réponse HTTP
Réponse 200
{
  "$hits" : {
    "limit" : 0,
    "offset" : 0,
    "size" : 0,
    "total" : 0
  },
  "$results" : [ {
    "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.13. SecurityProfile

Security Profile Controller

2.13.1. Create securityProfile

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

Body

securityProfileDto
requis

securityProfileDto

SecurityProfileDto

Réponses
Code HTTP Description Schéma

201

Created

SecurityProfileDto

Consomme
  • application/json

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

2.13.2. Get entity

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

Query

criteria
optionnel

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

< SecurityProfileDto > array

Exemple de requête HTTP
Requête path
/referential-api/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.13.3. Check ability to create securityProfile

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

Body

securityProfileDto
requis

securityProfileDto

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-api/security-profile/check
Requête body
{
  "fullAccess" : true,
  "id" : "string",
  "identifier" : "string",
  "name" : "string",
  "permissions" : [ "string" ]
}

2.13.4. Get agency by ID

GET /referential-api/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-api/security-profile/string
Exemple de réponse HTTP
Réponse 200
{
  "fullAccess" : true,
  "id" : "string",
  "identifier" : "string",
  "name" : "string",
  "permissions" : [ "string" ]
}

2.13.5. delete securityProfile

DELETE /referential-api/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-api/security-profile/string

2.13.6. Patch entity

PATCH /referential-api/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-api/security-profile/string
Exemple de réponse HTTP
Réponse 200
{
  "fullAccess" : true,
  "id" : "string",
  "identifier" : "string",
  "name" : "string",
  "permissions" : [ "string" ]
}

2.13.7. get history by securityProfile’s id

GET /referential-api/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

LogbookOperationsResponseDto

Exemple de requête HTTP
Requête path
/referential-api/security-profile/string/history
Exemple de réponse HTTP
Réponse 200
{
  "$hits" : {
    "limit" : 0,
    "offset" : 0,
    "size" : 0,
    "total" : 0
  },
  "$results" : [ {
    "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.14. Tenants

Tenant Controller

2.14.1. Get all entities

GET /referential-api/tenants
Paramètres
Type Nom Description Schéma

Query

criteria
optionnel

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

< TenantDto > array

Exemple de requête HTTP
Requête path
/referential-api/tenants
Requête query
{
  "criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
  "accessContractHoldingIdentifier" : "string",
  "accessContractLogbookIdentifier" : "string",
  "customerId" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : 0,
  "ingestContractHoldingIdentifier" : "string",
  "itemIngestContractIdentifier" : "string",
  "name" : "string",
  "ownerId" : "string",
  "proof" : true,
  "readonly" : true
} ]

2.15. Unit-controller

Unit Controller

2.15.1. Get filing plan

GET /referential-api/search/filingplan
Réponses
Code HTTP Description Schéma

200

OK

VitamUISearchResponseDto

Exemple de requête HTTP
Requête path
/referential-api/search/filingplan
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.15.2. find units by custom dsl

POST /referential-api/search/units/dsl
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Body

dsl
requis

dsl

JsonNode

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential-api/search/units/dsl

2.15.3. find units by custom dsl

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

Path

id
requis

id

string

Body

dsl
requis

dsl

JsonNode

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential-api/search/units/dsl/string

2.15.4. search unit by id

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

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

VitamUISearchResponseDto

Exemple de requête HTTP
Requête path
/referential-api/search/units/string
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.15.5. find unit objects by custom dsl

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

Path

id
requis

id

string

Body

dsl
requis

dsl

JsonNode

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/referential-api/search/units/string/objects

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

Nom Description Schéma

city
optionnel

Exemple : "string"

string

country
optionnel

Exemple : "string"

string

street
optionnel

Exemple : "string"

string

zipCode
optionnel

Exemple : "string"

string

3.4. AgencyDto

Nom Description Schéma

Identifier
optionnel

Exemple : "string"

string

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

Nom Description Schéma

address
optionnel

Exemple : "AddressDto"

AddressDto

code
optionnel

Exemple : "string"

string

companyName
optionnel

Exemple : "string"

string

defaultEmailDomain
optionnel

Exemple : "string"

string

emailDomains
optionnel

Exemple : [ "string" ]

< string > array

enabled
optionnel

Exemple : true

boolean

gdprAlert
optionnel

Exemple : true

boolean

gdprAlertDelay
optionnel

Exemple : 0

integer (int32)

hasCustomGraphicIdentity
optionnel

Exemple : true

boolean

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

internalCode
optionnel

Exemple : "string"

string

language
optionnel

Exemple : "string"

enum (ENGLISH, FRENCH, GERMANY)

name
optionnel

Exemple : "string"

string

otp
optionnel

Exemple : "string"

enum (DISABLED, MANDATORY, OPTIONAL)

owners
optionnel

Exemple : [ "OwnerDto" ]

< OwnerDto > array

passwordRevocationDelay
optionnel

Exemple : 0

integer (int32)

portalMessage
optionnel

Exemple : "string"

string

portalTitle
optionnel

Exemple : "string"

string

readonly
optionnel

Exemple : true

boolean

subrogeable
optionnel

Exemple : true

boolean

themeColors
optionnel

Exemple : {
"string" : "string"
}

< string, string > map

3.8. FacetBucketDto

Nom Description Schéma

count
optionnel

Exemple : 0

integer (int64)

value
optionnel

Exemple : "string"

string

3.9. FacetResultsDto

Nom Description Schéma

buckets
optionnel

Exemple : [ "FacetBucketDto" ]

< FacetBucketDto > array

name
optionnel

Exemple : "string"

string

3.10. FieldsDto

Nom Description Schéma

Description
optionnel

Exemple : 0

integer (int32)

Title
optionnel

Exemple : 0

integer (int32)

3.11. 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.12. 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.13. 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.14. FilterDto

Nom Description Schéma

$limit
optionnel

Exemple : 0

integer (int32)

$orderby
optionnel

Exemple : "OrderbyDto"

OrderbyDto

3.15. 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.16. 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.17. 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.18. InheritedPropertyDto

Nom Description Schéma

PropertyName
optionnel

Exemple : "string"

string

PropertyValue
optionnel

Exemple : "object"

object

3.19. InheritedRuleCategoryDto

Nom Description Schéma

Properties
optionnel

Exemple : [ "InheritedPropertyDto" ]

< InheritedPropertyDto > array

Rules
optionnel

Exemple : [ "RuleDto" ]

< RuleDto > array

3.20. InheritedRulesDto

Nom Description Schéma

AppraisalRule
optionnel

Exemple : "InheritedRuleCategoryDto"

InheritedRuleCategoryDto

3.21. InputStream

Type : object

3.22. JsonNode

Type : object

3.23. KeywordDto

Nom Description Schéma

KeywordContent
optionnel

Exemple : "string"

string

KeywordReference
optionnel

Exemple : "string"

string

3.24. 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.25. LogbookEventDto0

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.26. 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.27. LogbookOperationDto0

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.28. LogbookOperationsResponseDto

Nom Description Schéma

$hits
optionnel

Exemple : "HitsDto"

HitsDto

$results
optionnel

Exemple : [ "LogbookOperationDto" ]

< LogbookOperationDto > array

3.29. 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.30. ManagementDto

Nom Description Schéma

AppraisalRule
optionnel

Exemple : "RuleCategoryDto"

RuleCategoryDto

3.31. MeasurementModel

Nom Description Schéma

dValue
optionnel

Exemple : 0.0

number

dvalue
optionnel

Exemple : 0.0

number

unit
optionnel

Exemple : "string"

string

3.32. 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.33. ObjectNode

Type : object

3.34. 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.35. OrderbyDto

Nom Description Schéma

TransactedDate
optionnel

Exemple : 0

integer (int32)

3.36. OwnerDto

Nom Description Schéma

address
optionnel

Exemple : "AddressDto"

AddressDto

code
optionnel

Exemple : "string"

string

companyName
optionnel

Exemple : "string"

string

customerId
optionnel

Exemple : "string"

string

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

internalCode
optionnel

Exemple : "string"

string

name
optionnel

Exemple : "string"

string

readonly
optionnel

Exemple : true

boolean

3.37. 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.38. 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.39. 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.40. 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.41. 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.42. 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 : [ "LogbookOperationDto0" ]

< LogbookOperationDto0 > array

3.43. 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.44. 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.45. 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.46. PermissionDto

Nom Description Schéma

accessContracts
optionnel

Exemple : [ "string" ]

< string > array

ingestContracts
optionnel

Exemple : [ "string" ]

< string > array

tenant
optionnel

Exemple : "string"

string

3.47. 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.48. ProbativeValueRequest

Nom Description Schéma

dslQuery
optionnel

Exemple : "JsonNode"

JsonNode

usage
optionnel

Exemple : "string"

string

version
optionnel

Exemple : "string"

string

3.49. 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.50. ProjectionDto

Nom Description Schéma

$fields
optionnel

Exemple : "FieldsDto"

FieldsDto

3.51. QualifiersDto

Nom Description Schéma

qualifier
optionnel

Exemple : "string"

string

versions
optionnel

Exemple : [ "VersionsDto" ]

< VersionsDto > array

3.52. 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.53. 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.54. QueryProjection

Nom Description Schéma

$fields
optionnel

Exemple : {
"string" : 0
}

< string, integer (int32) > map

3.55. RegisterValueDetailModel

Nom Description Schéma

deleted
optionnel

Exemple : 0

integer (int64)

ingested
optionnel

Exemple : 0

integer (int64)

remained
optionnel

Exemple : 0

integer (int64)

3.56. 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.57. 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.58. RuleCategoryDto

Nom Description Schéma

FinalAction
optionnel

Exemple : "string"

string

Rules
optionnel

Exemple : [ "RuleDto" ]

< RuleDto > array

3.59. RuleDto

Nom Description Schéma

EndDate
optionnel

Exemple : "string"

string

Rule
optionnel

Exemple : "string"

string

StartDate
optionnel

Exemple : "string"

string

3.60. 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.61. StorageDto

Nom Description Schéma

strategyId
optionnel

Exemple : "string"

string

3.62. StorageJson

Nom Description Schéma

#nbc
optionnel

Exemple : "string"

string

offerIds
optionnel

Exemple : [ "string" ]

< string > array

strategyId
optionnel

Exemple : "string"

string

3.63. TenantDto

Nom Description Schéma

accessContractHoldingIdentifier
optionnel

Exemple : "string"

string

accessContractLogbookIdentifier
optionnel

Exemple : "string"

string

customerId
optionnel

Exemple : "string"

string

enabled
optionnel

Exemple : true

boolean

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : 0

integer (int32)

ingestContractHoldingIdentifier
optionnel

Exemple : "string"

string

itemIngestContractIdentifier
optionnel

Exemple : "string"

string

name
optionnel

Exemple : "string"

string

ownerId
optionnel

Exemple : "string"

string

proof
optionnel

Exemple : true

boolean

readonly
optionnel

Exemple : true

boolean

3.64. TitleDto

Nom Description Schéma

en
optionnel

Exemple : "string"

string

fr
optionnel

Exemple : "string"

string

3.65. 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.66. 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.67. 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.68. VtagDto

Nom Description Schéma

Key
optionnel

Exemple : [ "string" ]

< string > array

Value
optionnel

Exemple : [ "string" ]

< string > array

3.69. XtagDto

Nom Description Schéma

Key
optionnel

Exemple : [ "string" ]

< string > array

Value
optionnel

Exemple : [ "string" ]

< string > array