1. Vue générale
Ces APIS sont utilisés pour configurer les référentiels
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
-
access-contract-external-controller-$-mockito-mock-$256293047 : Access Contract External Controller $ Mockito Mock $256293047
-
accession-register-external-controller-$-mockito-mock-$1519650442 : Accession Register External Controller $ Mockito Mock $1519650442
-
agency-external-controller-$-mockito-mock-$681029145 : Agency External Controller $ Mockito Mock $681029145
-
audit-external-controller-$-mockito-mock-$1846952360 : Audit External Controller $ Mockito Mock $1846952360
-
context-external-controller-$-mockito-mock-$2037785581 : Context External Controller $ Mockito Mock $2037785581
-
file-format-external-controller-$-mockito-mock-$991532179 : File Format External Controller $ Mockito Mock $991532179
-
ingest-contract-external-controller-$-mockito-mock-$1329802202 : Ingest Contract External Controller $ Mockito Mock $1329802202
-
ontology-external-controller-$-mockito-mock-$908508977 : Ontology External Controller $ Mockito Mock $908508977
-
security-profile-external-controller-$-mockito-mock-$66437044 : Security Profile External Controller $ Mockito Mock $66437044
-
status : Status check and autotest
1.6. Produit
-
application/json
2. Ressources
2.1. Access-contract-external-controller-$-mockito-mock-$256293047
Access Contract External Controller $ Mockito Mock $256293047
2.1.1. create
POST /referential/v1/accesscontract
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Body |
param0 |
param0 |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
201 |
Created |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/referential/v1/accesscontract
Requête header
"string"
Requête body
{
"accessLog" : "string",
"activationDate" : "string",
"creationDate" : "string",
"description" : "string",
"everyDataObjectVersion" : true,
"everyOriginatingAgency" : true,
"excludedRootUnits" : [ "string" ],
"id" : "string",
"identifier" : "string",
"lastUpdate" : "string",
"name" : "string",
"rootUnits" : [ "string" ],
"status" : "string",
"tenant" : 0,
"version" : 0,
"writingPermission" : true
}
Exemple de réponse HTTP
Réponse 201
{
"accessLog" : "string",
"activationDate" : "string",
"creationDate" : "string",
"description" : "string",
"everyDataObjectVersion" : true,
"everyOriginatingAgency" : true,
"excludedRootUnits" : [ "string" ],
"id" : "string",
"identifier" : "string",
"lastUpdate" : "string",
"name" : "string",
"rootUnits" : [ "string" ],
"status" : "string",
"tenant" : 0,
"version" : 0,
"writingPermission" : true
}
2.1.2. getAllPaginated
GET /referential/v1/accesscontract
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
page |
string |
|
Query |
param0 |
param0 |
integer (int32) |
Query |
param1 |
param1 |
integer (int32) |
Query |
param2 |
param2 |
string |
Query |
param3 |
param3 |
string |
Query |
param4 |
param4 |
enum (ASC, DESC) |
Query |
size |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/referential/v1/accesscontract
Requête header
"string"
Requête query
{
"page" : "string",
"param0" : 0,
"param1" : 0,
"param2" : "string",
"param3" : "string",
"param4" : "string",
"size" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
"hasMore" : true,
"pageNum" : 0,
"pageSize" : 0,
"values" : [ {
"accessLog" : "string",
"activationDate" : "string",
"creationDate" : "string",
"description" : "string",
"everyDataObjectVersion" : true,
"everyOriginatingAgency" : true,
"excludedRootUnits" : [ "string" ],
"id" : "string",
"identifier" : "string",
"lastUpdate" : "string",
"name" : "string",
"rootUnits" : [ "string" ],
"status" : "string",
"tenant" : 0,
"version" : 0,
"writingPermission" : true
} ]
}
2.1.3. check
POST /referential/v1/accesscontract/check
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
X-Tenant-Id |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Body |
param0 |
param0 |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/referential/v1/accesscontract/check
Requête header
"string"
Requête body
{
"accessLog" : "string",
"activationDate" : "string",
"creationDate" : "string",
"description" : "string",
"everyDataObjectVersion" : true,
"everyOriginatingAgency" : true,
"excludedRootUnits" : [ "string" ],
"id" : "string",
"identifier" : "string",
"lastUpdate" : "string",
"name" : "string",
"rootUnits" : [ "string" ],
"status" : "string",
"tenant" : 0,
"version" : 0,
"writingPermission" : true
}
2.1.4. patch
PATCH /referential/v1/accesscontract/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
id |
string |
Body |
param1 |
param1 |
object |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/referential/v1/accesscontract/string
Requête header
"string"
Requête body
{ }
Exemple de réponse HTTP
Réponse 200
{
"accessLog" : "string",
"activationDate" : "string",
"creationDate" : "string",
"description" : "string",
"everyDataObjectVersion" : true,
"everyOriginatingAgency" : true,
"excludedRootUnits" : [ "string" ],
"id" : "string",
"identifier" : "string",
"lastUpdate" : "string",
"name" : "string",
"rootUnits" : [ "string" ],
"status" : "string",
"tenant" : 0,
"version" : 0,
"writingPermission" : true
}
2.1.5. findHistoryById
GET /referential/v1/accesscontract/{id}/history
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/referential/v1/accesscontract/string/history
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
{
"array" : true,
"bigDecimal" : true,
"bigInteger" : true,
"binary" : true,
"boolean" : true,
"containerNode" : true,
"double" : true,
"float" : true,
"floatingPointNumber" : true,
"int" : true,
"integralNumber" : true,
"long" : true,
"missingNode" : true,
"nodeType" : "string",
"null" : true,
"number" : true,
"object" : true,
"pojo" : true,
"short" : true,
"textual" : true,
"valueNode" : true
}
2.2. Accession-register-external-controller-$-mockito-mock-$1519650442
Accession Register External Controller $ Mockito Mock $1519650442
2.2.1. getAll
GET /referential/v1/accession-register
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
param0 |
param0 |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
< AccessionRegisterSummaryDto > array |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/referential/v1/accession-register
Requête header
"string"
Requête query
{
"param0" : "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-external-controller-$-mockito-mock-$681029145
Agency External Controller $ Mockito Mock $681029145
2.3.1. create
POST /referential/v1/agency
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Body |
param0 |
param0 |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
201 |
Created |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/referential/v1/agency
Requête header
"string"
Requête body
{
"description" : "string",
"id" : "string",
"identifier" : "string",
"name" : "string",
"tenant" : 0,
"version" : 0
}
Exemple de réponse HTTP
Réponse 201
{
"description" : "string",
"id" : "string",
"identifier" : "string",
"name" : "string",
"tenant" : 0,
"version" : 0
}
2.3.2. getAllPaginated
GET /referential/v1/agency
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
page |
string |
|
Query |
param0 |
param0 |
integer (int32) |
Query |
param1 |
param1 |
integer (int32) |
Query |
param2 |
param2 |
string |
Query |
param3 |
param3 |
string |
Query |
param4 |
param4 |
enum (ASC, DESC) |
Query |
size |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/referential/v1/agency
Requête header
"string"
Requête query
{
"page" : "string",
"param0" : 0,
"param1" : 0,
"param2" : "string",
"param3" : "string",
"param4" : "string",
"size" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
"hasMore" : true,
"pageNum" : 0,
"pageSize" : 0,
"values" : [ {
"description" : "string",
"id" : "string",
"identifier" : "string",
"name" : "string",
"tenant" : 0,
"version" : 0
} ]
}
2.3.3. check
POST /referential/v1/agency/check
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
X-Tenant-Id |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Body |
param0 |
param0 |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/referential/v1/agency/check
Requête header
"string"
Requête body
{
"description" : "string",
"id" : "string",
"identifier" : "string",
"name" : "string",
"tenant" : 0,
"version" : 0
}
2.3.4. export
GET /referential/v1/agency/export
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Exemple de réponse HTTP
Réponse 200
{
"description" : "string",
"file" : {
"absolute" : true,
"absoluteFile" : {
"absolute" : true,
"absoluteFile" : "...",
"absolutePath" : "string",
"canonicalFile" : "...",
"canonicalPath" : "string",
"directory" : true,
"file" : true,
"freeSpace" : 0,
"hidden" : true,
"name" : "string",
"parent" : "string",
"parentFile" : "...",
"path" : "string",
"totalSpace" : 0,
"usableSpace" : 0
},
"absolutePath" : "string",
"canonicalFile" : "...",
"canonicalPath" : "string",
"directory" : true,
"file" : true,
"freeSpace" : 0,
"hidden" : true,
"name" : "string",
"parent" : "string",
"parentFile" : "...",
"path" : "string",
"totalSpace" : 0,
"usableSpace" : 0
},
"filename" : "string",
"inputStream" : { },
"open" : true,
"readable" : true,
"uri" : {
"absolute" : true,
"authority" : "string",
"fragment" : "string",
"host" : "string",
"opaque" : true,
"path" : "string",
"port" : 0,
"query" : "string",
"rawAuthority" : "string",
"rawFragment" : "string",
"rawPath" : "string",
"rawQuery" : "string",
"rawSchemeSpecificPart" : "string",
"rawUserInfo" : "string",
"scheme" : "string",
"schemeSpecificPart" : "string",
"userInfo" : "string"
},
"url" : {
"authority" : "string",
"content" : "object",
"defaultPort" : 0,
"file" : "string",
"host" : "string",
"path" : "string",
"port" : 0,
"protocol" : "string",
"query" : "string",
"ref" : "string",
"userInfo" : "string"
}
}
2.3.5. delete
DELETE /referential/v1/agency/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
2.3.6. patch
PATCH /referential/v1/agency/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
id |
string |
Body |
param1 |
param1 |
object |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/referential/v1/agency/string
Requête header
"string"
Requête body
{ }
Exemple de réponse HTTP
Réponse 200
{
"description" : "string",
"id" : "string",
"identifier" : "string",
"name" : "string",
"tenant" : 0,
"version" : 0
}
2.3.7. findHistoryById
GET /referential/v1/agency/{id}/history
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Exemple de réponse HTTP
Réponse 200
{
"array" : true,
"bigDecimal" : true,
"bigInteger" : true,
"binary" : true,
"boolean" : true,
"containerNode" : true,
"double" : true,
"float" : true,
"floatingPointNumber" : true,
"int" : true,
"integralNumber" : true,
"long" : true,
"missingNode" : true,
"nodeType" : "string",
"null" : true,
"number" : true,
"object" : true,
"pojo" : true,
"short" : true,
"textual" : true,
"valueNode" : true
}
2.4. Audit-external-controller-$-mockito-mock-$1846952360
Audit External Controller $ Mockito Mock $1846952360
2.4.1. create
POST /referential/v1/audit
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Body |
param0 |
param0 |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
201 |
Created |
boolean |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/referential/v1/audit
Requête header
"string"
Requête body
{
"auditActions" : "string",
"auditType" : "string",
"objectId" : "string",
"query" : {
"array" : true,
"bigDecimal" : true,
"bigInteger" : true,
"binary" : true,
"boolean" : true,
"containerNode" : true,
"double" : true,
"float" : true,
"floatingPointNumber" : true,
"int" : true,
"integralNumber" : true,
"long" : true,
"missingNode" : true,
"nodeType" : "string",
"null" : true,
"number" : true,
"object" : true,
"pojo" : true,
"short" : true,
"textual" : true,
"valueNode" : true
}
}
2.4.2. getAll
GET /referential/v1/audit
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
param0 |
param0 |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
< LogbookOperationDto > array |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/referential/v1/audit
Requête header
"string"
Requête query
{
"param0" : "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",
"collectionName" : "string",
"data" : "string",
"dateTime" : "string",
"id" : "string",
"idAppSession" : "string",
"idRequest" : "string",
"objectId" : "string",
"outDetail" : "string",
"outMessage" : "string",
"outcome" : "string",
"parentId" : "string",
"rightsStatementIdentifier" : "string",
"type" : "string",
"typeProc" : "string"
} ],
"id" : "string",
"idAppSession" : "string",
"idRequest" : "string",
"objectId" : "string",
"outDetail" : "string",
"outMessage" : "string",
"outcome" : "string",
"parentId" : "string",
"rightsStatementIdentifier" : "string",
"type" : "string",
"typeProc" : "string"
} ]
2.4.3. findHistoryById
GET /referential/v1/audit/{id}/history
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Exemple de réponse HTTP
Réponse 200
{
"array" : true,
"bigDecimal" : true,
"bigInteger" : true,
"binary" : true,
"boolean" : true,
"containerNode" : true,
"double" : true,
"float" : true,
"floatingPointNumber" : true,
"int" : true,
"integralNumber" : true,
"long" : true,
"missingNode" : true,
"nodeType" : "string",
"null" : true,
"number" : true,
"object" : true,
"pojo" : true,
"short" : true,
"textual" : true,
"valueNode" : true
}
2.5. Context-external-controller-$-mockito-mock-$2037785581
Context External Controller $ Mockito Mock $2037785581
2.5.1. create
POST /referential/v1/context
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Body |
param0 |
param0 |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
201 |
Created |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/referential/v1/context
Requête header
"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 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.5.2. getAllPaginated
GET /referential/v1/context
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
page |
string |
|
Query |
param0 |
param0 |
integer (int32) |
Query |
param1 |
param1 |
integer (int32) |
Query |
param2 |
param2 |
string |
Query |
param3 |
param3 |
string |
Query |
param4 |
param4 |
enum (ASC, DESC) |
Query |
size |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/referential/v1/context
Requête header
"string"
Requête query
{
"page" : "string",
"param0" : 0,
"param1" : 0,
"param2" : "string",
"param3" : "string",
"param4" : "string",
"size" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
"hasMore" : true,
"pageNum" : 0,
"pageSize" : 0,
"values" : [ {
"activationDate" : "string",
"creationDate" : "string",
"deactivationDate" : "string",
"enableControl" : true,
"id" : "string",
"identifier" : "string",
"lastUpdate" : "string",
"name" : "string",
"permissions" : [ {
"accessContracts" : [ "string" ],
"ingestContracts" : [ "string" ],
"tenant" : "string"
} ],
"securityProfile" : "string",
"status" : "string"
} ]
}
2.5.3. check
POST /referential/v1/context/check
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
X-Tenant-Id |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Body |
param0 |
param0 |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/referential/v1/context/check
Requête header
"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"
}
2.5.4. patch
PATCH /referential/v1/context/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
id |
string |
Body |
param1 |
param1 |
object |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/referential/v1/context/string
Requête header
"string"
Requête body
{ }
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.5.5. findHistoryById
GET /referential/v1/context/{id}/history
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Exemple de réponse HTTP
Réponse 200
{
"array" : true,
"bigDecimal" : true,
"bigInteger" : true,
"binary" : true,
"boolean" : true,
"containerNode" : true,
"double" : true,
"float" : true,
"floatingPointNumber" : true,
"int" : true,
"integralNumber" : true,
"long" : true,
"missingNode" : true,
"nodeType" : "string",
"null" : true,
"number" : true,
"object" : true,
"pojo" : true,
"short" : true,
"textual" : true,
"valueNode" : true
}
2.6. File-format-external-controller-$-mockito-mock-$991532179
File Format External Controller $ Mockito Mock $991532179
2.6.1. create
POST /referential/v1/fileformats
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Body |
param0 |
param0 |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
201 |
Created |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/referential/v1/fileformats
Requête header
"string"
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. getAllPaginated
GET /referential/v1/fileformats
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
page |
string |
|
Query |
param0 |
param0 |
integer (int32) |
Query |
param1 |
param1 |
integer (int32) |
Query |
param2 |
param2 |
string |
Query |
param3 |
param3 |
string |
Query |
param4 |
param4 |
enum (ASC, DESC) |
Query |
size |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/referential/v1/fileformats
Requête header
"string"
Requête query
{
"page" : "string",
"param0" : 0,
"param1" : 0,
"param2" : "string",
"param3" : "string",
"param4" : "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
POST /referential/v1/fileformats/check
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
X-Tenant-Id |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Body |
param0 |
param0 |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/referential/v1/fileformats/check
Requête header
"string"
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. export
GET /referential/v1/fileformats/export
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Exemple de réponse HTTP
Réponse 200
{
"description" : "string",
"file" : {
"absolute" : true,
"absoluteFile" : {
"absolute" : true,
"absoluteFile" : "...",
"absolutePath" : "string",
"canonicalFile" : "...",
"canonicalPath" : "string",
"directory" : true,
"file" : true,
"freeSpace" : 0,
"hidden" : true,
"name" : "string",
"parent" : "string",
"parentFile" : "...",
"path" : "string",
"totalSpace" : 0,
"usableSpace" : 0
},
"absolutePath" : "string",
"canonicalFile" : "...",
"canonicalPath" : "string",
"directory" : true,
"file" : true,
"freeSpace" : 0,
"hidden" : true,
"name" : "string",
"parent" : "string",
"parentFile" : "...",
"path" : "string",
"totalSpace" : 0,
"usableSpace" : 0
},
"filename" : "string",
"inputStream" : { },
"open" : true,
"readable" : true,
"uri" : {
"absolute" : true,
"authority" : "string",
"fragment" : "string",
"host" : "string",
"opaque" : true,
"path" : "string",
"port" : 0,
"query" : "string",
"rawAuthority" : "string",
"rawFragment" : "string",
"rawPath" : "string",
"rawQuery" : "string",
"rawSchemeSpecificPart" : "string",
"rawUserInfo" : "string",
"scheme" : "string",
"schemeSpecificPart" : "string",
"userInfo" : "string"
},
"url" : {
"authority" : "string",
"content" : "object",
"defaultPort" : 0,
"file" : "string",
"host" : "string",
"path" : "string",
"port" : 0,
"protocol" : "string",
"query" : "string",
"ref" : "string",
"userInfo" : "string"
}
}
2.6.5. delete
DELETE /referential/v1/fileformats/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
2.6.6. patch
PATCH /referential/v1/fileformats/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
id |
string |
Body |
param1 |
param1 |
object |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/referential/v1/fileformats/string
Requête header
"string"
Requête body
{ }
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. findHistoryById
GET /referential/v1/fileformats/{id}/history
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/referential/v1/fileformats/string/history
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
{
"array" : true,
"bigDecimal" : true,
"bigInteger" : true,
"binary" : true,
"boolean" : true,
"containerNode" : true,
"double" : true,
"float" : true,
"floatingPointNumber" : true,
"int" : true,
"integralNumber" : true,
"long" : true,
"missingNode" : true,
"nodeType" : "string",
"null" : true,
"number" : true,
"object" : true,
"pojo" : true,
"short" : true,
"textual" : true,
"valueNode" : true
}
2.7. Ingest-contract-external-controller-$-mockito-mock-$1329802202
Ingest Contract External Controller $ Mockito Mock $1329802202
2.7.1. create
POST /referential/v1/ingestcontract
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Body |
param0 |
param0 |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
201 |
Created |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/referential/v1/ingestcontract
Requête header
"string"
Requête body
{
"activationdate" : "string",
"archiveProfiles" : [ "string" ],
"checkParentId" : [ "string" ],
"checkParentLink" : "string",
"creationdate" : "string",
"deactivationdate" : "string",
"description" : "string",
"everyDataObjectVersion" : true,
"everyFormatType" : true,
"formatType" : [ "string" ],
"formatUnidentifiedAuthorized" : true,
"id" : "string",
"identifier" : "string",
"lastupdate" : "string",
"linkParentId" : "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",
"deactivationdate" : "string",
"description" : "string",
"everyDataObjectVersion" : true,
"everyFormatType" : true,
"formatType" : [ "string" ],
"formatUnidentifiedAuthorized" : true,
"id" : "string",
"identifier" : "string",
"lastupdate" : "string",
"linkParentId" : "string",
"masterMandatory" : true,
"name" : "string",
"status" : "string",
"tenant" : 0,
"version" : 0
}
2.7.2. getAll
GET /referential/v1/ingestcontract
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
param0 |
param0 |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
< IngestContractDto > array |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/referential/v1/ingestcontract
Requête header
"string"
Requête query
{
"param0" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
"activationdate" : "string",
"archiveProfiles" : [ "string" ],
"checkParentId" : [ "string" ],
"checkParentLink" : "string",
"creationdate" : "string",
"deactivationdate" : "string",
"description" : "string",
"everyDataObjectVersion" : true,
"everyFormatType" : true,
"formatType" : [ "string" ],
"formatUnidentifiedAuthorized" : true,
"id" : "string",
"identifier" : "string",
"lastupdate" : "string",
"linkParentId" : "string",
"masterMandatory" : true,
"name" : "string",
"status" : "string",
"tenant" : 0,
"version" : 0
} ]
2.7.3. check
POST /referential/v1/ingestcontract/check
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
X-Tenant-Id |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Body |
param0 |
param0 |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/referential/v1/ingestcontract/check
Requête header
"string"
Requête body
{
"activationdate" : "string",
"archiveProfiles" : [ "string" ],
"checkParentId" : [ "string" ],
"checkParentLink" : "string",
"creationdate" : "string",
"deactivationdate" : "string",
"description" : "string",
"everyDataObjectVersion" : true,
"everyFormatType" : true,
"formatType" : [ "string" ],
"formatUnidentifiedAuthorized" : true,
"id" : "string",
"identifier" : "string",
"lastupdate" : "string",
"linkParentId" : "string",
"masterMandatory" : true,
"name" : "string",
"status" : "string",
"tenant" : 0,
"version" : 0
}
2.7.4. patch
PATCH /referential/v1/ingestcontract/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
id |
string |
Body |
param1 |
param1 |
object |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/referential/v1/ingestcontract/string
Requête header
"string"
Requête body
{ }
Exemple de réponse HTTP
Réponse 200
{
"activationdate" : "string",
"archiveProfiles" : [ "string" ],
"checkParentId" : [ "string" ],
"checkParentLink" : "string",
"creationdate" : "string",
"deactivationdate" : "string",
"description" : "string",
"everyDataObjectVersion" : true,
"everyFormatType" : true,
"formatType" : [ "string" ],
"formatUnidentifiedAuthorized" : true,
"id" : "string",
"identifier" : "string",
"lastupdate" : "string",
"linkParentId" : "string",
"masterMandatory" : true,
"name" : "string",
"status" : "string",
"tenant" : 0,
"version" : 0
}
2.7.5. findHistoryById
GET /referential/v1/ingestcontract/{id}/history
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/referential/v1/ingestcontract/string/history
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
{
"array" : true,
"bigDecimal" : true,
"bigInteger" : true,
"binary" : true,
"boolean" : true,
"containerNode" : true,
"double" : true,
"float" : true,
"floatingPointNumber" : true,
"int" : true,
"integralNumber" : true,
"long" : true,
"missingNode" : true,
"nodeType" : "string",
"null" : true,
"number" : true,
"object" : true,
"pojo" : true,
"short" : true,
"textual" : true,
"valueNode" : true
}
2.8. Ontology-external-controller-$-mockito-mock-$908508977
Ontology External Controller $ Mockito Mock $908508977
2.8.1. create
POST /referential/v1/ontology
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Body |
param0 |
param0 |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
201 |
Created |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/referential/v1/ontology
Requête header
"string"
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.8.2. getAllPaginated
GET /referential/v1/ontology
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
page |
string |
|
Query |
param0 |
param0 |
integer (int32) |
Query |
param1 |
param1 |
integer (int32) |
Query |
param2 |
param2 |
string |
Query |
param3 |
param3 |
string |
Query |
param4 |
param4 |
enum (ASC, DESC) |
Query |
size |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/referential/v1/ontology
Requête header
"string"
Requête query
{
"page" : "string",
"param0" : 0,
"param1" : 0,
"param2" : "string",
"param3" : "string",
"param4" : "string",
"size" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
"hasMore" : true,
"pageNum" : 0,
"pageSize" : 0,
"values" : [ {
"apiField" : "string",
"collections" : [ "string" ],
"creationdate" : "string",
"description" : "string",
"id" : "string",
"identifier" : "string",
"lastupdate" : "string",
"origin" : "string",
"sedaField" : "string",
"shortName" : "string",
"tenant" : 0,
"type" : "string",
"version" : 0
} ]
}
2.8.3. delete
DELETE /referential/v1/ontology/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
2.8.4. findHistoryById
GET /referential/v1/ontology/{id}/history
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/referential/v1/ontology/string/history
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
{
"array" : true,
"bigDecimal" : true,
"bigInteger" : true,
"binary" : true,
"boolean" : true,
"containerNode" : true,
"double" : true,
"float" : true,
"floatingPointNumber" : true,
"int" : true,
"integralNumber" : true,
"long" : true,
"missingNode" : true,
"nodeType" : "string",
"null" : true,
"number" : true,
"object" : true,
"pojo" : true,
"short" : true,
"textual" : true,
"valueNode" : true
}
2.9. Security-profile-external-controller-$-mockito-mock-$66437044
Security Profile External Controller $ Mockito Mock $66437044
2.9.1. create
POST /referential/v1/profile
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Body |
param0 |
param0 |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
201 |
Created |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/referential/v1/profile
Requête header
"string"
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.9.2. getAllPaginated
GET /referential/v1/profile
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
page |
string |
|
Query |
param0 |
param0 |
integer (int32) |
Query |
param1 |
param1 |
integer (int32) |
Query |
param2 |
param2 |
string |
Query |
param3 |
param3 |
string |
Query |
param4 |
param4 |
enum (ASC, DESC) |
Query |
size |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/referential/v1/profile
Requête header
"string"
Requête query
{
"page" : "string",
"param0" : 0,
"param1" : 0,
"param2" : "string",
"param3" : "string",
"param4" : "string",
"size" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
"hasMore" : true,
"pageNum" : 0,
"pageSize" : 0,
"values" : [ {
"fullAccess" : true,
"id" : "string",
"identifier" : "string",
"name" : "string",
"permissions" : [ "string" ]
} ]
}
2.9.3. check
POST /referential/v1/profile/check
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
X-Tenant-Id |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Body |
param0 |
param0 |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/referential/v1/profile/check
Requête header
"string"
Requête body
{
"fullAccess" : true,
"id" : "string",
"identifier" : "string",
"name" : "string",
"permissions" : [ "string" ]
}
2.9.4. delete
DELETE /referential/v1/profile/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
2.9.5. patch
PATCH /referential/v1/profile/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
id |
string |
Body |
param1 |
param1 |
object |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/referential/v1/profile/string
Requête header
"string"
Requête body
{ }
Exemple de réponse HTTP
Réponse 200
{
"fullAccess" : true,
"id" : "string",
"identifier" : "string",
"name" : "string",
"permissions" : [ "string" ]
}
2.9.6. findHistoryById
GET /referential/v1/profile/{id}/history
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Exemple de réponse HTTP
Réponse 200
{
"array" : true,
"bigDecimal" : true,
"bigInteger" : true,
"binary" : true,
"boolean" : true,
"containerNode" : true,
"double" : true,
"float" : true,
"floatingPointNumber" : true,
"int" : true,
"integralNumber" : true,
"long" : true,
"missingNode" : true,
"nodeType" : "string",
"null" : true,
"number" : true,
"object" : true,
"pojo" : true,
"short" : true,
"textual" : true,
"valueNode" : true
}
2.10. Status
Status check and autotest
2.10.1. autotest
GET /autotest
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
string |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Exemple de réponse HTTP
Réponse 200
"string"
2.10.2. status
GET /status
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
string |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Exemple de réponse HTTP
Réponse 200
"string"
3. Définitions
3.1. AccessContractDto
Nom | Description | Schéma |
---|---|---|
accessLog |
Exemple : |
string |
activationDate |
Exemple : |
string |
creationDate |
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 |
rootUnits |
Exemple : |
< string > array |
status |
Exemple : |
string |
tenant |
Exemple : |
integer (int32) |
version |
Exemple : |
integer (int32) |
writingPermission |
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. AgencyDto
Nom | Description | Schéma |
---|---|---|
description |
Exemple : |
string |
id |
Exemple : |
string |
identifier |
Exemple : |
string |
name |
Exemple : |
string |
tenant |
Exemple : |
integer (int32) |
version |
Exemple : |
integer (int32) |
3.4. AuditOptions
Nom | Description | Schéma |
---|---|---|
auditActions |
Exemple : |
string |
auditType |
Exemple : |
string |
objectId |
Exemple : |
string |
query |
Exemple : |
3.5. 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.6. File
Nom | Description | Schéma |
---|---|---|
absolute |
Exemple : |
boolean |
absoluteFile |
Exemple : |
|
absolutePath |
Exemple : |
string |
canonicalFile |
Exemple : |
|
canonicalPath |
Exemple : |
string |
directory |
Exemple : |
boolean |
file |
Exemple : |
boolean |
freeSpace |
Exemple : |
integer (int64) |
hidden |
Exemple : |
boolean |
name |
Exemple : |
string |
parent |
Exemple : |
string |
parentFile |
Exemple : |
|
path |
Exemple : |
string |
totalSpace |
Exemple : |
integer (int64) |
usableSpace |
Exemple : |
integer (int64) |
3.7. 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.8. IngestContractDto
Nom | Description | Schéma |
---|---|---|
activationdate |
Exemple : |
string |
archiveProfiles |
Exemple : |
< string > array |
checkParentId |
Exemple : |
< string > array |
checkParentLink |
Exemple : |
string |
creationdate |
Exemple : |
string |
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 |
masterMandatory |
Exemple : |
boolean |
name |
Exemple : |
string |
status |
Exemple : |
enum (ACTIVE, INACTIVE) |
tenant |
Exemple : |
integer (int32) |
version |
Exemple : |
integer (int32) |
3.9. InputStream
Type : object
3.10. JsonNode
Nom | Description | Schéma |
---|---|---|
array |
Exemple : |
boolean |
bigDecimal |
Exemple : |
boolean |
bigInteger |
Exemple : |
boolean |
binary |
Exemple : |
boolean |
boolean |
Exemple : |
boolean |
containerNode |
Exemple : |
boolean |
double |
Exemple : |
boolean |
float |
Exemple : |
boolean |
floatingPointNumber |
Exemple : |
boolean |
int |
Exemple : |
boolean |
integralNumber |
Exemple : |
boolean |
long |
Exemple : |
boolean |
missingNode |
Exemple : |
boolean |
nodeType |
Exemple : |
enum (ARRAY, BINARY, BOOLEAN, MISSING, NULL, NUMBER, OBJECT, POJO, STRING) |
null |
Exemple : |
boolean |
number |
Exemple : |
boolean |
object |
Exemple : |
boolean |
pojo |
Exemple : |
boolean |
short |
Exemple : |
boolean |
textual |
Exemple : |
boolean |
valueNode |
Exemple : |
boolean |
3.11. LogbookEventDto
Nom | Description | Schéma |
---|---|---|
agId |
Exemple : |
string |
agIdApp |
Exemple : |
string |
agIdExt |
Exemple : |
string |
collectionName |
Exemple : |
string |
data |
Exemple : |
string |
dateTime |
Exemple : |
string |
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.12. LogbookOperationDto
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.13. 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 (INTERNAL, EXTERNAL) |
sedaField |
Exemple : |
string |
shortName |
Exemple : |
string |
tenant |
Exemple : |
integer (int32) |
type |
Exemple : |
enum (TEXT, KEYWORD, DATE, LONG, DOUBLE, BOOLEAN, GEO_POINT, ENUM) |
version |
Exemple : |
integer (int32) |
3.14. PaginatedValuesDto«AccessContractDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< AccessContractDto > array |
3.15. PaginatedValuesDto«AgencyDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< AgencyDto > array |
3.16. PaginatedValuesDto«ContextDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< ContextDto > array |
3.17. PaginatedValuesDto«FileFormatDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< FileFormatDto > array |
3.18. PaginatedValuesDto«IngestContractDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< IngestContractDto > array |
3.19. PaginatedValuesDto«LogbookOperationDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< LogbookOperationDto > array |
3.20. PaginatedValuesDto«OntologyDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< OntologyDto > array |
3.21. PaginatedValuesDto«SecurityProfileDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< SecurityProfileDto > array |
3.22. PermissionDto
Nom | Description | Schéma |
---|---|---|
accessContracts |
Exemple : |
< string > array |
ingestContracts |
Exemple : |
< string > array |
tenant |
Exemple : |
string |
3.23. RegisterValueDetailModel
Nom | Description | Schéma |
---|---|---|
deleted |
Exemple : |
integer (int64) |
ingested |
Exemple : |
integer (int64) |
remained |
Exemple : |
integer (int64) |
3.24. Resource
Nom | Description | Schéma |
---|---|---|
description |
Exemple : |
string |
file |
Exemple : |
|
filename |
Exemple : |
string |
inputStream |
Exemple : |
|
open |
Exemple : |
boolean |
readable |
Exemple : |
boolean |
uri |
Exemple : |
|
url |
Exemple : |
3.25. SecurityProfileDto
Nom | Description | Schéma |
---|---|---|
fullAccess |
Exemple : |
boolean |
id |
Exemple : |
string |
identifier |
Exemple : |
string |
name |
Exemple : |
string |
permissions |
Exemple : |
< string > array |
3.26. URI
Nom | Description | Schéma |
---|---|---|
absolute |
Exemple : |
boolean |
authority |
Exemple : |
string |
fragment |
Exemple : |
string |
host |
Exemple : |
string |
opaque |
Exemple : |
boolean |
path |
Exemple : |
string |
port |
Exemple : |
integer (int32) |
query |
Exemple : |
string |
rawAuthority |
Exemple : |
string |
rawFragment |
Exemple : |
string |
rawPath |
Exemple : |
string |
rawQuery |
Exemple : |
string |
rawSchemeSpecificPart |
Exemple : |
string |
rawUserInfo |
Exemple : |
string |
scheme |
Exemple : |
string |
schemeSpecificPart |
Exemple : |
string |
userInfo |
Exemple : |
string |
3.27. URL
Nom | Description | Schéma |
---|---|---|
authority |
Exemple : |
string |
content |
Exemple : |
object |
defaultPort |
Exemple : |
integer (int32) |
file |
Exemple : |
string |
host |
Exemple : |
string |
path |
Exemple : |
string |
port |
Exemple : |
integer (int32) |
protocol |
Exemple : |
string |
query |
Exemple : |
string |
ref |
Exemple : |
string |
userInfo |
Exemple : |
string |