1. Vue générale
This API is used by the Archive UI to send archives to external Vitam UI layers and than to Vitam. This API should be used by the Archive UI only.
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
-
archives Search : Access Contract Temp Controller
-
searchcriteriahistory : Search Criteria History Controller
1.6. Produit
-
application/json
2. Ressources
2.1. Archives Search
Access Contract Temp Controller
2.1.1. Get entity
GET /archive-search-api/archive-search/accesscontracts
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
Query |
criteria |
criteria |
string |
Réponses
| Code HTTP | Description | Schéma |
|---|---|---|
200 |
OK |
< AccessContractDto > array |
Exemple de requête HTTP
Requête path
/archive-search-api/archive-search/accesscontracts
Requête query
{
"criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
"accessLog" : "string",
"activationDate" : "string",
"creationDate" : "string",
"dataObjectVersion" : [ "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. Find the Archive Unit Details
GET /archive-search-api/archive-search/archiveunit/{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
/archive-search-api/archive-search/archiveunit/string
Exemple de réponse HTTP
Réponse 200
{
"#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.1.3. Download Object from the Archive Unit
GET /archive-search-api/archive-search/downloadobjectfromunit/{id}
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
Path |
id |
id |
string |
Exemple de requête HTTP
Requête path
/archive-search-api/archive-search/downloadobjectfromunit/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.1.4. export into csv format archive units by criteria
POST /archive-search-api/archive-search/export-csv-search
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
Body |
searchQuery |
searchQuery |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/archive-search-api/archive-search/export-csv-search
Requête body
{
"criteriaList" : [ {
"criteria" : "string",
"values" : [ "string" ]
} ],
"fieldsList" : [ "string" ],
"language" : "string",
"nodes" : [ "string" ],
"pageNumber" : 0,
"size" : 0,
"sortingCriteria" : {
"criteria" : "string",
"sorting" : "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.1.5. Get filing plan
GET /archive-search-api/archive-search/filingholdingscheme
Réponses
| Code HTTP | Description | Schéma |
|---|---|---|
200 |
OK |
Exemple de requête HTTP
Requête path
/archive-search-api/archive-search/filingholdingscheme
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.1.6. find archive units by criteria
POST /archive-search-api/archive-search/search
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
Body |
searchQuery |
searchQuery |
Réponses
| Code HTTP | Description | Schéma |
|---|---|---|
200 |
OK |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/archive-search-api/archive-search/search
Requête body
{
"criteriaList" : [ {
"criteria" : "string",
"values" : [ "string" ]
} ],
"fieldsList" : [ "string" ],
"language" : "string",
"nodes" : [ "string" ],
"pageNumber" : 0,
"size" : 0,
"sortingCriteria" : {
"criteria" : "string",
"sorting" : "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" ]
} ],
"originating_agencyName" : "string"
} ]
}
2.2. Searchcriteriahistory
Search Criteria History Controller
2.2.1. Create search criteria history
POST /archive-search-api/archive-search/searchcriteriahistory
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
Body |
entityDto |
entityDto |
Réponses
| Code HTTP | Description | Schéma |
|---|---|---|
201 |
Created |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/archive-search-api/archive-search/searchcriteriahistory
Requête body
{
"id" : "string",
"name" : "string",
"savingDate" : "string",
"searchCriteriaList" : [ {
"criteriaList" : [ {
"criteria" : "string",
"values" : [ "string" ]
} ],
"nodes" : [ "string" ]
} ],
"userId" : "string"
}
Exemple de réponse HTTP
Réponse 201
{
"id" : "string",
"name" : "string",
"savingDate" : "string",
"searchCriteriaList" : [ {
"criteriaList" : [ {
"criteria" : "string",
"values" : [ "string" ]
} ],
"nodes" : [ "string" ]
} ],
"userId" : "string"
}
2.2.2. Get the search criteria history
GET /archive-search-api/archive-search/searchcriteriahistory
Réponses
| Code HTTP | Description | Schéma |
|---|---|---|
200 |
OK |
< SearchCriteriaHistoryDto > array |
Exemple de requête HTTP
Requête path
/archive-search-api/archive-search/searchcriteriahistory
Exemple de réponse HTTP
Réponse 200
[ {
"id" : "string",
"name" : "string",
"savingDate" : "string",
"searchCriteriaList" : [ {
"criteriaList" : [ {
"criteria" : "string",
"values" : [ "string" ]
} ],
"nodes" : [ "string" ]
} ],
"userId" : "string"
} ]
2.2.3. Update Search criteria history
PUT /archive-search-api/archive-search/searchcriteriahistory/{id}
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
Body |
entity |
entity |
Réponses
| Code HTTP | Description | Schéma |
|---|---|---|
200 |
OK |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/archive-search-api/archive-search/searchcriteriahistory/{id}
Requête body
{
"id" : "string",
"name" : "string",
"savingDate" : "string",
"searchCriteriaList" : [ {
"criteriaList" : [ {
"criteria" : "string",
"values" : [ "string" ]
} ],
"nodes" : [ "string" ]
} ],
"userId" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
"id" : "string",
"name" : "string",
"savingDate" : "string",
"searchCriteriaList" : [ {
"criteriaList" : [ {
"criteria" : "string",
"values" : [ "string" ]
} ],
"nodes" : [ "string" ]
} ],
"userId" : "string"
}
2.2.4. delete Search criteria history
DELETE /archive-search-api/archive-search/searchcriteriahistory/{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
/archive-search-api/archive-search/searchcriteriahistory/string
3. Définitions
3.1. AccessContractDto
| Nom | Description | Schéma |
|---|---|---|
accessLog |
Exemple : |
string |
activationDate |
Exemple : |
string |
creationDate |
Exemple : |
string |
dataObjectVersion |
Exemple : |
< string > array |
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. AgencyDto
| Nom | Description | Schéma |
|---|---|---|
Identifier |
Exemple : |
string |
3.3. ArchiveUnit
| 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 |
originating_agencyName |
Exemple : |
string |
3.4. FacetBucketDto
| Nom | Description | Schéma |
|---|---|---|
count |
Exemple : |
integer (int64) |
value |
Exemple : |
string |
3.5. FacetResultsDto
| Nom | Description | Schéma |
|---|---|---|
buckets |
Exemple : |
< FacetBucketDto > array |
name |
Exemple : |
string |
3.6. FieldsDto
| Nom | Description | Schéma |
|---|---|---|
Description |
Exemple : |
integer (int32) |
Title |
Exemple : |
integer (int32) |
3.7. 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.8. 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.9. FilterDto
| Nom | Description | Schéma |
|---|---|---|
$limit |
Exemple : |
integer (int32) |
$orderby |
Exemple : |
3.10. FormatIdentificationModel
| Nom | Description | Schéma |
|---|---|---|
Encoding |
Exemple : |
string |
FormatId |
Exemple : |
string |
FormatLitteral |
Exemple : |
string |
MimeType |
Exemple : |
string |
3.11. HitsDto
| Nom | Description | Schéma |
|---|---|---|
limit |
Exemple : |
integer (int32) |
offset |
Exemple : |
integer (int32) |
size |
Exemple : |
integer (int32) |
total |
Exemple : |
integer (int32) |
3.12. InheritedPropertyDto
| Nom | Description | Schéma |
|---|---|---|
PropertyName |
Exemple : |
string |
PropertyValue |
Exemple : |
object |
3.13. InheritedRuleCategoryDto
| Nom | Description | Schéma |
|---|---|---|
Properties |
Exemple : |
< InheritedPropertyDto > array |
Rules |
Exemple : |
< RuleDto > array |
3.14. InheritedRulesDto
| Nom | Description | Schéma |
|---|---|---|
AppraisalRule |
Exemple : |
3.15. InputStream
Type : object
3.16. JsonNode
Type : object
3.17. KeywordDto
| Nom | Description | Schéma |
|---|---|---|
KeywordContent |
Exemple : |
string |
KeywordReference |
Exemple : |
string |
3.18. ManagementDto
| Nom | Description | Schéma |
|---|---|---|
AppraisalRule |
Exemple : |
3.19. MeasurementModel
| Nom | Description | Schéma |
|---|---|---|
dValue |
Exemple : |
number |
dvalue |
Exemple : |
number |
unit |
Exemple : |
string |
3.20. MetadataModel
| Nom | Description | Schéma |
|---|---|---|
Audio |
Exemple : |
object |
Document |
Exemple : |
object |
Image |
Exemple : |
object |
Text |
Exemple : |
object |
Video |
Exemple : |
object |
3.21. OrderbyDto
| Nom | Description | Schéma |
|---|---|---|
TransactedDate |
Exemple : |
integer (int32) |
3.22. PaginatedValuesDto«AccessContractDto»
| Nom | Description | Schéma |
|---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< AccessContractDto > array |
3.23. 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.24. ProjectionDto
| Nom | Description | Schéma |
|---|---|---|
$fields |
Exemple : |
3.25. QualifiersDto
| Nom | Description | Schéma |
|---|---|---|
qualifier |
Exemple : |
string |
versions |
Exemple : |
< VersionsDto > array |
3.26. QueryDTO
| Nom | Description | Schéma |
|---|---|---|
$filter |
Exemple : |
|
$projection |
Exemple : |
|
$query |
Exemple : |
< JsonNode > array |
$roots |
Exemple : |
< string > array |
3.27. QueryFilter
| Nom | Description | Schéma |
|---|---|---|
$limit |
Exemple : |
integer (int32) |
$offset |
Exemple : |
integer (int32) |
$orderby |
Exemple : |
< string, integer (int32) > map |
3.28. QueryProjection
| Nom | Description | Schéma |
|---|---|---|
$fields |
Exemple : |
< string, integer (int32) > map |
3.29. 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.30. 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.31. RuleCategoryDto
| Nom | Description | Schéma |
|---|---|---|
FinalAction |
Exemple : |
string |
Rules |
Exemple : |
< RuleDto > array |
3.32. RuleDto
| Nom | Description | Schéma |
|---|---|---|
EndDate |
Exemple : |
string |
Rule |
Exemple : |
string |
StartDate |
Exemple : |
string |
3.33. SearchCriteriaDto
| Nom | Description | Schéma |
|---|---|---|
criteriaList |
Exemple : |
< SearchCriteriaEltDto > array |
fieldsList |
Exemple : |
< string > array |
language |
Exemple : |
string |
nodes |
Exemple : |
< string > array |
pageNumber |
Exemple : |
integer (int32) |
size |
Exemple : |
integer (int32) |
sortingCriteria |
Exemple : |
3.34. SearchCriteriaElementsDto
| Nom | Description | Schéma |
|---|---|---|
criteria |
Exemple : |
string |
values |
Exemple : |
< string > array |
3.35. SearchCriteriaEltDto
| Nom | Description | Schéma |
|---|---|---|
criteria |
Exemple : |
string |
values |
Exemple : |
< string > array |
3.36. SearchCriteriaHistoryDto
| Nom | Description | Schéma |
|---|---|---|
id |
Exemple : |
string |
name |
Exemple : |
string |
savingDate |
Exemple : |
string (date-time) |
searchCriteriaList |
Exemple : |
< SearchCriteriasDto > array |
userId |
Exemple : |
string |
3.37. SearchCriteriaSort
| Nom | Description | Schéma |
|---|---|---|
criteria |
Exemple : |
string |
sorting |
Exemple : |
enum (ASC, DESC) |
3.38. SearchCriteriasDto
| Nom | Description | Schéma |
|---|---|---|
criteriaList |
Exemple : |
< SearchCriteriaElementsDto > array |
nodes |
Exemple : |
< string > array |
3.39. StorageDto
| Nom | Description | Schéma |
|---|---|---|
strategyId |
Exemple : |
string |
3.40. StorageJson
| Nom | Description | Schéma |
|---|---|---|
#nbc |
Exemple : |
string |
offerIds |
Exemple : |
< string > array |
strategyId |
Exemple : |
string |
3.41. TitleDto
| Nom | Description | Schéma |
|---|---|---|
en |
Exemple : |
string |
fr |
Exemple : |
string |
3.42. 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.43. VitamSearchRequestDto
| Nom | Description | Schéma |
|---|---|---|
$filter |
Exemple : |
|
$projection |
Exemple : |
|
$query |
Exemple : |
< QueryDTO > array |
$roots |
Exemple : |
< string > array |
3.44. VitamUIArchiveUnitResponseDto
| Nom | Description | Schéma |
|---|---|---|
$context |
Exemple : |
|
$facetResults |
Exemple : |
< FacetResultsDto > array |
$hits |
Exemple : |
|
$results |
Exemple : |
< ArchiveUnit > array |
3.45. VitamUISearchResponseDto
| Nom | Description | Schéma |
|---|---|---|
$context |
Exemple : |
|
$facetResults |
Exemple : |
< FacetResultsDto > array |
$hits |
Exemple : |
|
$results |
Exemple : |
< ResultsDto > array |
3.46. VtagDto
| Nom | Description | Schéma |
|---|---|---|
Key |
Exemple : |
< string > array |
Value |
Exemple : |
< string > array |
3.47. XtagDto
| Nom | Description | Schéma |
|---|---|---|
Key |
Exemple : |
< string > array |
Value |
Exemple : |
< string > array |