1. Vue générale
DESCRIPTION HERE.
1.1. Information de version
Version : v1
1.2. Information de contact
Contact : Direction de la diffusion et des partenariats
Email de contact : contact@programmevitam.fr
1.3. Information de licence
Licence : License to be defined …
Licence URL : URL not defined.
Conditions de service : Terms of service
1.4. Schéma d’URI
Serveur : localhost
Chemin de base : /
1.5. Tags
-
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 |
accessContractDto |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
201 |
Created |
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 |
criteria |
string |
Query |
direction |
direction |
enum (ASC, DESC) |
Query |
orderBy |
orderBy |
string |
Query |
page |
page |
string |
Query |
size |
size |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Exemple de requête HTTP
Requête path
/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 |
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 |
identifier |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
id |
string |
Body |
partialDto |
partialDto |
object |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Consomme
-
application/json
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 |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
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 |
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 |
criteria |
string |
Query |
direction |
direction |
enum (ASC, DESC) |
Query |
orderBy |
orderBy |
string |
Query |
page |
page |
string |
Query |
size |
size |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Exemple de requête HTTP
Requête path
/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 |
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
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 |
file |
string (binary) |
Consomme
-
multipart/form-data
2.3.6. Get agency by ID
GET /referential-api/agency/{identifier}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Path |
identifier |
identifier |
string |
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 |
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 |
id |
string |
Body |
partialDto |
partialDto |
object |
Consomme
-
application/json
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 |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
contextDto |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
201 |
Created |
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 |
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 |
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 |
identifier |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
id |
string |
Body |
partialDto |
partialDto |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
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 |
fileformatDto |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
201 |
Created |
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 |
criteria |
string |
Query |
direction |
direction |
enum (ASC, DESC) |
Query |
orderBy |
orderBy |
string |
Query |
page |
page |
string |
Query |
size |
size |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Exemple de requête HTTP
Requête path
/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 |
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
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 |
file |
string (binary) |
Consomme
-
multipart/form-data
2.6.6. Get file format by ID
GET /referential-api/fileformat/{identifier}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Path |
identifier |
identifier |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
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 |
id |
string |
Body |
partialDto |
partialDto |
object |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Consomme
-
application/json
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 |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
ingestContractDto |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
201 |
Created |
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 |
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 |
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 |
identifier |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
id |
string |
Body |
partialDto |
partialDto |
object |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Consomme
-
application/json
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 |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
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 |
ontologyDto |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
201 |
Created |
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 |
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 |
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 |
file |
string (binary) |
Consomme
-
multipart/form-data
2.9.5. Get ingest contract by ID
GET /referential-api/ontology/{identifier}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Path |
identifier |
identifier |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
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 |
id |
string |
Body |
partialDto |
partialDto |
object |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Consomme
-
application/json
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 |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
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 |
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 |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
probativeValueOptions |
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 |
id |
string |
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 |
timestamp |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Consomme
-
application/json
2.10.7. export operation by id
GET /referential-api/operation/{id}/download/{type}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Path |
id |
id |
string |
Path |
type |
type |
enum (AUDIT, PROBATIVE_VALUE, TRACEABILITY) |
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 |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
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 |
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 |
criteria |
string |
Query |
direction |
direction |
enum (ASC, DESC) |
Query |
orderBy |
orderBy |
string |
Query |
page |
page |
string |
Query |
size |
size |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Exemple de requête HTTP
Requête path
/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 |
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
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 |
identifier |
string |
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 |
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 |
id |
string |
Body |
partialDto |
partialDto |
object |
Consomme
-
application/json
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 |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
securityProfileDto |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
201 |
Created |
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 |
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 |
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 |
identifier |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
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 |
id |
string |
Body |
partialDto |
partialDto |
object |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Consomme
-
application/json
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 |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
criteria |
string |
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 |
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 |
id |
string |
Body |
dsl |
dsl |
Consomme
-
application/json
2.15.3. find units by custom dsl
POST /referential-api/search/units/dsl/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Path |
id |
id |
string |
Body |
dsl |
dsl |
Consomme
-
application/json
2.15.4. search unit by id
GET /referential-api/search/units/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Path |
id |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Exemple de requête HTTP
Requête path
/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 |
id |
string |
Body |
dsl |
dsl |
Consomme
-
application/json
3. Définitions
3.1. AccessContractDto
Nom | Description | Schéma |
---|---|---|
accessLog |
Exemple : |
string |
activationDate |
Exemple : |
string |
creationDate |
Exemple : |
string |
dataObjectVersion |
Exemple : |
< string > array |
deactivationDate |
Exemple : |
string |
description |
Exemple : |
string |
everyDataObjectVersion |
Exemple : |
boolean |
everyOriginatingAgency |
Exemple : |
boolean |
excludedRootUnits |
Exemple : |
< string > array |
id |
Exemple : |
string |
identifier |
Exemple : |
string |
lastUpdate |
Exemple : |
string |
name |
Exemple : |
string |
originatingAgencies |
Exemple : |
< string > array |
rootUnits |
Exemple : |
< string > array |
ruleCategoryToFilter |
Exemple : |
< string > array |
status |
Exemple : |
string |
tenant |
Exemple : |
integer (int32) |
version |
Exemple : |
integer (int32) |
writingPermission |
Exemple : |
boolean |
writingRestrictedDesc |
Exemple : |
boolean |
3.2. AccessionRegisterSummaryDto
Nom | Description | Schéma |
---|---|---|
creationDate |
Exemple : |
string |
id |
Exemple : |
string |
objectSize |
Exemple : |
|
originatingAgency |
Exemple : |
string |
tenant |
Exemple : |
integer (int32) |
totalObjects |
Exemple : |
|
totalObjectsGroups |
Exemple : |
|
totalUnits |
Exemple : |
|
version |
Exemple : |
integer (int32) |
3.3. AddressDto
Nom | Description | Schéma |
---|---|---|
city |
Exemple : |
string |
country |
Exemple : |
string |
street |
Exemple : |
string |
zipCode |
Exemple : |
string |
3.4. AgencyDto
Nom | Description | Schéma |
---|---|---|
Identifier |
Exemple : |
string |
3.5. AuditOptions
Nom | Description | Schéma |
---|---|---|
auditActions |
Exemple : |
string |
auditType |
Exemple : |
string |
objectId |
Exemple : |
string |
query |
Exemple : |
3.6. ContextDto
Nom | Description | Schéma |
---|---|---|
activationDate |
Exemple : |
string |
creationDate |
Exemple : |
string |
deactivationDate |
Exemple : |
string |
enableControl |
Exemple : |
boolean |
id |
Exemple : |
string |
identifier |
Exemple : |
string |
lastUpdate |
Exemple : |
string |
name |
Exemple : |
string |
permissions |
Exemple : |
< PermissionDto > array |
securityProfile |
Exemple : |
string |
status |
Exemple : |
string |
3.7. CustomerDto
Nom | Description | Schéma |
---|---|---|
address |
Exemple : |
|
code |
Exemple : |
string |
companyName |
Exemple : |
string |
defaultEmailDomain |
Exemple : |
string |
emailDomains |
Exemple : |
< string > array |
enabled |
Exemple : |
boolean |
gdprAlert |
Exemple : |
boolean |
gdprAlertDelay |
Exemple : |
integer (int32) |
hasCustomGraphicIdentity |
Exemple : |
boolean |
id |
Exemple : |
string |
identifier |
Exemple : |
string |
internalCode |
Exemple : |
string |
language |
Exemple : |
enum (ENGLISH, FRENCH, GERMANY) |
name |
Exemple : |
string |
otp |
Exemple : |
enum (DISABLED, MANDATORY, OPTIONAL) |
owners |
Exemple : |
< OwnerDto > array |
passwordRevocationDelay |
Exemple : |
integer (int32) |
portalMessage |
Exemple : |
string |
portalTitle |
Exemple : |
string |
readonly |
Exemple : |
boolean |
subrogeable |
Exemple : |
boolean |
themeColors |
Exemple : |
< string, string > map |
3.8. FacetBucketDto
Nom | Description | Schéma |
---|---|---|
count |
Exemple : |
integer (int64) |
value |
Exemple : |
string |
3.9. FacetResultsDto
Nom | Description | Schéma |
---|---|---|
buckets |
Exemple : |
< FacetBucketDto > array |
name |
Exemple : |
string |
3.10. FieldsDto
Nom | Description | Schéma |
---|---|---|
Description |
Exemple : |
integer (int32) |
Title |
Exemple : |
integer (int32) |
3.11. FileFormatDto
Nom | Description | Schéma |
---|---|---|
alert |
Exemple : |
boolean |
comment |
Exemple : |
string |
createdDate |
Exemple : |
string |
documentVersion |
Exemple : |
integer (int32) |
extensions |
Exemple : |
< string > array |
group |
Exemple : |
string |
hasPriorityOverFileFormatIDs |
Exemple : |
< string > array |
id |
Exemple : |
string |
mimeType |
Exemple : |
string |
name |
Exemple : |
string |
puid |
Exemple : |
string |
version |
Exemple : |
string |
versionPronom |
Exemple : |
string |
3.12. FileInfoDto
Nom | Description | Schéma |
---|---|---|
CreatingApplicationName |
Exemple : |
string |
CreatingApplicationVersion |
Exemple : |
string |
CreatingOs |
Exemple : |
string |
CreatingOsVersion |
Exemple : |
string |
DateCreatedByApplication |
Exemple : |
string |
Filename |
Exemple : |
string |
LastModified |
Exemple : |
string |
3.13. FileInfoModel
Nom | Description | Schéma |
---|---|---|
CreatingApplicationName |
Exemple : |
string |
CreatingApplicationVersion |
Exemple : |
string |
CreatingOs |
Exemple : |
string |
CreatingOsVersion |
Exemple : |
string |
DateCreatedByApplication |
Exemple : |
string |
Filename |
Exemple : |
string |
LastModified |
Exemple : |
string |
3.14. FilterDto
Nom | Description | Schéma |
---|---|---|
$limit |
Exemple : |
integer (int32) |
$orderby |
Exemple : |
3.15. FormatIdentificationModel
Nom | Description | Schéma |
---|---|---|
Encoding |
Exemple : |
string |
FormatId |
Exemple : |
string |
FormatLitteral |
Exemple : |
string |
MimeType |
Exemple : |
string |
3.16. HitsDto
Nom | Description | Schéma |
---|---|---|
limit |
Exemple : |
integer (int32) |
offset |
Exemple : |
integer (int32) |
size |
Exemple : |
integer (int32) |
total |
Exemple : |
integer (int32) |
3.17. IngestContractDto
Nom | Description | Schéma |
---|---|---|
activationDate |
Exemple : |
string |
archiveProfiles |
Exemple : |
< string > array |
checkParentId |
Exemple : |
< string > array |
checkParentLink |
Exemple : |
string |
creationDate |
Exemple : |
string |
dataObjectVersion |
Exemple : |
< string > array |
deactivationDate |
Exemple : |
string |
description |
Exemple : |
string |
everyDataObjectVersion |
Exemple : |
boolean |
everyFormatType |
Exemple : |
boolean |
formatType |
Exemple : |
< string > array |
formatUnidentifiedAuthorized |
Exemple : |
boolean |
id |
Exemple : |
string |
identifier |
Exemple : |
string |
lastUpdate |
Exemple : |
string |
linkParentId |
Exemple : |
string |
managementContractId |
Exemple : |
string |
masterMandatory |
Exemple : |
boolean |
name |
Exemple : |
string |
status |
Exemple : |
enum (ACTIVE, INACTIVE) |
tenant |
Exemple : |
integer (int32) |
version |
Exemple : |
integer (int32) |
3.18. InheritedPropertyDto
Nom | Description | Schéma |
---|---|---|
PropertyName |
Exemple : |
string |
PropertyValue |
Exemple : |
object |
3.19. InheritedRuleCategoryDto
Nom | Description | Schéma |
---|---|---|
Properties |
Exemple : |
< InheritedPropertyDto > array |
Rules |
Exemple : |
< RuleDto > array |
3.20. InheritedRulesDto
Nom | Description | Schéma |
---|---|---|
AppraisalRule |
Exemple : |
3.21. InputStream
Type : object
3.22. JsonNode
Type : object
3.23. KeywordDto
Nom | Description | Schéma |
---|---|---|
KeywordContent |
Exemple : |
string |
KeywordReference |
Exemple : |
string |
3.24. LogbookEventDto
Nom | Description | Schéma |
---|---|---|
agId |
Exemple : |
string |
agIdApp |
Exemple : |
string |
agIdExt |
Exemple : |
string |
evDateTime |
Exemple : |
string |
evDetData |
Exemple : |
string |
evId |
Exemple : |
string |
evIdAppSession |
Exemple : |
string |
evIdReq |
Exemple : |
string |
evParentId |
Exemple : |
string |
evType |
Exemple : |
string |
evTypeProc |
Exemple : |
string |
id |
Exemple : |
string |
obId |
Exemple : |
string |
obIdReq |
Exemple : |
string |
outDetail |
Exemple : |
string |
outMessg |
Exemple : |
string |
outcome |
Exemple : |
string |
rightsStatementIdentifier |
Exemple : |
string |
3.25. LogbookEventDto0
Nom | Description | Schéma |
---|---|---|
agId |
Exemple : |
string |
agIdApp |
Exemple : |
string |
agIdExt |
Exemple : |
string |
evDateTime |
Exemple : |
string |
evDetData |
Exemple : |
string |
evId |
Exemple : |
string |
evIdAppSession |
Exemple : |
string |
evIdReq |
Exemple : |
string |
evParentId |
Exemple : |
string |
evType |
Exemple : |
string |
evTypeProc |
Exemple : |
string |
id |
Exemple : |
string |
obId |
Exemple : |
string |
obIdReq |
Exemple : |
string |
outDetail |
Exemple : |
string |
outMessg |
Exemple : |
string |
outcome |
Exemple : |
string |
rightsStatementIdentifier |
Exemple : |
string |
3.26. LogbookOperationDto
Nom | Description | Schéma |
---|---|---|
agId |
Exemple : |
string |
agIdApp |
Exemple : |
string |
agIdExt |
Exemple : |
string |
evDateTime |
Exemple : |
string |
evDetData |
Exemple : |
string |
evId |
Exemple : |
string |
evIdAppSession |
Exemple : |
string |
evIdReq |
Exemple : |
string |
evParentId |
Exemple : |
string |
evType |
Exemple : |
string |
evTypeProc |
Exemple : |
string |
events |
Exemple : |
< LogbookEventDto > array |
id |
Exemple : |
string |
obId |
Exemple : |
string |
obIdIn |
Exemple : |
string |
obIdReq |
Exemple : |
string |
outDetail |
Exemple : |
string |
outMessg |
Exemple : |
string |
outcome |
Exemple : |
string |
rightsStatementIdentifier |
Exemple : |
string |
3.27. LogbookOperationDto0
Nom | Description | Schéma |
---|---|---|
agId |
Exemple : |
string |
agIdApp |
Exemple : |
string |
agIdExt |
Exemple : |
string |
collectionName |
Exemple : |
string |
data |
Exemple : |
string |
dateTime |
Exemple : |
string |
events |
Exemple : |
< LogbookEventDto > array |
id |
Exemple : |
string |
idAppSession |
Exemple : |
string |
idRequest |
Exemple : |
string |
objectId |
Exemple : |
string |
outDetail |
Exemple : |
string |
outMessage |
Exemple : |
string |
outcome |
Exemple : |
string |
parentId |
Exemple : |
string |
rightsStatementIdentifier |
Exemple : |
string |
type |
Exemple : |
string |
typeProc |
Exemple : |
string |
3.28. LogbookOperationsResponseDto
Nom | Description | Schéma |
---|---|---|
$hits |
Exemple : |
|
$results |
Exemple : |
< LogbookOperationDto > array |
3.29. ManagementContractDto
Nom | Description | Schéma |
---|---|---|
activationDate |
Exemple : |
string |
creationDate |
Exemple : |
string |
description |
Exemple : |
string |
id |
Exemple : |
string |
identifier |
Exemple : |
string |
lastUpdate |
Exemple : |
string |
name |
Exemple : |
string |
status |
Exemple : |
string |
storage |
Exemple : |
|
tenant |
Exemple : |
integer (int32) |
version |
Exemple : |
integer (int32) |
3.30. ManagementDto
Nom | Description | Schéma |
---|---|---|
AppraisalRule |
Exemple : |
3.31. MeasurementModel
Nom | Description | Schéma |
---|---|---|
dValue |
Exemple : |
number |
dvalue |
Exemple : |
number |
unit |
Exemple : |
string |
3.32. MetadataModel
Nom | Description | Schéma |
---|---|---|
Audio |
Exemple : |
object |
Document |
Exemple : |
object |
Image |
Exemple : |
object |
Text |
Exemple : |
object |
Video |
Exemple : |
object |
3.33. ObjectNode
Type : object
3.34. OntologyDto
Nom | Description | Schéma |
---|---|---|
apiField |
Exemple : |
string |
collections |
Exemple : |
< string > array |
creationDate |
Exemple : |
string |
description |
Exemple : |
string |
id |
Exemple : |
string |
identifier |
Exemple : |
string |
lastUpdate |
Exemple : |
string |
origin |
Exemple : |
enum (EXTERNAL, INTERNAL) |
sedaField |
Exemple : |
string |
shortName |
Exemple : |
string |
tenant |
Exemple : |
integer (int32) |
type |
Exemple : |
enum (BOOLEAN, DATE, DOUBLE, ENUM, GEO_POINT, KEYWORD, LONG, TEXT) |
version |
Exemple : |
integer (int32) |
3.35. OrderbyDto
Nom | Description | Schéma |
---|---|---|
TransactedDate |
Exemple : |
integer (int32) |
3.36. OwnerDto
Nom | Description | Schéma |
---|---|---|
address |
Exemple : |
|
code |
Exemple : |
string |
companyName |
Exemple : |
string |
customerId |
Exemple : |
string |
id |
Exemple : |
string |
identifier |
Exemple : |
string |
internalCode |
Exemple : |
string |
name |
Exemple : |
string |
readonly |
Exemple : |
boolean |
3.37. PaginatedValuesDto«AccessContractDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< AccessContractDto > array |
3.38. PaginatedValuesDto«AgencyDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< AgencyDto > array |
3.39. PaginatedValuesDto«ContextDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< ContextDto > array |
3.40. PaginatedValuesDto«FileFormatDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< FileFormatDto > array |
3.41. PaginatedValuesDto«IngestContractDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< IngestContractDto > array |
3.42. PaginatedValuesDto«LogbookOperationDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< LogbookOperationDto0 > array |
3.43. PaginatedValuesDto«OntologyDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< OntologyDto > array |
3.44. PaginatedValuesDto«RuleDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< RuleDto > array |
3.45. PaginatedValuesDto«SecurityProfileDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< SecurityProfileDto > array |
3.46. PermissionDto
Nom | Description | Schéma |
---|---|---|
accessContracts |
Exemple : |
< string > array |
ingestContracts |
Exemple : |
< string > array |
tenant |
Exemple : |
string |
3.47. PhysicalDimensionsModel
Nom | Description | Schéma |
---|---|---|
Depth |
Exemple : |
|
Diameter |
Exemple : |
|
Height |
Exemple : |
|
Length |
Exemple : |
|
NumberOfPage |
Exemple : |
integer (int32) |
Shape |
Exemple : |
string |
Thickness |
Exemple : |
|
Weight |
Exemple : |
|
Width |
Exemple : |
|
any |
Exemple : |
< object > array |
3.48. ProbativeValueRequest
Nom | Description | Schéma |
---|---|---|
dslQuery |
Exemple : |
|
usage |
Exemple : |
string |
version |
Exemple : |
string |
3.49. ProfileDto
Nom | Description | Schéma |
---|---|---|
activationdate |
Exemple : |
string |
creationdate |
Exemple : |
string |
deactivationdate |
Exemple : |
string |
description |
Exemple : |
string |
format |
Exemple : |
enum (RNG, XSD) |
id |
Exemple : |
string |
identifier |
Exemple : |
string |
lastupdate |
Exemple : |
string |
name |
Exemple : |
string |
path |
Exemple : |
string |
status |
Exemple : |
enum (ACTIVE, INACTIVE) |
tenant |
Exemple : |
integer (int32) |
version |
Exemple : |
integer (int32) |
3.50. ProjectionDto
Nom | Description | Schéma |
---|---|---|
$fields |
Exemple : |
3.51. QualifiersDto
Nom | Description | Schéma |
---|---|---|
qualifier |
Exemple : |
string |
versions |
Exemple : |
< VersionsDto > array |
3.52. QueryDTO
Nom | Description | Schéma |
---|---|---|
$filter |
Exemple : |
|
$projection |
Exemple : |
|
$query |
Exemple : |
< JsonNode > array |
$roots |
Exemple : |
< string > array |
3.53. QueryFilter
Nom | Description | Schéma |
---|---|---|
$limit |
Exemple : |
integer (int32) |
$offset |
Exemple : |
integer (int32) |
$orderby |
Exemple : |
< string, integer (int32) > map |
3.54. QueryProjection
Nom | Description | Schéma |
---|---|---|
$fields |
Exemple : |
< string, integer (int32) > map |
3.55. RegisterValueDetailModel
Nom | Description | Schéma |
---|---|---|
deleted |
Exemple : |
integer (int64) |
ingested |
Exemple : |
integer (int64) |
remained |
Exemple : |
integer (int64) |
3.56. Resource
Nom | Description | Schéma |
---|---|---|
description |
Exemple : |
string |
file |
Exemple : |
file |
filename |
Exemple : |
string |
inputStream |
Exemple : |
|
open |
Exemple : |
boolean |
readable |
Exemple : |
boolean |
uri |
Exemple : |
string (uri) |
url |
Exemple : |
string (url) |
3.57. ResultsDto
Nom | Description | Schéma |
---|---|---|
#allunitups |
Exemple : |
< string > array |
#id |
Exemple : |
string |
#management |
Exemple : |
|
#max |
Exemple : |
integer (int32) |
#min |
Exemple : |
integer (int32) |
#nbobjects |
Exemple : |
integer (int32) |
#nbunits |
Exemple : |
integer (int32) |
#object |
Exemple : |
string |
#operations |
Exemple : |
< string > array |
#opi |
Exemple : |
string |
#originating_agencies |
Exemple : |
< string > array |
#originating_agency |
Exemple : |
string |
#qualifiers |
Exemple : |
< QualifiersDto > array |
#storage |
Exemple : |
|
#tenant |
Exemple : |
integer (int32) |
#unitType |
Exemple : |
string |
#unitups |
Exemple : |
< string > array |
AcquiredDate |
Exemple : |
string |
CreatedDate |
Exemple : |
string |
Description |
Exemple : |
string |
DescriptionLevel |
Exemple : |
string |
DocumentType |
Exemple : |
string |
EndDate |
Exemple : |
string |
FileInfo |
Exemple : |
|
InheritedRules |
Exemple : |
|
Keyword |
Exemple : |
< KeywordDto > array |
OriginatingAgencyArchiveUnitIdentifier |
Exemple : |
< string > array |
OriginatingSystemId |
Exemple : |
< string > array |
PhysicalAgency |
Exemple : |
< string > array |
PhysicalStatus |
Exemple : |
< string > array |
PhysicalType |
Exemple : |
< string > array |
ReceivedDate |
Exemple : |
string |
RegisteredDate |
Exemple : |
string |
SentDate |
Exemple : |
string |
StartDate |
Exemple : |
string |
Status |
Exemple : |
string |
SubmissionAgency |
Exemple : |
|
Title |
Exemple : |
string |
Title_ |
Exemple : |
|
TransactedDate |
Exemple : |
string |
Version |
Exemple : |
string |
Vtag |
Exemple : |
< VtagDto > array |
Xtag |
Exemple : |
< XtagDto > array |
3.58. RuleCategoryDto
Nom | Description | Schéma |
---|---|---|
FinalAction |
Exemple : |
string |
Rules |
Exemple : |
< RuleDto > array |
3.59. RuleDto
Nom | Description | Schéma |
---|---|---|
EndDate |
Exemple : |
string |
Rule |
Exemple : |
string |
StartDate |
Exemple : |
string |
3.60. SecurityProfileDto
Nom | Description | Schéma |
---|---|---|
fullAccess |
Exemple : |
boolean |
id |
Exemple : |
string |
identifier |
Exemple : |
string |
name |
Exemple : |
string |
permissions |
Exemple : |
< string > array |
3.61. StorageDto
Nom | Description | Schéma |
---|---|---|
strategyId |
Exemple : |
string |
3.62. StorageJson
Nom | Description | Schéma |
---|---|---|
#nbc |
Exemple : |
string |
offerIds |
Exemple : |
< string > array |
strategyId |
Exemple : |
string |
3.63. TenantDto
Nom | Description | Schéma |
---|---|---|
accessContractHoldingIdentifier |
Exemple : |
string |
accessContractLogbookIdentifier |
Exemple : |
string |
customerId |
Exemple : |
string |
enabled |
Exemple : |
boolean |
id |
Exemple : |
string |
identifier |
Exemple : |
integer (int32) |
ingestContractHoldingIdentifier |
Exemple : |
string |
itemIngestContractIdentifier |
Exemple : |
string |
name |
Exemple : |
string |
ownerId |
Exemple : |
string |
proof |
Exemple : |
boolean |
readonly |
Exemple : |
boolean |
3.64. TitleDto
Nom | Description | Schéma |
---|---|---|
en |
Exemple : |
string |
fr |
Exemple : |
string |
3.65. VersionsDto
Nom | Description | Schéma |
---|---|---|
#id |
Exemple : |
string |
#rank |
Exemple : |
integer (int32) |
#storage |
Exemple : |
|
Algorithm |
Exemple : |
string |
DataObjectGroupId |
Exemple : |
string |
DataObjectVersion |
Exemple : |
string |
FileInfo |
Exemple : |
|
FormatIdentification |
Exemple : |
|
MessageDigest |
Exemple : |
string |
Metadata |
Exemple : |
|
OtherMetadata |
Exemple : |
object |
PhysicalDimensions |
Exemple : |
|
PhysicalId |
Exemple : |
string |
Size |
Exemple : |
integer (int32) |
Uri |
Exemple : |
string |
3.66. VitamSearchRequestDto
Nom | Description | Schéma |
---|---|---|
$filter |
Exemple : |
|
$projection |
Exemple : |
|
$query |
Exemple : |
< QueryDTO > array |
$roots |
Exemple : |
< string > array |
3.67. VitamUISearchResponseDto
Nom | Description | Schéma |
---|---|---|
$context |
Exemple : |
|
$facetResults |
Exemple : |
< FacetResultsDto > array |
$hits |
Exemple : |
|
$results |
Exemple : |
< ResultsDto > array |
3.68. VtagDto
Nom | Description | Schéma |
---|---|---|
Key |
Exemple : |
< string > array |
Value |
Exemple : |
< string > array |
3.69. XtagDto
Nom | Description | Schéma |
---|---|---|
Key |
Exemple : |
< string > array |
Value |
Exemple : |
< string > array |