1. Vue générale
API externe de gestion des archives
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 : Archives Search External Controller $ Mockito Mock $522464242
-
access-contract-temp-external-controller-$-mockito-mock-$959214949 : Access Contract Temp External Controller $ Mockito Mock $959214949
-
basic-error-controller : Basic Error Controller
-
searchCriteriaHistory : Search Criteria History External Controller $ Mockito Mock $108068997
1.6. Produit
-
application/json
2. Ressources
2.1. Archives Search
Archives Search External Controller $ Mockito Mock $522464242
2.1.1. findUnitById
GET /archives-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
/archives-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.2. downloadObjectFromUnit
GET /archives-search/downloadobjectfromunit/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Path |
id |
id |
string |
Exemple de requête HTTP
Requête path
/archives-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.3. exportCsvArchiveUnitsByCriteria
POST /archives-search/export-csv-search
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Body |
param0 |
param0 |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/archives-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.4. getFillingHoldingScheme
GET /archives-search/filling-holding-schema
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Exemple de requête HTTP
Requête path
/archives-search/filling-holding-schema
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.5. searchArchiveUnitsByCriteria
POST /archives-search/search
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Body |
param0 |
param0 |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/archives-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
{
"archives" : {
"$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"
} ]
},
"id" : "string"
}
2.2. Access-contract-temp-external-controller-$-mockito-mock-$959214949
Access Contract Temp External Controller $ Mockito Mock $959214949
2.2.1. getAll
GET /accesscontracts
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Query |
param0 |
param0 |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
< AccessContractDto > array |
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.3. Basic-error-controller
Basic Error Controller
2.3.1. errorHtml
POST /error
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Consomme
-
application/json
Produit
-
text/html
Exemple de réponse HTTP
Réponse 200
{
"empty" : true,
"model" : "object",
"modelMap" : {
"string" : "object"
},
"reference" : true,
"status" : "string",
"view" : {
"contentType" : "string"
},
"viewName" : "string"
}
2.3.2. errorHtml
GET /error
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Produit
-
text/html
Exemple de réponse HTTP
Réponse 200
{
"empty" : true,
"model" : "object",
"modelMap" : {
"string" : "object"
},
"reference" : true,
"status" : "string",
"view" : {
"contentType" : "string"
},
"viewName" : "string"
}
2.3.3. errorHtml
PUT /error
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Consomme
-
application/json
Produit
-
text/html
Exemple de réponse HTTP
Réponse 200
{
"empty" : true,
"model" : "object",
"modelMap" : {
"string" : "object"
},
"reference" : true,
"status" : "string",
"view" : {
"contentType" : "string"
},
"viewName" : "string"
}
2.3.4. errorHtml
DELETE /error
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Produit
-
text/html
Exemple de réponse HTTP
Réponse 200
{
"empty" : true,
"model" : "object",
"modelMap" : {
"string" : "object"
},
"reference" : true,
"status" : "string",
"view" : {
"contentType" : "string"
},
"viewName" : "string"
}
2.3.5. errorHtml
PATCH /error
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Consomme
-
application/json
Produit
-
text/html
Exemple de réponse HTTP
Réponse 200
{
"empty" : true,
"model" : "object",
"modelMap" : {
"string" : "object"
},
"reference" : true,
"status" : "string",
"view" : {
"contentType" : "string"
},
"viewName" : "string"
}
2.3.6. errorHtml
HEAD /error
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Consomme
-
application/json
Produit
-
text/html
Exemple de réponse HTTP
Réponse 200
{
"empty" : true,
"model" : "object",
"modelMap" : {
"string" : "object"
},
"reference" : true,
"status" : "string",
"view" : {
"contentType" : "string"
},
"viewName" : "string"
}
2.3.7. errorHtml
OPTIONS /error
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Consomme
-
application/json
Produit
-
text/html
Exemple de réponse HTTP
Réponse 200
{
"empty" : true,
"model" : "object",
"modelMap" : {
"string" : "object"
},
"reference" : true,
"status" : "string",
"view" : {
"contentType" : "string"
},
"viewName" : "string"
}
2.4. SearchCriteriaHistory
Search Criteria History External Controller $ Mockito Mock $108068997
2.4.1. create
POST /searchcriteriahistory
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Body |
param0 |
param0 |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/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 200
{
"id" : "string",
"name" : "string",
"savingDate" : "string",
"searchCriteriaList" : [ {
"criteriaList" : [ {
"criteria" : "string",
"values" : [ "string" ]
} ],
"nodes" : [ "string" ]
} ],
"userId" : "string"
}
2.4.2. getSearchCriteriaHistory
GET /searchcriteriahistory/me
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
< SearchCriteriaHistoryDto > array |
Exemple de requête HTTP
Requête path
/searchcriteriahistory/me
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.4.3. Update Search criteria history
PUT /searchcriteriahistory/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Body |
param0 |
param0 |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/searchcriteriahistory/{id}
Requête body
{
"id" : "string",
"name" : "string",
"savingDate" : "string",
"searchCriteriaList" : [ {
"criteriaList" : [ {
"criteria" : "string",
"values" : [ "string" ]
} ],
"nodes" : [ "string" ]
} ],
"userId" : "string"
}
2.4.4. delete
DELETE /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
/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. ArchiveUnitsDto
Nom | Description | Schéma |
---|---|---|
archives |
Exemple : |
|
id |
Exemple : |
string |
3.5. FacetBucketDto
Nom | Description | Schéma |
---|---|---|
count |
Exemple : |
integer (int64) |
value |
Exemple : |
string |
3.6. FacetResultsDto
Nom | Description | Schéma |
---|---|---|
buckets |
Exemple : |
< FacetBucketDto > array |
name |
Exemple : |
string |
3.7. FieldsDto
Nom | Description | Schéma |
---|---|---|
Description |
Exemple : |
integer (int32) |
Title |
Exemple : |
integer (int32) |
3.8. 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.9. 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.10. FilterDto
Nom | Description | Schéma |
---|---|---|
$limit |
Exemple : |
integer (int32) |
$orderby |
Exemple : |
3.11. FormatIdentificationModel
Nom | Description | Schéma |
---|---|---|
Encoding |
Exemple : |
string |
FormatId |
Exemple : |
string |
FormatLitteral |
Exemple : |
string |
MimeType |
Exemple : |
string |
3.12. HitsDto
Nom | Description | Schéma |
---|---|---|
limit |
Exemple : |
integer (int32) |
offset |
Exemple : |
integer (int32) |
size |
Exemple : |
integer (int32) |
total |
Exemple : |
integer (int32) |
3.13. InheritedPropertyDto
Nom | Description | Schéma |
---|---|---|
PropertyName |
Exemple : |
string |
PropertyValue |
Exemple : |
object |
3.14. InheritedRuleCategoryDto
Nom | Description | Schéma |
---|---|---|
Properties |
Exemple : |
< InheritedPropertyDto > array |
Rules |
Exemple : |
< RuleDto > array |
3.15. InheritedRulesDto
Nom | Description | Schéma |
---|---|---|
AppraisalRule |
Exemple : |
3.16. InputStream
Type : object
3.17. JsonNode
Type : object
3.18. KeywordDto
Nom | Description | Schéma |
---|---|---|
KeywordContent |
Exemple : |
string |
KeywordReference |
Exemple : |
string |
3.19. ManagementDto
Nom | Description | Schéma |
---|---|---|
AppraisalRule |
Exemple : |
3.20. MeasurementModel
Nom | Description | Schéma |
---|---|---|
dValue |
Exemple : |
number |
dvalue |
Exemple : |
number |
unit |
Exemple : |
string |
3.21. MetadataModel
Nom | Description | Schéma |
---|---|---|
Audio |
Exemple : |
object |
Document |
Exemple : |
object |
Image |
Exemple : |
object |
Text |
Exemple : |
object |
Video |
Exemple : |
object |
3.22. ModelAndView
Nom | Description | Schéma |
---|---|---|
empty |
Exemple : |
boolean |
model |
Exemple : |
object |
modelMap |
Exemple : |
< string, object > map |
reference |
Exemple : |
boolean |
status |
Exemple : |
enum (ACCEPTED, ALREADY_REPORTED, BAD_GATEWAY, BAD_REQUEST, BANDWIDTH_LIMIT_EXCEEDED, CHECKPOINT, CONFLICT, CONTINUE, CREATED, DESTINATION_LOCKED, EXPECTATION_FAILED, FAILED_DEPENDENCY, FORBIDDEN, FOUND, GATEWAY_TIMEOUT, GONE, HTTP_VERSION_NOT_SUPPORTED, IM_USED, INSUFFICIENT_SPACE_ON_RESOURCE, INSUFFICIENT_STORAGE, INTERNAL_SERVER_ERROR, I_AM_A_TEAPOT, LENGTH_REQUIRED, LOCKED, LOOP_DETECTED, METHOD_FAILURE, METHOD_NOT_ALLOWED, MOVED_PERMANENTLY, MOVED_TEMPORARILY, MULTIPLE_CHOICES, MULTI_STATUS, NETWORK_AUTHENTICATION_REQUIRED, NON_AUTHORITATIVE_INFORMATION, NOT_ACCEPTABLE, NOT_EXTENDED, NOT_FOUND, NOT_IMPLEMENTED, NOT_MODIFIED, NO_CONTENT, OK, PARTIAL_CONTENT, PAYLOAD_TOO_LARGE, PAYMENT_REQUIRED, PERMANENT_REDIRECT, PRECONDITION_FAILED, PRECONDITION_REQUIRED, PROCESSING, PROXY_AUTHENTICATION_REQUIRED, REQUESTED_RANGE_NOT_SATISFIABLE, REQUEST_ENTITY_TOO_LARGE, REQUEST_HEADER_FIELDS_TOO_LARGE, REQUEST_TIMEOUT, REQUEST_URI_TOO_LONG, RESET_CONTENT, SEE_OTHER, SERVICE_UNAVAILABLE, SWITCHING_PROTOCOLS, TEMPORARY_REDIRECT, TOO_EARLY, TOO_MANY_REQUESTS, UNAUTHORIZED, UNAVAILABLE_FOR_LEGAL_REASONS, UNPROCESSABLE_ENTITY, UNSUPPORTED_MEDIA_TYPE, UPGRADE_REQUIRED, URI_TOO_LONG, USE_PROXY, VARIANT_ALSO_NEGOTIATES) |
view |
Exemple : |
|
viewName |
Exemple : |
string |
3.23. OrderbyDto
Nom | Description | Schéma |
---|---|---|
TransactedDate |
Exemple : |
integer (int32) |
3.24. 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.25. ProjectionDto
Nom | Description | Schéma |
---|---|---|
$fields |
Exemple : |
3.26. QualifiersDto
Nom | Description | Schéma |
---|---|---|
qualifier |
Exemple : |
string |
versions |
Exemple : |
< VersionsDto > array |
3.27. QueryDTO
Nom | Description | Schéma |
---|---|---|
$filter |
Exemple : |
|
$projection |
Exemple : |
|
$query |
Exemple : |
< JsonNode > array |
$roots |
Exemple : |
< string > array |
3.28. QueryFilter
Nom | Description | Schéma |
---|---|---|
$limit |
Exemple : |
integer (int32) |
$offset |
Exemple : |
integer (int32) |
$orderby |
Exemple : |
< string, integer (int32) > map |
3.29. QueryProjection
Nom | Description | Schéma |
---|---|---|
$fields |
Exemple : |
< string, integer (int32) > map |
3.30. 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.31. 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.32. RuleCategoryDto
Nom | Description | Schéma |
---|---|---|
FinalAction |
Exemple : |
string |
Rules |
Exemple : |
< RuleDto > array |
3.33. RuleDto
Nom | Description | Schéma |
---|---|---|
EndDate |
Exemple : |
string |
Rule |
Exemple : |
string |
StartDate |
Exemple : |
string |
3.34. 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.35. SearchCriteriaElementsDto
Nom | Description | Schéma |
---|---|---|
criteria |
Exemple : |
string |
values |
Exemple : |
< string > array |
3.36. SearchCriteriaEltDto
Nom | Description | Schéma |
---|---|---|
criteria |
Exemple : |
string |
values |
Exemple : |
< string > array |
3.37. SearchCriteriaHistoryDto
Nom | Description | Schéma |
---|---|---|
id |
Exemple : |
string |
name |
Exemple : |
string |
savingDate |
Exemple : |
string (date-time) |
searchCriteriaList |
Exemple : |
< SearchCriteriasDto > array |
userId |
Exemple : |
string |
3.38. SearchCriteriaSort
Nom | Description | Schéma |
---|---|---|
criteria |
Exemple : |
string |
sorting |
Exemple : |
enum (ASC, DESC) |
3.39. SearchCriteriasDto
Nom | Description | Schéma |
---|---|---|
criteriaList |
Exemple : |
< SearchCriteriaElementsDto > array |
nodes |
Exemple : |
< string > array |
3.40. StorageDto
Nom | Description | Schéma |
---|---|---|
strategyId |
Exemple : |
string |
3.41. StorageJson
Nom | Description | Schéma |
---|---|---|
#nbc |
Exemple : |
string |
offerIds |
Exemple : |
< string > array |
strategyId |
Exemple : |
string |
3.42. TitleDto
Nom | Description | Schéma |
---|---|---|
en |
Exemple : |
string |
fr |
Exemple : |
string |
3.43. 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.44. View
Nom | Description | Schéma |
---|---|---|
contentType |
Exemple : |
string |
3.45. VitamSearchRequestDto
Nom | Description | Schéma |
---|---|---|
$filter |
Exemple : |
|
$projection |
Exemple : |
|
$query |
Exemple : |
< QueryDTO > array |
$roots |
Exemple : |
< string > array |
3.46. VitamUIArchiveUnitResponseDto
Nom | Description | Schéma |
---|---|---|
$context |
Exemple : |
|
$facetResults |
Exemple : |
< FacetResultsDto > array |
$hits |
Exemple : |
|
$results |
Exemple : |
< ArchiveUnit > array |
3.47. VitamUISearchResponseDto
Nom | Description | Schéma |
---|---|---|
$context |
Exemple : |
|
$facetResults |
Exemple : |
< FacetResultsDto > array |
$hits |
Exemple : |
|
$results |
Exemple : |
< ResultsDto > array |
3.48. VtagDto
Nom | Description | Schéma |
---|---|---|
Key |
Exemple : |
< string > array |
Value |
Exemple : |
< string > array |
3.49. XtagDto
Nom | Description | Schéma |
---|---|---|
Key |
Exemple : |
< string > array |
Value |
Exemple : |
< string > array |