This documentation page is temporary. When the api will be compliant the the oas v3.1 specification this page will be removed.
Api End Points
- /audit/delivery
- /audit/docunit/{id}
- /audit/lot
- /audit/mapping/{id}
- /audit/project
- /audit/train
- /authorization
- /authorization/{identifier}
- /bibliographicrecord
- /bibliographicrecord/{id}
- /check
- /check/{id}
- /check/auto
- /checkconfiguration
- /checkconfiguration/{id}
- /check/csv/{id}
- /check/lot_csv/{id}
- /check/lot_pdf/{id}
- /check/pdf/{id}
- /checkslip_configuration/{id}
- /condreport
- /condreport/{identifier}
- /condreport_attachment
- /condreport_attachment/{identifier}
- /condreport_desc_prop
- /condreport_desc_prop/{identifier}
- /condreport_desc_value
- /condreport_desc_value/{identifier}
- /condreport_detail
- /condreport_detail/{identifier}
- /condreport_prop_conf
- /condreport_prop_conf/{identifier}
- /condreport/csv
- /condreport/pdf
- /condreportslip_configuration/{id}
- /conf_digital_library
- /conf_digital_library/{id}
- /conf_internet_archive
- /conf_internet_archive/{id}
- /conf_mail
- /conf_mail/{id}
- /conf_omeka
- /conf_omeka/{id}
- /conf_sftp
- /conf_sftp/{id}
- /conf/cineslangcode
- /csvmapping
- /csvmapping/{id}
- /delivery
- /delivery/{id}
- /delivery_configuration/{id}
- /delivery/csv/{id}
- /delivery/lot_csv/{id}
- /delivery/lot_pdf/{id}
- /delivery/pdf/{id}
- /digitaldocument/{identifier}
- /digitaldocument
- /docpropertytype
- /docpropertytype/{id}
- /docunit
- /docunit/{identifier}
- /docunit/initHistory
- /export/cines/{identifier}
- /export/cines
- /export/cines/regenerateMets
- /export/csv
- /export/digitalLibrary
- /export/ead
- /exportftpconfiguration
- /exportftpconfiguration/{id}
- /export/omeka
- /export/rdfxml
- /filecleaning/deleteorphans
- /filesgestionconfig/{idLibrary}
- /filesgestionconfig
- /ftpconfiguration
- /ftpconfiguration/{id}
- /help
- /help/{id}
- /imagemetadata
- /imagemetadata/{id}
- /impdocunit
- /impdocunit/{id}
- /import
- /importreport
- /importreport/{id}
- /internet_archive/{id}
- /internet_archive
- /library
- /library/{id}
- /libraryparameter
- /libraryparameter/{id}
- /lot/{id}
- /lot
- /lot/csv/{id}
- /lot/pdf/{id}
- /mapping
- /mapping/{id}
- /multidelivery/{id}
- /multidelivery
- /numahop
- /oaipmh
- /ocrlangconfiguration
- /ocrlangconfiguration/{id}
- /ocrlanguages
- /physicaldocument/{identifier}
- /physicaldocument
- /project
- /project/{id}
- /role
- /role/{identifier}
- /sample/{id}
- /search
- /statistics
- /statistics/csv
- /statistics/delivery
- /statistics/delivery/csv
- /statistics/docunit
- /statistics/docunit/csv
- /statistics/workflow
- /statistics/workflow/csv
- /template
- /template/{identifier}
- /train
- /train/{id}
- /train/csv/{id}
- /train/pdf/{id}
- /user/{id}
- /user
- /user/dashboard
- /viewer/document/{identifier}/{pageNumber}/{args1}/{args2}/{test}/default.jpg
- /viewer/document/{identifier}/{pageNumber}/full/{dim1}/{dim2}/default.jpg
- /viewer/document/{identifier}/{pageNumber}/info.json
- /viewer/document/{identifier}/manifest
- /viewer/document/{identifier}/master/{pageNumber}
- /viewer/document/{identifier}/master/
- /viewer/document/sample/{identifier}/manifest
- /viewer/document/{identifier}/thumbnail/{pageNumber}/thumb.jpg
- /viewer/document/{identifier}/toc
- /viewsformat
- /viewsformat/{id}
- /workflow/{identifier}
- /workflow
- /workflow_group
- /workflow_group/{id}
- /workflow_model
- /workflow_model/{id}
- /z3950
- /z3950Server
- /z3950Server/{id}
/audit/delivery
GET /audit/delivery?from
Implementation: AuditDeliveryController.java
Required Role(s): DEL_HAB0
Functionality: getRevisions
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| from | LocalDate | no | None |
| library | List<String> | no | None |
| project | List<String> | no | None |
| lot | List<String> | no | None |
Response Body: ResponseEntity<List<AuditDeliveryRevisionDTO>>
/audit/docunit/{id}
Doesn’t respect oas v3.1.
GET /audit/docunit/{id}?rev
Implementation: AuditDocUnitController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: getEntity
Request Body: TODO
Response Body: ResponseEntity<DocUnit>
GET /audit/docunit/{id}
Implementation: AuditDocUnitController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: getRevisions
Request Body: TODO
Response Body: ResponseEntity<List<AuditDocUnitRevisionDTO>>
/audit/lot
GET /audit/lot?from
Implementation: AuditLotController.java
Required Role(s): LOT_HAB3
Functionality: getRevisions
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| from | LocalDate | no | None |
| library | List<String> | no | None |
| project | List<String> | no | None |
Response Body: ResponseEntity<List<AuditLotRevisionDTO>>
/audit/mapping/{id}
Doesn’t respect oas v3.1.
GET /audit/mapping/{id}?rev
Implementation: AuditMappingController.java
Required Role(s): MAP_HAB0
Functionality: getEntity
Request Body: TODO
Response Body: ResponseEntity<Mapping>
GET /audit/mapping/{id}
Implementation: AuditMappingController.java
Required Role(s): MAP_HAB0
Functionality: getRevisions
Request Body: TODO
Response Body: ResponseEntity<List<AuditRevision>>
/audit/project
GET /audit/project?from
Implementation: AuditProjectController.java
Required Role(s): PROJ_HAB7
Functionality: getRevisions
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| from | LocalDate | no | None |
| library | List<String> | no | None |
Response Body: ResponseEntity<List<AuditProjectRevisionDTO>>
/audit/train
GET /audit/train?from
Implementation: AuditTrainController.java
Required Role(s): TRA_HAB3
Functionality: getRevisions
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| from | LocalDate | no | None |
| library | List<String> | no | None |
| project | List<String> | no | None |
Response Body: ResponseEntity<List<AuditTrainRevisionDTO>>
/authorization
Doesn’t respect oas v3.1.
GET /authorization?dto
Implementation: AuthorizationController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: findAllDto
Request Body: TODO
Response Body: ResponseEntity<List<AuthorizationDTO>>
GET /authorization
Implementation: AuthorizationController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: findAll
Request Body: TODO
Response Body: ResponseEntity<List<Authorization>>
/authorization/{identifier}
GET /authorization/{identifier}
Implementation: AuthorizationController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<Authorization>
/bibliographicrecord
Doesn’t respect oas v3.1.
POST /bibliographicrecord
Implementation: BibliographicRecordController.java
Required Role(s): DOC_UNIT_HAB1
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<BibliographicRecordDTO>
POST /bibliographicrecord?delete
Implementation: BibliographicRecordController.java
Required Role(s): DOC_UNIT_HAB3
Functionality: delete
Request Body: TODO
POST /bibliographicrecord?update
Implementation: BibliographicRecordController.java
Required Role(s): DOC_UNIT_HAB2
Functionality: update
Request Body: TODO
GET /bibliographicrecord?search
Implementation: BibliographicRecordController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| search | String | no | None |
| libraries | List<String> | no | None |
| projects | List<String> | no | None |
| lots | List<String> | no | None |
| statuses | List<String> | no | None |
| lastModifiedDateFrom | LocalDate | no | None |
| lastModifiedDateTo | LocalDate | no | None |
| createdDateFrom | LocalDate | no | None |
| createdDateTo | LocalDate | no | None |
| orphan | Boolean | no | None |
| page | Integer | no | 0 |
| size | Integer | no | 10 |
Response Body: ResponseEntity<Page<SimpleBibliographicRecordDTO>>
GET /bibliographicrecord?searchAsList
Implementation: BibliographicRecordController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: searchAsList
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| searchAsList | String | no | None |
| libraries | List<String> | no | None |
| projects | List<String> | no | None |
| lots | List<String> | no | None |
| statuses | List<String> | no | None |
| trains | List<String> | no | None |
| lastModifiedDateFrom | LocalDate | no | None |
| lastModifiedDateTo | LocalDate | no | None |
| createdDateFrom | LocalDate | no | None |
| createdDateTo | LocalDate | no | None |
| orphan | Boolean | no | None |
| page | Integer | no | 0 |
| size | Integer | no | `` |
Response Body: ResponseEntity<Page<SimpleListBibliographicRecordDTO>>
GET /bibliographicrecord?dto
Implementation: BibliographicRecordController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: findAll
Request Body: TODO
Response Body: ResponseEntity<List<SimpleBibliographicRecordDTO>>
GET /bibliographicrecord?all_operations
Implementation: BibliographicRecordController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: findAllOperations
Request Body: TODO
Response Body: ResponseEntity<List<SimpleBibliographicRecordDTO>>
/bibliographicrecord/{id}
Doesn’t respect oas v3.1.
GET /bibliographicrecord/{id}?duplicate
Implementation: BibliographicRecordController.java
Required Role(s): DOC_UNIT_HAB1
Functionality: duplicate
Request Body: TODO
Response Body: ResponseEntity<BibliographicRecordDTO>
GET /bibliographicrecord/{identifier}
Implementation: BibliographicRecordController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<BibliographicRecordDTO>
GET /bibliographicrecord/{identifier}?dc
Implementation: BibliographicRecordController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: getDcById
Request Body: TODO
Response Body: ResponseEntity<BibliographicRecordDcDTO>
GET /bibliographicrecord/{identifier}?lock
Implementation: BibliographicRecordController.java
Required Role(s): DOC_UNIT_HAB2
Functionality: lock
Request Body: TODO
GET /bibliographicrecord/{identifier}?unlock
Implementation: BibliographicRecordController.java
Required Role(s): DOC_UNIT_HAB2
Functionality: unlock
Request Body: TODO
DELETE /bibliographicrecord/{identifier}
Implementation: BibliographicRecordController.java
Required Role(s): DOC_UNIT_HAB3
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<?>
POST /bibliographicrecord/{identifier}
Implementation: BibliographicRecordController.java
Required Role(s): DOC_UNIT_HAB2
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<BibliographicRecordDTO>
/check
GET /check?errors
Implementation: CheckController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getErrors
Request Body: TODO
Response Body: Set<Check.ErrorLabel>
POST /check
Implementation: CheckController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: create
Request Body: TODO
Response Body: CheckDTO
/check/{id}
Doesn’t respect oas v3.1.
POST /check/{id}
Implementation: CheckController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: update
Request Body: TODO
Response Body: CheckDTO
POST /check/{id}?seterrors
Implementation: CheckController.java
Required Role(s): CHECK_HAB4
Functionality: setErrors
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| pageNumber | Integer | no | None |
Response Body: DocErrorReport
POST /check/{id}?setsamplederrors
Implementation: CheckController.java
Required Role(s): CHECK_HAB4
Functionality: setErrorsForSampling
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| pageNumber | Integer | no | None |
Response Body: DocErrorReport
POST /check/{id}?setglobalerrors
Implementation: CheckController.java
Required Role(s): CHECK_HAB4
Functionality: setGlobalErrors
Request Body: TODO
POST /check/{id}?setsampledglobalerrors
Implementation: CheckController.java
Required Role(s): CHECK_HAB4
Functionality: setGlobalErrorsForSampling
Request Body: TODO
GET /check/{id}?geterrors
Implementation: CheckController.java
Required Role(s): CHECK_HAB3
Functionality: getErrors
Request Body: TODO
Response Body: Set<Check.ErrorLabel>
GET /check/{id}?getsamplederrors
Implementation: CheckController.java
Required Role(s): CHECK_HAB3
Functionality: getErrorsForSampling
Request Body: TODO
Response Body: Set<Check.ErrorLabel>
GET /check/{id}?getcondreportforsamplepage
Implementation: CheckController.java
Required Role(s): CHECK_HAB3
Functionality: getCondReportForSamplePage
Request Body: TODO
Response Body: Set<String>
GET /check/{id}?getglobalerrors
Implementation: CheckController.java
Required Role(s): CHECK_HAB3
Functionality: getGlobalErrors
Request Body: TODO
Response Body: Set<Check.ErrorLabel>
GET /check/{id}?getsampledglobalerrors
Implementation: CheckController.java
Required Role(s): CHECK_HAB3
Functionality: getGlobalErrorsForSampling
Request Body: TODO
Response Body: Set<Check.ErrorLabel>
GET /check/{id}?getdocumentallerrors
Implementation: CheckController.java
Required Role(s): CHECK_HAB3
Functionality: getDocumentErrors
Request Body: TODO
Response Body: DocErrorReport
GET /check/{id}?getsampleallerrors
Implementation: CheckController.java
Required Role(s): CHECK_HAB3
Functionality: getSampleErrors
Request Body: TODO
Response Body: DocErrorReport
GET /check/{id}?summaryresults
Implementation: CheckController.java
Required Role(s): CHECK_HAB3
Functionality: getDocumentSummaryResults
Request Body: TODO
Response Body: ResponseEntity<Map<String, Object>>
/check/auto
GET /check/auto?facile
Implementation: AutomaticCheckController.java
Required Role(s): DOC_UNIT_HAB4
Functionality: checkFacile
Request Body: TODO
Response Body: ResponseEntity<?>
/checkconfiguration
Doesn’t respect oas v3.1.
POST /checkconfiguration
Implementation: CheckConfigurationController.java
Required Role(s): CHECK_HAB1
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<CheckConfigurationDTO>
GET /checkconfiguration?search
Implementation: CheckConfigurationController.java
Required Role(s): CHECK_HAB0
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| search | String | no | None |
| libraries | List<String> | no | None |
| page | Integer | no | 0 |
Response Body: ResponseEntity<Page<SimpleCheckConfigurationDTO>>
GET /checkconfiguration?rules
Implementation: CheckConfigurationController.java
Required Role(s): CHECK_HAB0
Functionality: getInitRules
Request Body: TODO
Response Body: ResponseEntity<List<AutomaticCheckRuleDTO>>
GET /checkconfiguration?project
Implementation: CheckConfigurationController.java
Required Role(s): CHECK_HAB0
Functionality: getByProjectId
Request Body: TODO
Response Body: ResponseEntity<List<SimpleCheckConfigurationDTO>>
GET /checkconfiguration?add-radical-controle
Implementation: CheckConfigurationController.java
Required Role(s): CHECK_HAB1
Functionality: updateCheckConfigurationAddRadicalControl
Request Body: TODO
Response Body: ResponseEntity<CheckConfigurationDTO>
/checkconfiguration/{id}
Doesn’t respect oas v3.1.
DELETE /checkconfiguration/{id}
Implementation: CheckConfigurationController.java
Required Role(s): CHECK_HAB2
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<CheckConfigurationDTO>
GET /checkconfiguration/{id}
Implementation: CheckConfigurationController.java
Required Role(s): CHECK_HAB0
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<CheckConfigurationDTO>
GET /checkconfiguration/{id}?edition
Implementation: CheckConfigurationController.java
Required Role(s): CHECK_HAB0
Functionality: getByIdForEdition
Request Body: TODO
Response Body: ResponseEntity<CheckConfigurationDTO>
GET /checkconfiguration/{id}?duplicate
Implementation: CheckConfigurationController.java
Required Role(s): USER_HAB0
Functionality: duplicateCheckConfiguration
Request Body: TODO
Response Body: ResponseEntity<CheckConfigurationDTO>
GET /checkconfiguration/{idDocUnit}?docUnit
Implementation: CheckConfigurationController.java
Required Role(s): USER_HAB0
Functionality: getByDocUnit
Request Body: TODO
Response Body: ResponseEntity<CheckConfigurationDTO>
POST /checkconfiguration/{id}
Implementation: CheckConfigurationController.java
Required Role(s): CHECK_HAB1
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<CheckConfigurationDTO>
/check/csv/{id}
GET /check/csv/{id}
Implementation: CheckController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: generateSlip
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| encoding | String | no | utf-8 |
/check/lot_csv/{id}
GET /check/lot_csv/{id}
Implementation: CheckController.java
Required Role(s):
- CHECK_HAB4
- LOT_HAB0
Functionality: generateCheckSlip
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| encoding | String | no | utf-8 |
/check/lot_pdf/{id}
GET /check/lot_pdf/{id}
Implementation: CheckController.java
Required Role(s):
- CHECK_HAB4
- LOT_HAB0
Functionality: generateCheckSlipPdf
Request Body: TODO
/check/pdf/{id}
GET /check/pdf/{id}
Implementation: CheckController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: generateSlipPdf
Request Body: TODO
/checkslip_configuration/{id}
GET /checkslip_configuration/{id}
Implementation: CheckSlipConfigurationController.java
Required Role(s): DEL_HAB0
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<CheckSlipConfiguration>
POST /checkslip_configuration/{id}
Implementation: CheckSlipConfigurationController.java
Required Role(s): DEL_HAB2
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<CheckSlipConfiguration>
/condreport
Doesn’t respect oas v3.1.
POST /condreport?docUnit
Implementation: ConditionReportController.java
Required Role(s): COND_REPORT_HAB1
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<ConditionReport>
POST /condreport?search
Implementation: ConditionReportController.java
Required Role(s): COND_REPORT_HAB0
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| page | Integer | no | 0 |
| size | Integer | no | `` |
Response Body: ResponseEntity<Page<SearchResult>>
POST /condreport?import-report
Implementation: ConditionReportController.java
Required Role(s): COND_REPORT_HAB1
Functionality: updateReport
Request Body: TODO
Response Body: ResponseEntity<List<ConditionReportImportService.ImportResult>>
GET /condreport?docUnit
Implementation: ConditionReportController.java
Required Role(s): COND_REPORT_HAB0
Functionality: findByDocUnit
Request Body: TODO
Response Body: ResponseEntity<ConditionReport>
GET /condreport?summary&docUnit
Implementation: ConditionReportController.java
Required Role(s): COND_REPORT_HAB0
Functionality: getSummaryByDocUnit
Request Body: TODO
Response Body: ResponseEntity<Set<String>>
GET /condreport?sampleId
Implementation: ConditionReportController.java
Required Role(s): COND_REPORT_HAB0
Functionality: getSummaryBySample
Request Body: TODO
Response Body: ResponseEntity<Set<String>>
GET /condreport?import-template
Implementation: ConditionReportController.java
Required Role(s): COND_REPORT_HAB1
Functionality: getReportImportTemplate
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| import-template | List<String> | no | None |
/condreport/{identifier}
Doesn’t respect oas v3.1.
DELETE /condreport/{identifier}
Implementation: ConditionReportController.java
Required Role(s): COND_REPORT_HAB3
Functionality: delete
Request Body: TODO
GET /condreport/{identifier}
Implementation: ConditionReportController.java
Required Role(s): COND_REPORT_HAB0
Functionality: findByIdentifier
Request Body: TODO
Response Body: ResponseEntity<ConditionReport>
GET /condreport/{id}?exportto
Implementation: ConditionReportController.java
Required Role(s): COND_REPORT_HAB4
Functionality: exportReportOdt
Request Body: TODO
POST /condreport/{identifier}
Implementation: ConditionReportController.java
Required Role(s): COND_REPORT_HAB2
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<ConditionReport>
POST /condreport/{id}?propagate
Implementation: ConditionReportController.java
Required Role(s): COND_REPORT_HAB0
Functionality: propagateReport
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| docUnit | String | no | None |
Response Body: ResponseEntity<?>
/condreport_attachment
GET /condreport_attachment?report
Implementation: ConditionReportAttachmentController.java
Required Role(s): COND_REPORT_HAB0
Functionality: findByReport
Request Body: TODO
Response Body: ResponseEntity<List<ConditionReportAttachment>>
POST /condreport_attachment?report
Implementation: ConditionReportAttachmentController.java
Required Role(s): COND_REPORT_HAB2
Functionality: uploadAttachments
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| file | List<MultipartFile> | no | None |
Response Body: ResponseEntity<List<ConditionReportAttachment>>
/condreport_attachment/{identifier}
Doesn’t respect oas v3.1.
DELETE /condreport_attachment/{identifier}
Implementation: ConditionReportAttachmentController.java
Required Role(s): COND_REPORT_HAB2
Functionality: delete
Request Body: TODO
GET /condreport_attachment/{id}?file
Implementation: ConditionReportAttachmentController.java
Required Role(s): COND_REPORT_HAB0
Functionality: downloadAttachment
Request Body: TODO
GET /condreport_attachment/{id}?thumbnail
Implementation: ConditionReportAttachmentController.java
Required Role(s): COND_REPORT_HAB0
Functionality: downloadThumbnail
Request Body: TODO
/condreport_desc_prop
Doesn’t respect oas v3.1.
POST /condreport_desc_prop
Implementation: DescriptionPropertyController.java
Required Role(s): COND_REPORT_HAB6
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<DescriptionProperty>
GET /condreport_desc_prop
Implementation: DescriptionPropertyController.java
Required Role(s):
- COND_REPORT_HAB0
- COND_REPORT_HAB6
Functionality: findAll
Request Body: TODO
Response Body: ResponseEntity<List<DescriptionProperty>>
GET /condreport_desc_prop?getAllWithFakes
Implementation: DescriptionPropertyController.java
Required Role(s):
- COND_REPORT_HAB0
- COND_REPORT_HAB6
Functionality: getAllWithFakesAndShowCreationByLibrary
Request Body: TODO
Response Body: List<DescriptionProperty>
/condreport_desc_prop/{identifier}
DELETE /condreport_desc_prop/{identifier}
Implementation: DescriptionPropertyController.java
Required Role(s): COND_REPORT_HAB6
Functionality: delete
Request Body: TODO
POST /condreport_desc_prop/{identifier}
Implementation: DescriptionPropertyController.java
Required Role(s): COND_REPORT_HAB6
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<DescriptionProperty>
/condreport_desc_value
POST /condreport_desc_value
Implementation: DescriptionValueController.java
Required Role(s): COND_REPORT_HAB6
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<DescriptionValue>
GET /condreport_desc_value?property
Implementation: DescriptionValueController.java
Required Role(s):
- COND_REPORT_HAB0
- COND_REPORT_HAB6
Functionality: findByProperty
Request Body: TODO
Response Body: ResponseEntity<List<DescriptionValue>>
/condreport_desc_value/{identifier}
DELETE /condreport_desc_value/{identifier}
Implementation: DescriptionValueController.java
Required Role(s): COND_REPORT_HAB6
Functionality: delete
Request Body: TODO
POST /condreport_desc_value/{identifier}
Implementation: DescriptionValueController.java
Required Role(s): COND_REPORT_HAB6
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<DescriptionValue>
/condreport_detail
POST /condreport_detail?type&detail
Implementation: ConditionReportDetailController.java
Required Role(s): COND_REPORT_HAB1
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<ConditionReportDetail>
GET /condreport_detail?report
Implementation: ConditionReportDetailController.java
Required Role(s): COND_REPORT_HAB0
Functionality: findByConditionReport
Request Body: TODO
Response Body: ResponseEntity<List<ConditionReportDetail>>
/condreport_detail/{identifier}
Doesn’t respect oas v3.1.
DELETE /condreport_detail/{identifier}
Implementation: ConditionReportDetailController.java
Required Role(s): COND_REPORT_HAB3
Functionality: delete
Request Body: TODO
GET /condreport_detail/{identifier}
Implementation: ConditionReportDetailController.java
Required Role(s): COND_REPORT_HAB0
Functionality: findByIdentifier
Request Body: TODO
Response Body: ResponseEntity<ConditionReportDetail>
POST /condreport_detail/{identifier}
Implementation: ConditionReportDetailController.java
Required Role(s): COND_REPORT_HAB2
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<ConditionReportDetail>
POST /condreport_detail/{identifier}?confirmvalid
Implementation: ConditionReportDetailController.java
Required Role(s): COND_REPORT_HAB2
Functionality: confirmInitialValid
Request Body: TODO
Response Body: ResponseEntity<ConditionReportDetail>
/condreport_prop_conf
Doesn’t respect oas v3.1.
POST /condreport_prop_conf
Implementation: PropertyConfigurationController.java
Required Role(s): COND_REPORT_HAB5
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<PropertyConfigurationDTO>
GET /condreport_prop_conf?library
Implementation: PropertyConfigurationController.java
Required Role(s): COND_REPORT_HAB0
Functionality: findByLibrary
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | Library | no | None |
Response Body: ResponseEntity<List<PropertyConfigurationDTO>>
GET /condreport_prop_conf?desc&library
Implementation: PropertyConfigurationController.java
Required Role(s): COND_REPORT_HAB0
Functionality: findByDescPropertyAndLibrary
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| desc | DescriptionProperty | no | None |
Response Body: ResponseEntity<PropertyConfigurationDTO>
GET /condreport_prop_conf?internal&library
Implementation: PropertyConfigurationController.java
Required Role(s): COND_REPORT_HAB0
Functionality: findByInternalPropertyAndLibrary
Request Body: TODO
Response Body: ResponseEntity<PropertyConfigurationDTO>
/condreport_prop_conf/{identifier}
POST /condreport_prop_conf/{identifier}
Implementation: PropertyConfigurationController.java
Required Role(s): COND_REPORT_HAB5
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<PropertyConfigurationDTO>
/condreport/csv
GET /condreport/csv
Implementation: ConditionReportController.java
Required Role(s): COND_REPORT_HAB0
Functionality: generateSlip
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| reports | List<String> | no | None |
| encoding | String | no | ISO-8859-15 |
/condreport/pdf
GET /condreport/pdf
Implementation: ConditionReportController.java
Required Role(s): COND_REPORT_HAB0
Functionality: generateSlipPdf
Request Body: TODO
/condreportslip_configuration/{id}
GET /condreportslip_configuration/{id}
Implementation: ConditionReportSlipConfigurationController.java
Required Role(s): DEL_HAB0
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<ConditionReportSlipConfiguration>
POST /condreportslip_configuration/{id}
Implementation: ConditionReportSlipConfigurationController.java
Required Role(s): DEL_HAB2
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<ConditionReportSlipConfiguration>
/conf_digital_library
Doesn’t respect oas v3.1.
POST /conf_digital_library
Implementation: DigitalLibraryConfigurationController.java
Required Role(s): CONF_DIFFUSION_DIGITAL_LIBRARY_HAB1
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<DigitalLibraryConfiguration>
GET /conf_digital_library?configuration&library
Implementation: DigitalLibraryConfigurationController.java
Required Role(s): CONF_DIFFUSION_DIGITAL_LIBRARY_HAB0
Functionality: findByLibrary
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | Library | no | None |
Response Body: ResponseEntity<Set<DigitalLibraryConfigurationDTO>>
GET /conf_digital_library?search
Implementation: DigitalLibraryConfigurationController.java
Required Role(s): CONF_DIFFUSION_DIGITAL_LIBRARY_HAB0
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| search | String | no | None |
| libraries | List<String> | no | None |
| page | Integer | no | 0 |
Response Body: ResponseEntity<Page<DigitalLibraryConfigurationDTO>>
/conf_digital_library/{id}
DELETE /conf_digital_library/{id}
Implementation: DigitalLibraryConfigurationController.java
Required Role(s): CONF_DIFFUSION_OMEKA_HAB2
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<?>
GET /conf_digital_library/{id}
Implementation: DigitalLibraryConfigurationController.java
Required Role(s): CONF_DIFFUSION_DIGITAL_LIBRARY_HAB0
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<DigitalLibraryConfiguration>
POST /conf_digital_library/{id}
Implementation: DigitalLibraryConfigurationController.java
Required Role(s): CONF_DIFFUSION_DIGITAL_LIBRARY_HAB1
Functionality: udpate
Request Body: TODO
Response Body: ResponseEntity<DigitalLibraryConfiguration>
/conf_internet_archive
Doesn’t respect oas v3.1.
POST /conf_internet_archive
Implementation: InternetArchiveConfigurationController.java
Required Role(s): CONF_INTERNET_ARCHIVE_HAB1
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<InternetArchiveConfiguration>
GET /conf_internet_archive?collections
Implementation: InternetArchiveConfigurationController.java
Required Role(s):
- CONF_INTERNET_ARCHIVE_HAB0
- DOC_UNIT_HAB0
Functionality: findIA
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
Response Body: ResponseEntity<Collection<InternetArchiveCollection>>
GET /conf_internet_archive
Implementation: InternetArchiveConfigurationController.java
Required Role(s):
- CONF_INTERNET_ARCHIVE_HAB0
- DOC_UNIT_HAB0
Functionality: findAll
Request Body: TODO
Response Body: ResponseEntity<Collection<InternetArchiveConfigurationDTO>>
GET /conf_internet_archive?configurations&library
Implementation: InternetArchiveConfigurationController.java
Required Role(s): CONF_INTERNET_ARCHIVE_HAB0
Functionality: findByLibrary
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | Library | no | None |
Response Body: ResponseEntity<Set<InternetArchiveConfigurationDTO>>
GET /conf_internet_archive?search
Implementation: InternetArchiveConfigurationController.java
Required Role(s): CONF_INTERNET_ARCHIVE_HAB0
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| search | String | no | None |
| libraries | List<String> | no | None |
| page | Integer | no | 0 |
Response Body: ResponseEntity<Page<InternetArchiveConfigurationDTO>>
/conf_internet_archive/{id}
DELETE /conf_internet_archive/{id}
Implementation: InternetArchiveConfigurationController.java
Required Role(s): CONF_INTERNET_ARCHIVE_HAB2
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<?>
GET /conf_internet_archive/{id}
Implementation: InternetArchiveConfigurationController.java
Required Role(s): CONF_INTERNET_ARCHIVE_HAB0
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<InternetArchiveConfiguration>
POST /conf_internet_archive/{id}
Implementation: InternetArchiveConfigurationController.java
Required Role(s): CONF_INTERNET_ARCHIVE_HAB1
Functionality: udpate
Request Body: TODO
Response Body: ResponseEntity<InternetArchiveConfiguration>
/conf_mail
POST /conf_mail
Implementation: MailboxConfigurationController.java
Required Role(s): MAIL_HAB1
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<MailboxConfiguration>
GET /conf_mail
Implementation: MailboxConfigurationController.java
Required Role(s): MAIL_HAB0
Functionality: search
Request Body: TODO
Response Body: ResponseEntity<Collection<MailboxConfigurationDTO>>
/conf_mail/{id}
DELETE /conf_mail/{id}
Implementation: MailboxConfigurationController.java
Required Role(s): MAIL_HAB2
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<?>
GET /conf_mail/{id}
Implementation: MailboxConfigurationController.java
Required Role(s): MAIL_HAB0
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<MailboxConfiguration>
POST /conf_mail/{id}
Implementation: MailboxConfigurationController.java
Required Role(s): MAIL_HAB1
Functionality: udpate
Request Body: TODO
Response Body: ResponseEntity<MailboxConfiguration>
/conf_omeka
Doesn’t respect oas v3.1.
POST /conf_omeka
Implementation: OmekaConfigurationController.java
Required Role(s): CONF_DIFFUSION_OMEKA_HAB1
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<OmekaConfigurationDTO>
GET /conf_omeka?collections
Implementation: OmekaConfigurationController.java
Required Role(s):
- CONF_DIFFUSION_OMEKA_HAB0
- DOC_UNIT_HAB0
Functionality: findCollections
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| omekaConf | String | no | None |
Response Body: ResponseEntity<Collection<OmekaList>>
GET /conf_omeka?items
Implementation: OmekaConfigurationController.java
Required Role(s):
- CONF_DIFFUSION_OMEKA_HAB0
- DOC_UNIT_HAB0
Functionality: findItems
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| omekaConf | String | no | None |
Response Body: ResponseEntity<Collection<OmekaList>>
GET /conf_omeka
Implementation: OmekaConfigurationController.java
Required Role(s):
- CONF_DIFFUSION_OMEKA_HAB0
- DOC_UNIT_HAB0
Functionality: findAll
Request Body: TODO
Response Body: ResponseEntity<Collection<OmekaConfigurationDTO>>
GET /conf_omeka?configuration&library&project
Implementation: OmekaConfigurationController.java
Required Role(s): CONF_DIFFUSION_OMEKA_HAB0
Functionality: findByLibrary
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | Library | no | None |
| project | Project | no | None |
Response Body: ResponseEntity<Set<OmekaConfigurationDTO>>
GET /conf_omeka?search
Implementation: OmekaConfigurationController.java
Required Role(s): CONF_DIFFUSION_OMEKA_HAB0
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| search | String | no | None |
| libraries | List<String> | no | None |
| omekas | Boolean | no | None |
| page | Integer | no | 0 |
Response Body: ResponseEntity<Page<OmekaConfigurationDTO>>
/conf_omeka/{id}
DELETE /conf_omeka/{id}
Implementation: OmekaConfigurationController.java
Required Role(s): CONF_DIFFUSION_OMEKA_HAB2
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<?>
GET /conf_omeka/{id}
Implementation: OmekaConfigurationController.java
Required Role(s): CONF_DIFFUSION_OMEKA_HAB0
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<OmekaConfigurationDTO>
POST /conf_omeka/{id}
Implementation: OmekaConfigurationController.java
Required Role(s): CONF_DIFFUSION_OMEKA_HAB1
Functionality: udpate
Request Body: TODO
Response Body: ResponseEntity<OmekaConfigurationDTO>
/conf_sftp
Doesn’t respect oas v3.1.
POST /conf_sftp
Implementation: SftpConfigurationController.java
Required Role(s): SFTP_HAB1
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<SftpConfiguration>
GET /conf_sftp?pacs&library
Implementation: SftpConfigurationController.java
Required Role(s):
- SFTP_HAB0
- DOC_UNIT_HAB0
Functionality: findPACS
Request Body: TODO
Response Body: ResponseEntity<Collection<CinesPAC>>
GET /conf_sftp?pacs&configuration
Implementation: SftpConfigurationController.java
Required Role(s):
- SFTP_HAB0
- DOC_UNIT_HAB0
Functionality: findConfigurationPACS
Request Body: TODO
Response Body: ResponseEntity<Collection<CinesPAC>>
GET /conf_sftp
Implementation: SftpConfigurationController.java
Required Role(s): SFTP_HAB0
Functionality: findAll
Request Body: TODO
Response Body: ResponseEntity<Collection<SftpConfigurationDTO>>
GET /conf_sftp?library
Implementation: SftpConfigurationController.java
Required Role(s): SFTP_HAB0
Functionality: findByLibrary
Request Body: TODO
Response Body: ResponseEntity<Set<SftpConfigurationDTO>>
GET /conf_sftp?search
Implementation: SftpConfigurationController.java
Required Role(s): SFTP_HAB0
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| search | String | no | None |
| libraries | List<String> | no | None |
| page | Integer | no | 0 |
Response Body: ResponseEntity<Page<SftpConfigurationDTO>>
/conf_sftp/{id}
Doesn’t respect oas v3.1.
DELETE /conf_sftp/{id}
Implementation: SftpConfigurationController.java
Required Role(s): SFTP_HAB2
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<?>
GET /conf_sftp/{id}
Implementation: SftpConfigurationController.java
Required Role(s): SFTP_HAB0
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<SftpConfiguration>
GET /conf_sftp/{id}?init
Implementation: SftpConfigurationController.java
Required Role(s): SFTP_HAB0
Functionality: initConf
Request Body: TODO
Response Body: ResponseEntity<Map<?, ?>>
POST /conf_sftp/{id}
Implementation: SftpConfigurationController.java
Required Role(s): SFTP_HAB1
Functionality: udpate
Request Body: TODO
Response Body: ResponseEntity<SftpConfiguration>
POST /conf_sftp/{id}?upload
Implementation: SftpConfigurationController.java
Required Role(s): SFTP_HAB1
Functionality: uploadPacs
Request Body: TODO
Response Body: ResponseEntity<SftpConfiguration>
/conf/cineslangcode
GET /conf/cineslangcode
Implementation: CinesLanguageCodeController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getListByActive
Request Body: TODO
Response Body: ResponseEntity<List<CinesLanguageCode>>
POST /conf/cineslangcode
Implementation: CinesLanguageCodeController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<List<CinesLanguageCode>>
/csvmapping
Doesn’t respect oas v3.1.
POST /csvmapping
Implementation: CSVMappingController.java
Required Role(s): MAP_HAB1
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<CSVMapping>
GET /csvmapping
Implementation: CSVMappingController.java
Required Role(s): MAP_HAB0
Functionality: findAll
Request Body: TODO
Response Body: ResponseEntity<Collection<CSVMappingDTO>>
GET /csvmapping?library
Implementation: CSVMappingController.java
Required Role(s): MAP_HAB0
Functionality: findByLibrary
Request Body: TODO
Response Body: ResponseEntity<Set<CSVMappingDTO>>
GET /csvmapping?usable&library
Implementation: CSVMappingController.java
Required Role(s): MAP_HAB0
Functionality: findUsableByLibrary
Request Body: TODO
Response Body: ResponseEntity<Set<CSVMappingDTO>>
GET /csvmapping?usable
Implementation: CSVMappingController.java
Required Role(s): MAP_HAB0
Functionality: findAllUsable
Request Body: TODO
Response Body: ResponseEntity<Collection<CSVMappingDTO>>
/csvmapping/{id}
Doesn’t respect oas v3.1.
DELETE /csvmapping/{id}
Implementation: CSVMappingController.java
Required Role(s): MAP_HAB2
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<?>
GET /csvmapping/{id}
Implementation: CSVMappingController.java
Required Role(s): MAP_HAB0
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<CSVMapping>
GET /csvmapping/{id}?duplicate
Implementation: CSVMappingController.java
Required Role(s): MAP_HAB1
Functionality: duplicateMapping
Request Body: TODO
Response Body: ResponseEntity<CSVMapping>
POST /csvmapping/{id}
Implementation: CSVMappingController.java
Required Role(s): MAP_HAB1
Functionality: udpate
Request Body: TODO
Response Body: ResponseEntity<CSVMapping>
/delivery
Doesn’t respect oas v3.1.
GET /delivery?search
Implementation: DeliveryController.java
Required Role(s): DEL_HAB0
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| search | String | no | None |
| libraries | List<String> | no | None |
| projects | List<String> | no | None |
| lots | List<String> | no | None |
| providers | List<String> | no | None |
| status | List<DeliveryStatus> | no | None |
| deliveryDateFrom | LocalDate | no | None |
| deliveryDateTo | LocalDate | no | None |
| page | Integer | no | 0 |
Response Body: ResponseEntity<Page<SimpleDeliveryDTO>>
GET /delivery?widget&from
Implementation: DeliveryController.java
Required Role(s): DEL_HAB0
Functionality: getDeliveriesForWidget
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| from | LocalDate | no | None |
| library | List<String> | no | None |
| project | List<String> | no | None |
| lot | List<String> | no | None |
Response Body: ResponseEntity<List<AuditDeliveryRevisionDTO>>
GET /delivery?sampledWidget&from
Implementation: DeliveryController.java
Required Role(s): DEL_HAB0
Functionality: getSampledDeliveriesForWidget
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| from | LocalDate | no | None |
| library | List<String> | no | None |
| project | List<String> | no | None |
| lot | List<String> | no | None |
Response Body: ResponseEntity<List<AuditDeliveryRevisionDTO>>
GET /delivery
Implementation: DeliveryController.java
Required Role(s): DEL_HAB0
Functionality: getByLot
Request Body: TODO
Response Body: ResponseEntity<List<SimpleDeliveryDTO>>
GET /delivery?dto
Implementation: DeliveryController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: findAllSimpleDTO
Request Body: TODO
Response Body: ResponseEntity<Collection<SimpleDeliveryDTO>>
GET /delivery?previouscheckslip
Implementation: DeliveryController.java
Required Role(s): DEL_HAB0
Functionality: getPreviousCheckSlips
Request Body: TODO
Response Body: ResponseEntity<Collection<SimpleDeliveryDTO>>
GET /delivery?filterByProjectsLots
Implementation: DeliveryController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getSimpleByProjectsLots
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| filteredProjects | List<String> | no | None |
Response Body: ResponseEntity<Collection<SimpleDeliveryDTO>>
GET /delivery?project
Implementation: DeliveryController.java
Required Role(s): DEL_HAB0
Functionality: findAllForProject
Request Body: TODO
Response Body: ResponseEntity<List<DeliveryDTO>>
GET /delivery?docUnit&latest
Implementation: DeliveryController.java
Required Role(s): DEL_HAB0
Functionality: findLatestDelivery
Request Body: TODO
Response Body: ResponseEntity<DeliveryDTO>
GET /delivery?delivstatus
Implementation: DeliveryController.java
Required Role(s): DEL_HAB0
Functionality: getDeliveryStatus
Request Body: TODO
Response Body: ResponseEntity<Map<String, Object>>
GET /delivery?diskspace&widget
Implementation: DeliveryController.java
Required Role(s): DEL_HAB0
Functionality: getDiskInfos
Request Body: TODO
Response Body: ResponseEntity<Map<String, Long>>
POST /delivery
Implementation: DeliveryController.java
Required Role(s): DEL_HAB1
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<DeliveryDTO>
/delivery/{id}
Doesn’t respect oas v3.1.
POST /delivery/{id}?deliver
Implementation: DeliveryController.java
Required Role(s):
- DEL_HAB5
- DEL_HAB5_2
Functionality: deliver
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| create_docs | boolean | no | false |
Response Body: ResponseEntity<?>
POST /delivery/{id}
Implementation: DeliveryController.java
Required Role(s):
- DEL_HAB2
- DEL_HAB8
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<DeliveryDTO>
POST /delivery/{id}?detachDoc
Implementation: DeliveryController.java
Required Role(s): DEL_HAB8
Functionality: detachDigitalDoc
Request Body: TODO
Response Body: ResponseEntity<DeliveryDTO>
GET /delivery/{id}?predeliver
Implementation: DeliveryController.java
Required Role(s):
- DEL_HAB5
- DEL_HAB5_2
Functionality: predeliver
Request Body: TODO
Response Body: ResponseEntity<PreDeliveryDTO>
GET /delivery/{id}?digitalDocuments
Implementation: DeliveryController.java
Required Role(s): DEL_HAB0
Functionality: getSimpleDigitalDocuments
Request Body: TODO
Response Body: ResponseEntity<List<SimpleDeliveredDigitalDocDTO>>
GET /delivery/{id}?deliverySample
Implementation: DeliveryController.java
Required Role(s): DEL_HAB0
Functionality: getSample
Request Body: TODO
Response Body: ResponseEntity<SampleDTO>
GET /delivery/{id}?checkConfig
Implementation: DeliveryController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getActiveCheckConfig
Request Body: TODO
Response Body: ResponseEntity<CheckConfigurationDTO>
GET /delivery/{id}?deliveryReport
Implementation: DeliveryController.java
Required Role(s): DEL_HAB0
Functionality: getDeliveryReport
Request Body: TODO
Response Body: ResponseEntity<?>
GET /delivery/{id}
Implementation: DeliveryController.java
Required Role(s): DEL_HAB0
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<DeliveryDTO>
GET /delivery/{id}?duplicate
Implementation: DeliveryController.java
Required Role(s):
- DEL_HAB2
- DEL_HAB8
Functionality: duplicate
Request Body: TODO
Response Body: ResponseEntity<DeliveryDTO>
GET /delivery/{id}?forViewer
Implementation: DeliveryController.java
Required Role(s): DEL_HAB0
Functionality: getSimpleForViewer
Request Body: TODO
Response Body: ResponseEntity<SimpleDeliveryForViewerDTO>
GET /delivery/{id}?delivprogress
Implementation: DeliveryController.java
Required Role(s): DEL_HAB0
Functionality: getDeliveryProgress
Request Body: TODO
Response Body: ResponseEntity<List<String>>
DELETE /delivery/{id}
Implementation: DeliveryController.java
Required Role(s): DEL_HAB3
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<?>
/delivery_configuration/{id}
GET /delivery_configuration/{id}
Implementation: DeliveryConfigurationController.java
Required Role(s): DEL_HAB0
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<DeliverySlipConfiguration>
POST /delivery_configuration/{id}
Implementation: DeliveryConfigurationController.java
Required Role(s): DEL_HAB2
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<DeliverySlipConfiguration>
/delivery/csv/{id}
GET /delivery/csv/{id}
Implementation: DeliveryController.java
Required Role(s): DEL_HAB0
Functionality: generateSlipCSV
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| encoding | String | no | None |
/delivery/lot_csv/{id}
GET /delivery/lot_csv/{id}
Implementation: DeliveryController.java
Required Role(s): DEL_HAB0
Functionality: generateSlipLotCSV
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| encoding | String | no | None |
/delivery/lot_pdf/{id}
GET /delivery/lot_pdf/{id}
Implementation: DeliveryController.java
Required Role(s): DEL_HAB0
Functionality: generateSlipLotPDF
Request Body: TODO
/delivery/pdf/{id}
GET /delivery/pdf/{id}
Implementation: DeliveryController.java
Required Role(s): DEL_HAB0
Functionality: generateSlipPDF
Request Body: TODO
/digitaldocument/{identifier}
Doesn’t respect oas v3.1.
GET /digitaldocument/{identifier}?thumbnail
Implementation: DigitalDocumentController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getThumbnailById
Request Body: TODO
Response Body: ResponseEntity<?>
GET /digitaldocument/{identifier}?view
Implementation: DigitalDocumentController.java
Required Role(s): CHECK_HAB3
Functionality: getViewById
Request Body: TODO
Response Body: ResponseEntity<?>
GET /digitaldocument/{identifier}
Implementation: DigitalDocumentController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: getByIdWithPageCount
Request Body: TODO
Response Body: ResponseEntity<DigitalDocumentDTO>
GET /digitaldocument/{identifier}?docUnit
Implementation: DigitalDocumentController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getConfigurationCheck
Request Body: TODO
Response Body: ResponseEntity<CheckConfigurationDTO>
GET /digitaldocument/{identifier}?deliverynotes
Implementation: DigitalDocumentController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getDeliveryNotes
Request Body: TODO
Response Body: ResponseEntity<Map<String, String>>
GET /digitaldocument/{identifier}?filename
Implementation: DigitalDocumentController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getFilename
Request Body: TODO
Response Body: ResponseEntity<String>
GET /digitaldocument/{identifier}?masterPdfInfos
Implementation: DigitalDocumentController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: getMasterPdfInfos
Request Body: TODO
Response Body: ResponseEntity<String[]>
GET /digitaldocument/{identifier}?metadata
Implementation: DigitalDocumentController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getMetadataForFiles
Request Body: TODO
Response Body: ResponseEntity<Map<String, Map<String, String>>>
GET /digitaldocument/{identifier}?samplemetadata
Implementation: DigitalDocumentController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getMetadataForSample
Request Body: TODO
Response Body: ResponseEntity<Map<String, Map<String, String>>>
GET /digitaldocument/{identifier}?filenamesErrors
Implementation: DigitalDocumentController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getFilenamesWithErrors
Request Body: TODO
Response Body: ResponseEntity<List<String>>
GET /digitaldocument/{identifier}?filesErrors
Implementation: DigitalDocumentController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getFileNumbersWithErrors
Request Body: TODO
Response Body: ResponseEntity<List<Integer>>
GET /digitaldocument/{identifier}?page
Implementation: DigitalDocumentController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getPage
Request Body: TODO
Response Body: ResponseEntity<SimpleDocPageDTO>
GET /digitaldocument/{identifier}?nbPieces
Implementation: DigitalDocumentController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getPiecesNumber
Request Body: TODO
Response Body: ResponseEntity<Map<String, String>>
POST /digitaldocument/{identifier}?checksOK&sampling
Implementation: DigitalDocumentController.java
Required Role(s): CHECK_HAB4
Functionality: endChecks
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| checksOK | boolean | no | None |
Response Body: ResponseEntity<?>
POST /digitaldocument/{identifier}
Implementation: DigitalDocumentController.java
Required Role(s): DOC_UNIT_HAB2
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<DigitalDocumentDTO>
/digitaldocument
Doesn’t respect oas v3.1.
GET /digitaldocument?toCheck
Implementation: DigitalDocumentController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: getAllDocumentsToCheck
Request Body: TODO
Response Body: ResponseEntity<Collection<SimpleDigitalDocumentDTO>>
GET /digitaldocument?search
Implementation: DigitalDocumentController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| search | String | no | None |
| status | List<String> | no | None |
| libraries | List<String> | no | None |
| projects | List<String> | no | None |
| lots | List<String> | no | None |
| trains | List<String> | no | None |
| deliveries | List<String> | no | None |
| page | Integer | no | 0 |
| dateFrom | LocalDate | no | None |
| dateTo | LocalDate | no | None |
| dateLimitFrom | LocalDate | no | None |
| dateLimitTo | LocalDate | no | None |
| searchPgcnId | String | no | None |
| searchTitre | String | no | None |
| searchRadical | String | no | None |
| fileFormats | List<String> | no | None |
| maxAngles | List<String> | no | None |
| searchPageFrom | Integer | no | None |
| searchPageTo | Integer | no | None |
| searchPageCheckFrom | Long | no | None |
| searchPageCheckTo | Long | no | None |
| searchMinSize | Double | no | None |
| searchMaxSize | Double | no | None |
| validated | boolean | no | None |
| size | Integer | no | `` |
Response Body: ResponseEntity<Page<SimpleListDigitalDocumentDTO>>
/docpropertytype
Doesn’t respect oas v3.1.
GET /docpropertytype
Implementation: DocPropertyTypeController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: findAll
Request Body: TODO
Response Body: ResponseEntity<List<DocPropertyType>>
GET /docpropertytype?dto
Implementation: DocPropertyTypeController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: findAllDto
Request Body: TODO
Response Body: ResponseEntity<List<DocPropertyTypeDTO>>
GET /docpropertytype?customOnly
Implementation: DocPropertyTypeController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: findAllCustomDto
Request Body: TODO
Response Body: ResponseEntity<List<DocPropertyTypeDTO>>
GET /docpropertytype?dto&supertype
Implementation: DocPropertyTypeController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: findAllBySuperType
Request Body: TODO
Response Body: ResponseEntity<List<DocPropertyTypeDTO>>
POST /docpropertytype
Implementation: DocPropertyTypeController.java
Required Role(s): DOC_UNIT_HAB5
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<DocPropertyType>
/docpropertytype/{id}
GET /docpropertytype/{id}
Implementation: DocPropertyTypeController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<DocPropertyType>
DELETE /docpropertytype/{id}
Implementation: DocPropertyTypeController.java
Required Role(s): DOC_UNIT_HAB5
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<DocPropertyType>
POST /docpropertytype/{id}
Implementation: DocPropertyTypeController.java
Required Role(s): DOC_UNIT_HAB5
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<DocPropertyType>
/docunit
Doesn’t respect oas v3.1.
POST /docunit
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB1
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<DocUnitDTO>
POST /docunit?delete
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB3
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<Collection<DocUnitDeletedReportDTO>>
POST /docunit?updateselection
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB2
Functionality: updateSelection
Request Body: TODO
Response Body: ResponseEntity<List<DocUnitUpdateErrorDTO>>
POST /docunit?deleteDocUnitsProject
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB3
Functionality: deleteDocUnitsProject
Request Body: TODO
Response Body: ResponseEntity<Collection<DocUnitDeletedReportDTO>>
POST /docunit?removeAllFromLot
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB3
Functionality: removeAllFromLot
Request Body: TODO
POST /docunit?unlink
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB3
Functionality: unlink
Request Body: TODO
Response Body: ResponseEntity<Collection<DocUnitDeletedReportDTO>>
POST /docunit?createProjectFromDoc
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB3
Functionality: createProjectFromDoc
Request Body: TODO
POST /docunit?searchAsList
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: searchAsList
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| page | Integer | no | 0 |
| size | Integer | no | `` |
Response Body: ResponseEntity<Page<SimpleListDocUnitDTO>>
POST /docunit?searchAsMinList
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: searchAsMinList
Request Body: TODO
Response Body: ResponseEntity<List<MinimalListDocUnitDTO>>
POST /docunit?projectAndLot
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB2
Functionality: setProjectLotAndTrain
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| project | String | no | None |
| lot | String | no | None |
POST /docunit?setTrain
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB2
Functionality: setTrain
Request Body: TODO
Response Body: ResponseEntity<?>
POST /docunit?addchild
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB2
Functionality: addChildren
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| parent | String | no | None |
Response Body: ResponseEntity<DocUnitDTO>
POST /docunit?removechild
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB2
Functionality: removeChildren
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| parent | String | no | None |
Response Body: ResponseEntity<DocUnitDTO>
POST /docunit?addsibling
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB2
Functionality: addSibling
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| siblingid | String | no | None |
Response Body: ResponseEntity<DocUnitDTO>
POST /docunit?removesibling
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB2
Functionality: removeSibling
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| siblingid | String | no | None |
Response Body: ResponseEntity<DocUnitDTO>
GET /docunit?search
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| search | String | no | None |
| hasDigitalDocuments | boolean | no | false |
| active | boolean | no | true |
| archived | boolean | no | false |
| nonArchived | boolean | no | false |
| archivable | boolean | no | false |
| nonArchivable | boolean | no | false |
| distributed | boolean | no | false |
| nonDistributed | boolean | no | false |
| distributable | boolean | no | false |
| nonDistributable | boolean | no | false |
| libraries | List<String> | no | None |
| projects | List<String> | no | None |
| lots | List<String> | no | None |
| statuses | List<String> | no | None |
| lastModifiedDateFrom | LocalDate | no | None |
| lastModifiedDateTo | LocalDate | no | None |
| createdDateFrom | LocalDate | no | None |
| createdDateTo | LocalDate | no | None |
| page | Integer | no | 0 |
| size | Integer | no | `` |
Response Body: ResponseEntity<Page<SimpleDocUnitDTO>>
GET /docunit?searchAllForProject&project
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: searchAllForProject
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| project | String | no | None |
| page | Integer | no | 0 |
Response Body: ResponseEntity<Page<SummaryDocUnitWithLotDTO>>
GET /docunit?dto
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: findAllDTO
Request Body: TODO
Response Body: ResponseEntity<List<SimpleDocUnitDTO>>
GET /docunit?project
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: findAllForProject
Request Body: TODO
Response Body: ResponseEntity<List<SummaryDocUnitWithLotDTO>>
GET /docunit?lot
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: findAllForLot
Request Body: TODO
Response Body: ResponseEntity<List<SummaryDocUnitDTO>>
GET /docunit?parent
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: getChildrenByParentId
Request Body: TODO
Response Body: ResponseEntity<List<DocUnitDTO>>
GET /docunit?sibling
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: getSiblingsByDocUnitId
Request Body: TODO
Response Body: ResponseEntity<List<DocUnitDTO>>
GET /docunit?export
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB4
Functionality: massExport
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| docs | List<String> | no | None |
| types | List<String> | no | METS,VIEW |
GET /docunit?export_ftp
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB4
Functionality: massExportFtp
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| docs | List<String> | no | None |
Response Body: ResponseEntity<?>
/docunit/{identifier}
Doesn’t respect oas v3.1.
DELETE /docunit/{identifier}
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB3
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<DocUnitDeletedReportDTO>
GET /docunit/{identifier}
Implementation: DocUnitController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<DocUnitDTO>
GET /docunit/{identifier}?lock
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB2
Functionality: lock
Request Body: TODO
GET /docunit/{identifier}?unlock
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB2
Functionality: unlock
Request Body: TODO
POST /docunit/{identifier}
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB2
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<DocUnitDTO>
POST /docunit/{identifier}?removeProject
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB2
Functionality: removeFromProject
Request Body: TODO
Response Body: ResponseEntity<?>
POST /docunit/{identifier}?removeLot
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB2
Functionality: removeLot
Request Body: TODO
Response Body: ResponseEntity<?>
POST /docunit/{identifier}?removeTrain
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB2
Functionality: removeTrain
Request Body: TODO
Response Body: ResponseEntity<?>
POST /docunit/{identifier}?inactiveDoc
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB2
Functionality: inactive
Request Body: TODO
Response Body: ResponseEntity<DocUnitDTO>
/docunit/initHistory
GET /docunit/initHistory
Implementation: DocUnitController.java
Required Role(s): DOC_UNIT_HAB3
Functionality: initDocCheckHistory
Request Body: TODO
Response Body: ResponseEntity<?>
/export/cines/{identifier}
GET /export/cines/{identifier}?export
Implementation: ExportCinesController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: getDcById
Request Body: TODO
Response Body: ResponseEntity<BibliographicRecordDcDTO>
POST /export/cines/{id}?save
Implementation: ExportCinesController.java
Required Role(s): DOC_UNIT_HAB4
Functionality: saveExportData
Request Body: TODO
Response Body: ResponseEntity<?>
/export/cines
Doesn’t respect oas v3.1.
POST /export/cines?send&dc
Implementation: ExportCinesController.java
Required Role(s): DOC_UNIT_HAB4
Functionality: exportDocUnitToCinesWithDc
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| docUnit | String | no | None |
| conf | SftpConfiguration | no | None |
| reversion | boolean | no | false |
Response Body: ResponseEntity<CinesReport>
POST /export/cines?send&ead
Implementation: ExportCinesController.java
Required Role(s): DOC_UNIT_HAB4
Functionality: exportDocUnitToCinesWithEad
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| docUnit | String | no | None |
| conf | SftpConfiguration | no | None |
Response Body: ResponseEntity<CinesReport>
GET /export/cines?check_mailbox
Implementation: ExportCinesController.java
Required Role(s): DOC_UNIT_HAB4
Functionality: checkMailbox
Request Body: TODO
Response Body: ResponseEntity<?>
GET /export/cines?aip&docUnit
Implementation: ExportCinesController.java
Required Role(s): DOC_UNIT_HAB4
Functionality: getAip
Request Body: TODO
Response Body: ResponseEntity<?>
GET /export/cines?sip&docUnit
Implementation: ExportCinesController.java
Required Role(s): DOC_UNIT_HAB4
Functionality: getSip
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| docUnit | String | no | None |
Response Body: ResponseEntity<?>
GET /export/cines?mets&docUnit
Implementation: ExportCinesController.java
Required Role(s): DOC_UNIT_HAB4
Functionality: getMets
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| docUnit | String | no | None |
Response Body: ResponseEntity<?>
GET /export/cines?mass_export
Implementation: ExportCinesController.java
Required Role(s): DOC_UNIT_HAB4
Functionality: massExport
Request Body: TODO
Response Body: ResponseEntity<?>
/export/cines/regenerateMets
GET /export/cines/regenerateMets
Implementation: ExportCinesController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: regenerateMets
Request Body: TODO
Response Body: ResponseEntity<?>
/export/csv
Doesn’t respect oas v3.1.
GET /export/csv?docUnit
Implementation: ExportController.java
Required Role(s): DOC_UNIT_HAB4
Functionality: exportDocUnitToCsv
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| docUnit | List<String> | no | None |
| field | List<String> | no | None |
| docfield | List<String> | no | None |
| bibfield | List<String> | no | None |
| physfield | List<String> | no | None |
| encoding | String | no | ISO-8859-15 |
GET /export/csv?lot
Implementation: ExportController.java
Required Role(s): DOC_UNIT_HAB4
Functionality: exportLotToCsv
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| lot | String | no | None |
| field | List<String> | no | None |
| docfield | List<String> | no | None |
| bibfield | List<String> | no | None |
| physfield | List<String> | no | None |
| encoding | String | no | ISO-8859-15 |
/export/digitalLibrary
POST /export/digitalLibrary?send
Implementation: DigitalLibraryDiffusionController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: exportDocUnitToDigitalLibrary
Request Body: TODO
Response Body: ResponseEntity<?>
GET /export/digitalLibrary?mass_export
Implementation: DigitalLibraryDiffusionController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: massExport
Request Body: TODO
Response Body: ResponseEntity<HttpStatus>
/export/ead
GET /export/ead
Implementation: ExportController.java
Required Role(s): DOC_UNIT_HAB4
Functionality: getEad
Request Body: TODO
/exportftpconfiguration
Doesn’t respect oas v3.1.
POST /exportftpconfiguration
Implementation: ExportFTPConfigurationController.java
Required Role(s): EXP_FTP_HAB1
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<ExportFTPConfigurationDTO>
GET /exportftpconfiguration?search
Implementation: ExportFTPConfigurationController.java
Required Role(s): EXP_FTP_HAB0
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| search | String | no | None |
| libraries | List<String> | no | None |
| page | Integer | no | 0 |
Response Body: ResponseEntity<Page<SimpleExportFTPConfDTO>>
GET /exportftpconfiguration?project&fullConfig
Implementation: ExportFTPConfigurationController.java
Required Role(s): EXP_FTP_HAB0
Functionality: getByProjectId
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| project | String | no | None |
Response Body: ResponseEntity<List<? extends AbstractDTO>>
GET /exportftpconfiguration?libraryId
Implementation: ExportFTPConfigurationController.java
Required Role(s): EXP_FTP_HAB0
Functionality: getByLibraryId
Request Body: TODO
Response Body: ResponseEntity<List<? extends AbstractDTO>>
/exportftpconfiguration/{id}
DELETE /exportftpconfiguration/{id}
Implementation: ExportFTPConfigurationController.java
Required Role(s): EXP_FTP_HAB2
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<ExportFTPConfigurationDTO>
GET /exportftpconfiguration/{id}
Implementation: ExportFTPConfigurationController.java
Required Role(s): EXP_FTP_HAB0
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<ExportFTPConfigurationDTO>
POST /exportftpconfiguration/{id}
Implementation: ExportFTPConfigurationController.java
Required Role(s): EXP_FTP_HAB1
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<ExportFTPConfigurationDTO>
/export/omeka
POST /export/omeka?sendomeka
Implementation: ExportOmekaController.java
Required Role(s): DOC_UNIT_HAB4
Functionality: exportDocUnitToOmekaWithDc
Request Body: TODO
Response Body: ResponseEntity<?>
GET /export/omeka?mass_export
Implementation: ExportOmekaController.java
Required Role(s): DOC_UNIT_HAB4
Functionality: massExport
Request Body: TODO
Response Body: ResponseEntity<HttpStatus>
/export/rdfxml
GET /export/rdfxml
Implementation: ExportController.java
Required Role(s): DOC_UNIT_HAB4
Functionality: exportDocUnitToRdfxml
Request Body: TODO
/filecleaning/deleteorphans
GET /filecleaning/deleteorphans
Implementation: FileCleaningController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: cleanOrphanFiles
Request Body: TODO
/filesgestionconfig/{idLibrary}
GET /filesgestionconfig/{idLibrary}
Implementation: FilesGestionConfigController.java
Required Role(s): FILES_GEST_HAB0
Functionality: getByLibrary
Request Body: TODO
Response Body: ResponseEntity<FilesGestionConfigDTO>
POST /filesgestionconfig/{id}
Implementation: FilesGestionConfigController.java
Required Role(s): FILES_GEST_HAB0
Functionality: saveConfig
Request Body: TODO
Response Body: ResponseEntity<FilesGestionConfigDTO>
/filesgestionconfig
POST /filesgestionconfig
Implementation: FilesGestionConfigController.java
Required Role(s): FILES_GEST_HAB0
Functionality: createConfig
Request Body: TODO
Response Body: ResponseEntity<FilesGestionConfigDTO>
/ftpconfiguration
Doesn’t respect oas v3.1.
POST /ftpconfiguration
Implementation: FTPConfigurationController.java
Required Role(s): FTP_HAB1
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<FTPConfigurationDTO>
GET /ftpconfiguration?search
Implementation: FTPConfigurationController.java
Required Role(s): FTP_HAB0
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| search | String | no | None |
| libraries | List<String> | no | None |
| page | Integer | no | 0 |
Response Body: ResponseEntity<Page<SimpleFTPConfigurationDTO>>
GET /ftpconfiguration?project
Implementation: FTPConfigurationController.java
Required Role(s): FTP_HAB0
Functionality: getByProjectId
Request Body: TODO
Response Body: ResponseEntity<List<SimpleFTPConfigurationDTO>>
/ftpconfiguration/{id}
DELETE /ftpconfiguration/{id}
Implementation: FTPConfigurationController.java
Required Role(s): FTP_HAB2
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<FTPConfigurationDTO>
GET /ftpconfiguration/{id}
Implementation: FTPConfigurationController.java
Required Role(s): FTP_HAB0
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<FTPConfigurationDTO>
POST /ftpconfiguration/{id}
Implementation: FTPConfigurationController.java
Required Role(s): FTP_HAB1
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<FTPConfigurationDTO>
/help
Doesn’t respect oas v3.1.
GET /help
Implementation: HelpPageController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| modules | List<String> | no | None |
| types | List<HelpPageType> | no | None |
Response Body: ResponseEntity<List<ModuleDto>>
GET /help?tag
Implementation: HelpPageController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: searchByTag
Request Body: TODO
Response Body: ResponseEntity<HelpPageDto>
GET /help?modulelist
Implementation: HelpPageController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: findAllLevels
Request Body: TODO
Response Body: ResponseEntity<List<String>>
POST /help
Implementation: HelpPageController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<HelpPage>
/help/{id}
GET /help/{id}
Implementation: HelpPageController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<HelpPage>
POST /help/{id}
Implementation: HelpPageController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: save
Request Body: TODO
Response Body: ResponseEntity<HelpPage>
DELETE /help/{id}
Implementation: HelpPageController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: delete
Request Body: TODO
/imagemetadata
Doesn’t respect oas v3.1.
GET /imagemetadata
Implementation: ImageMetadataController.java
Required Role(s): DOC_UNIT_HAB5
Functionality: findAll
Request Body: TODO
Response Body: ResponseEntity<List<ImageMetadataProperty>>
GET /imagemetadata?getMetaValues
Implementation: ImageMetadataController.java
Required Role(s): DOC_UNIT_HAB5
Functionality: getMetaValues
Request Body: TODO
Response Body: ResponseEntity<List<ImageMetadataValue>>
POST /imagemetadata
Implementation: ImageMetadataController.java
Required Role(s): DOC_UNIT_HAB5
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<ImageMetadataProperty>
POST /imagemetadata?saveList
Implementation: ImageMetadataController.java
Required Role(s): DOC_UNIT_HAB5
Functionality: saveList
Request Body: TODO
Response Body: ResponseEntity<List<ImageMetadataProperty>>
POST /imagemetadata?saveValues
Implementation: ImageMetadataController.java
Required Role(s): DOC_UNIT_HAB5
Functionality: saveValues
Request Body: TODO
Response Body: ResponseEntity<List<ImageMetadataValue>>
/imagemetadata/{id}
POST /imagemetadata/{id}
Implementation: ImageMetadataController.java
Required Role(s): DOC_UNIT_HAB5
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<ImageMetadataProperty>
/impdocunit
GET /impdocunit?report
Implementation: ImportedDocUnitController.java
Required Role(s): EXC_HAB0
Functionality: findByImportReport
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| errors | boolean | no | false |
Response Body: ResponseEntity<Page<ImportedDocUnit>>
/impdocunit/{id}
POST /impdocunit/{id}?process
Implementation: ImportedDocUnitController.java
Required Role(s): EXC_HAB2
Functionality: updateProcess
Request Body: TODO
Response Body: ResponseEntity<?>
/import
Doesn’t respect oas v3.1.
POST /import?mapping
Implementation: ImportController.java
Required Role(s): EXC_HAB2
Functionality: importFile
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| file | List<MultipartFile> | no | None |
| format | FileFormat | no | None |
| encoding | DataEncoding | no | UTF_8 |
| mapping | String | no | None |
| mappingChildren | String | no | None |
| parent | String | no | None |
| library | String | no | None |
| project | String | no | None |
| lot | String | no | None |
| join | String | no | None |
| validation | boolean | no | false |
| dedup | boolean | no | false |
| archivable | boolean | no | false |
| distributable | boolean | no | false |
Response Body: ResponseEntity<ImportReport>
POST /import?import
Implementation: ImportController.java
Required Role(s): EXC_HAB2
Functionality: importPreimportedDocUnits
Request Body: TODO
Response Body: ResponseEntity<ImportReport>
/importreport
Doesn’t respect oas v3.1.
GET /importreport?search
Implementation: ImportReportController.java
Required Role(s): EXC_HAB0
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| search | String | no | None |
| users | List<String> | no | None |
| page | Integer | no | 0 |
Response Body: ResponseEntity<Page<ImportReport>>
GET /importreport
Implementation: ImportReportController.java
Required Role(s): EXC_HAB0
Functionality: findAll
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| page | int | no | 0 |
| size | int | no | 10 |
Response Body: ResponseEntity<Page<ImportReport>>
/importreport/{id}
Doesn’t respect oas v3.1.
GET /importreport/{id}
Implementation: ImportReportController.java
Required Role(s): EXC_HAB0
Functionality: findOne
Request Body: TODO
Response Body: ResponseEntity<ImportReport>
GET /importreport/{id}?status
Implementation: ImportReportController.java
Required Role(s): EXC_HAB0
Functionality: getStatus
Request Body: TODO
Response Body: ResponseEntity<Map<String, Object>>
GET /importreport/{id}?hasfile
Implementation: ImportReportController.java
Required Role(s): EXC_HAB0
Functionality: hasImportFile
Request Body: TODO
Response Body: ResponseEntity<Map<?, ?>>
GET /importreport/{id}?file
Implementation: ImportReportController.java
Required Role(s): EXC_HAB0
Functionality: downloadImportFile
Request Body: TODO
Response Body: ResponseEntity<?>
DELETE /importreport/{id}
Implementation: ImportReportController.java
Required Role(s): EXC_HAB1
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<?>
/internet_archive/{id}
Doesn’t respect oas v3.1.
GET /internet_archive/{id}?prepare_item
Implementation: ExportInternetArchiveController.java
Required Role(s): EXPORT_INTERNET_ARCHIVE_HAB0
Functionality: prepare
Request Body: TODO
Response Body: ResponseEntity<InternetArchiveItemDTO>
POST /internet_archive/{id}?create
Implementation: ExportInternetArchiveController.java
Required Role(s): EXPORT_INTERNET_ARCHIVE_HAB0
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<?>
POST /internet_archive/{id}?save
Implementation: ExportInternetArchiveController.java
Required Role(s): EXPORT_INTERNET_ARCHIVE_HAB0
Functionality: save
Request Body: TODO
Response Body: ResponseEntity<?>
/internet_archive
GET /internet_archive?mass_export
Implementation: ExportInternetArchiveController.java
Required Role(s): EXPORT_INTERNET_ARCHIVE_HAB0
Functionality: massExport
Request Body: TODO
/library
Doesn’t respect oas v3.1.
POST /library
Implementation: LibraryController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<LibraryDTO>
GET /library?dto
Implementation: LibraryController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: findAllDTO
Request Body: TODO
Response Body: ResponseEntity<Collection<SimpleLibraryDTO>>
GET /library?search
Implementation: LibraryController.java
Required Role(s):
- LIB_HAB5
- LIB_HAB6
- LIB_HAB7
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| search | String | no | None |
| initiale | String | no | None |
| institutions | List<String> | no | None |
| isActive | boolean | no | true |
| page | Integer | no | 0 |
Response Body: ResponseEntity<Page<SimpleLibraryDTO>>
/library/{id}
Doesn’t respect oas v3.1.
DELETE /library/{id}
Implementation: LibraryController.java
Required Role(s): LIB_HAB3
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<Library>
DELETE /library/{id}?logo
Implementation: LibraryController.java
Required Role(s): LIB_HAB2
Functionality: deleteLogo
Request Body: TODO
GET /library/{id}?dto
Implementation: LibraryController.java
Required Role(s):
- LIB_HAB5
- LIB_HAB6
- LIB_HAB7
Functionality: getDtoById
Request Body: TODO
Response Body: ResponseEntity<LibraryDTO>
GET /library/{id}
Implementation: LibraryController.java
Required Role(s):
- LIB_HAB5
- LIB_HAB6
- LIB_HAB7
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<LibraryDTO>
GET /library/{id}?providers
Implementation: LibraryController.java
Required Role(s):
- LIB_HAB5
- LIB_HAB6
- LIB_HAB7
Functionality: getProviders
Request Body: TODO
Response Body: ResponseEntity<Collection<SimpleUserDTO>>
GET /library/{id}?users
Implementation: LibraryController.java
Required Role(s):
- LIB_HAB5
- LIB_HAB6
- LIB_HAB7
Functionality: getUsers
Request Body: TODO
Response Body: ResponseEntity<Collection<SimpleUserDTO>>
GET /library/{id}?logo
Implementation: LibraryController.java
Required Role(s):
- LIB_HAB5
- LIB_HAB6
- LIB_HAB7
Functionality: downloadLogo
Request Body: TODO
GET /library/{id}?thumbnail
Implementation: LibraryController.java
Required Role(s):
- LIB_HAB5
- LIB_HAB6
- LIB_HAB7
Functionality: downloadThumbnail
Request Body: TODO
GET /library/{id}?logoexists
Implementation: LibraryController.java
Required Role(s):
- LIB_HAB5
- LIB_HAB6
- LIB_HAB7
Functionality: hasLogo
Request Body: TODO
Response Body: ResponseEntity<Map<?, ?>>
POST /library/{id}
Implementation: LibraryController.java
Required Role(s): LIB_HAB2
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<LibraryDTO>
POST /library/{id}?logo
Implementation: LibraryController.java
Required Role(s): LIB_HAB2
Functionality: uploadLogo
Request Body: TODO
/libraryparameter
POST /libraryparameter
Implementation: LibraryParameterController.java
Required Role(s): LIB_HAB1
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<LibraryParameterValuedDTO>
GET /libraryparameter?cinesdefaultvalues
Implementation: LibraryParameterController.java
Required Role(s):
- LIB_HAB5
- LIB_HAB6
- LIB_HAB7
Functionality: getCinesDefaultValuesByLibrary
Request Body: TODO
Response Body: ResponseEntity<LibraryParameterValuedDTO>
/libraryparameter/{id}
DELETE /libraryparameter/{id}
Implementation: LibraryParameterController.java
Required Role(s): LIB_HAB3
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<LibraryParameter>
GET /libraryparameter/{id}
Implementation: LibraryParameterController.java
Required Role(s):
- LIB_HAB5
- LIB_HAB6
- LIB_HAB7
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<LibraryParameterDTO>
POST /libraryparameter/{id}
Implementation: LibraryParameterController.java
Required Role(s): LIB_HAB2
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<LibraryParameterValuedDTO>
/lot/{id}
Doesn’t respect oas v3.1.
DELETE /lot/{id}
Implementation: LotController.java
Required Role(s): LOT_HAB2
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<LotDTO>
GET /lot/{id}
Implementation: LotController.java
Required Role(s): LOT_HAB3
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<LotDTO>
GET /lot/{id}?dto
Implementation: LotController.java
Required Role(s): LOT_HAB3
Functionality: getDtoById
Request Body: TODO
Response Body: ResponseEntity<LotDTO>
POST /lot/{id}?unlinkProject
Implementation: LotController.java
Required Role(s): LOT_HAB1
Functionality: unlinkProject
Request Body: TODO
Response Body: ResponseEntity<?>
POST /lot/{id}?validate
Implementation: LotController.java
Required Role(s): LOT_HAB4
Functionality: validateLot
Request Body: TODO
Response Body: ResponseEntity<?>
POST /lot/{id}
Implementation: LotController.java
Required Role(s): LOT_HAB1
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<LotDTO>
/lot
Doesn’t respect oas v3.1.
POST /lot?delete
Implementation: LotController.java
Required Role(s): LOT_HAB2
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<Lot>
POST /lot?search
Implementation: LotController.java
Required Role(s): LOT_HAB3
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| page | Integer | no | 0 |
| size | Integer | no | 10 |
Response Body: ResponseEntity<Page<SimpleLotDTO>>
POST /lot
Implementation: LotController.java
Required Role(s): LOT_HAB0
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<LotDTO>
POST /lot?project
Implementation: LotController.java
Required Role(s): LOT_HAB1
Functionality: setProject
Request Body: TODO
POST /lot?cloturelot
Implementation: LotController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: closeLot
Request Body: TODO
Response Body: ResponseEntity<List<ResultAdminLotDTO>>
POST /lot?decloturelot
Implementation: LotController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: declotureLot
Request Body: TODO
Response Body: ResponseEntity<List<ResultAdminLotDTO>>
GET /lot?search
Implementation: LotController.java
Required Role(s): LOT_HAB3
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| search | String | no | None |
| libraries | List<String> | no | None |
| projects | List<String> | no | None |
| active | boolean | no | true |
| docNumber | Integer | no | None |
| fileFormat | List<String> | no | None |
| page | Integer | no | 0 |
| size | Integer | no | 10 |
Response Body: ResponseEntity<Page<SimpleLotDTO>>
GET /lot?widget&from
Implementation: LotController.java
Required Role(s): LOT_HAB3
Functionality: getLotsForWidget
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| from | LocalDate | no | None |
| library | List<String> | no | None |
| project | List<String> | no | None |
Response Body: ResponseEntity<List<AuditLotRevisionDTO>>
GET /lot?simpleByProject&project
Implementation: LotController.java
Required Role(s): LOT_HAB3
Functionality: findAllSimpleForProject
Request Body: TODO
Response Body: ResponseEntity<List<SimpleLotDTO>>
GET /lot?filterByProjects&projectIds
Implementation: LotController.java
Required Role(s): LOT_HAB3
Functionality: findAllIdentifiersForProjects
Request Body: TODO
Response Body: ResponseEntity<List<SimpleLotDTO>>
GET /lot?dto&libraries
Implementation: LotController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: findAllActiveByLibraries
Request Body: TODO
Response Body: ResponseEntity<Collection<LotListDTO>>
GET /lot?dto&projects
Implementation: LotController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: findAllActiveByProjects
Request Body: TODO
Response Body: ResponseEntity<Collection<LotListDTO>>
GET /lot?dto&complete&libraries
Implementation: LotController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: findAllByLibraries
Request Body: TODO
Response Body: ResponseEntity<Collection<LotListDTO>>
GET /lot?dto&complete&projects
Implementation: LotController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: findAllByProjects
Request Body: TODO
Response Body: ResponseEntity<Collection<LotListDTO>>
GET /lot?project
Implementation: LotController.java
Required Role(s): LOT_HAB3
Functionality: findAllForProject
Request Body: TODO
Response Body: ResponseEntity<List<LotDTO>>
GET /lot?project&simpleForDocUnit
Implementation: LotController.java
Required Role(s): LOT_HAB3
Functionality: findSimpleForDocUnit
Request Body: TODO
Response Body: ResponseEntity<List<LotDTO>>
GET /lot?dto&lot
Implementation: LotController.java
Required Role(s): LOT_HAB3
Functionality: getDtoByIds
Request Body: TODO
Response Body: ResponseEntity<List<LotDTO>>
GET /lot?dto
Implementation: LotController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: findAllDTO
Request Body: TODO
Response Body: ResponseEntity<Collection<LotListDTO>>
/lot/csv/{id}
GET /lot/csv/{id}
Implementation: LotController.java
Required Role(s): COND_REPORT_HAB0
Functionality: generateSlip
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| encoding | String | no | None |
/lot/pdf/{id}
GET /lot/pdf/{id}
Implementation: LotController.java
Required Role(s): COND_REPORT_HAB0
Functionality: generateSlipPdf
Request Body: TODO
/mapping
Doesn’t respect oas v3.1.
POST /mapping
Implementation: MappingController.java
Required Role(s): MAP_HAB1
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<Mapping>
POST /mapping?import&library
Implementation: MappingController.java
Required Role(s): MAP_HAB1
Functionality: importNewMapping
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | String | no | None |
Response Body: ResponseEntity<Mapping>
GET /mapping
Implementation: MappingController.java
Required Role(s): MAP_HAB0
Functionality: findByLibraryAndType
Request Body: TODO
Response Body: ResponseEntity<Collection<MappingDTO>>
GET /mapping?usable&library
Implementation: MappingController.java
Required Role(s): MAP_HAB0
Functionality: findUsableByLibrary
Request Body: TODO
Response Body: ResponseEntity<Set<MappingDTO>>
GET /mapping?usable
Implementation: MappingController.java
Required Role(s): MAP_HAB0
Functionality: findAllUsable
Request Body: TODO
Response Body: ResponseEntity<Collection<MappingDTO>>
/mapping/{id}
Doesn’t respect oas v3.1.
DELETE /mapping/{id}
Implementation: MappingController.java
Required Role(s): MAP_HAB2
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<?>
GET /mapping/{id}
Implementation: MappingController.java
Required Role(s): MAP_HAB0
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<Mapping>
GET /mapping/{id}?duplicate
Implementation: MappingController.java
Required Role(s): MAP_HAB1
Functionality: duplicate
Request Body: TODO
Response Body: ResponseEntity<Mapping>
GET /mapping/{id}?export
Implementation: MappingController.java
Required Role(s): MAP_HAB0
Functionality: exportMapping
Request Body: TODO
POST /mapping/{id}
Implementation: MappingController.java
Required Role(s): MAP_HAB1
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<Mapping>
POST /mapping/{id}?import
Implementation: MappingController.java
Required Role(s): MAP_HAB1
Functionality: importMapping
Request Body: TODO
Response Body: ResponseEntity<Mapping>
/multidelivery/{id}
Doesn’t respect oas v3.1.
GET /multidelivery/{id}?predeliver
Implementation: MultiLotsDeliveryController.java
Required Role(s): DEL_HAB5
Functionality: predeliver
Request Body: TODO
Response Body: ResponseEntity<Map<String, PreDeliveryDTO>>
GET /multidelivery/{id}
Implementation: MultiLotsDeliveryController.java
Required Role(s): DEL_HAB0
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<MultiLotsDeliveryDTO>
GET /multidelivery/{id}?digitalDocuments
Implementation: MultiLotsDeliveryController.java
Required Role(s): DEL_HAB0
Functionality: getSimpleDigitalDocuments
Request Body: TODO
Response Body: ResponseEntity<Map<String, List<SimpleDeliveredDigitalDocDTO>>>
POST /multidelivery/{id}?deliver
Implementation: MultiLotsDeliveryController.java
Required Role(s):
- DEL_HAB5
- DEL_HAB5_2
Functionality: deliver
Request Body: TODO
Response Body: ResponseEntity<?>
POST /multidelivery/{id}
Implementation: MultiLotsDeliveryController.java
Required Role(s):
- DEL_HAB2
- DEL_HAB8
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<MultiLotsDeliveryDTO>
DELETE /multidelivery/{id}
Implementation: MultiLotsDeliveryController.java
Required Role(s): DEL_HAB3
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<?>
/multidelivery
GET /multidelivery?search
Implementation: MultiLotsDeliveryController.java
Required Role(s): DEL_HAB0
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| search | String | no | None |
| libraries | List<String> | no | None |
| projects | List<String> | no | None |
| lots | List<String> | no | None |
| providers | List<String> | no | None |
| deliveryDateFrom | LocalDate | no | None |
| deliveryDateTo | LocalDate | no | None |
| page | Integer | no | 0 |
Response Body: ResponseEntity<Page<MultiLotsDeliveryDTO>>
POST /multidelivery
Implementation: MultiLotsDeliveryController.java
Required Role(s): DEL_HAB1
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<MultiLotsDeliveryDTO>
/numahop
GET /numahop?build
Implementation: NumahopController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getBuild
Request Body: TODO
Response Body: ResponseEntity<Map<String, Object>>
/oaipmh
Doesn’t respect oas v3.1.
GET /oaipmh?identify
Implementation: OaiPmhController.java
Required Role(s): EXC_HAB2
Functionality: checkServer
Request Body: TODO
Response Body: ResponseEntity<IdentifyType>
GET /oaipmh?listIdentifiers
Implementation: OaiPmhController.java
Required Role(s): EXC_HAB2
Functionality: checkQuery
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| baseUrl | String | no | None |
| from | String | no | None |
| to | String | no | None |
Response Body: ResponseEntity<Map<String, String>>
POST /oaipmh
Implementation: OaiPmhController.java
Required Role(s): EXC_HAB2
Functionality: importOaiPmh
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | String | no | None |
| project | String | no | None |
| lot | String | no | None |
| validation | boolean | no | false |
| dedup | boolean | no | false |
| baseUrl | String | no | None |
| from | String | no | None |
| to | String | no | None |
Response Body: ResponseEntity<ImportReport>
/ocrlangconfiguration
POST /ocrlangconfiguration
Implementation: OcrLangConfigurationController.java
Required Role(s): OCR_LANG_HAB1
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<OcrLangConfigurationDTO>
GET /ocrlangconfiguration?search
Implementation: OcrLangConfigurationController.java
Required Role(s): OCR_LANG_HAB0
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| search | String | no | None |
| libraries | List<String> | no | None |
| page | Integer | no | 0 |
Response Body: ResponseEntity<Page<SimpleOcrLangConfigDTO>>
/ocrlangconfiguration/{id}
DELETE /ocrlangconfiguration/{id}
Implementation: OcrLangConfigurationController.java
Required Role(s): OCR_LANG_HAB2
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<?>
GET /ocrlangconfiguration/{id}
Implementation: OcrLangConfigurationController.java
Required Role(s): OCR_LANG_HAB0
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<OcrLangConfigurationDTO>
POST /ocrlangconfiguration/{id}
Implementation: OcrLangConfigurationController.java
Required Role(s): OCR_LANG_HAB1
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<OcrLangConfigurationDTO>
/ocrlanguages
Doesn’t respect oas v3.1.
GET /ocrlanguages?languages
Implementation: OcrLanguageController.java
Required Role(s): OCR_LANG_HAB0
Functionality: search
Request Body: TODO
Response Body: ResponseEntity<List<OcrLanguageDTO>>
GET /ocrlanguages?langs
Implementation: OcrLanguageController.java
Required Role(s): OCR_LANG_HAB0
Functionality: getLangs
Request Body: TODO
Response Body: ResponseEntity<List<OcrLanguageDTO>>
/physicaldocument/{identifier}
GET /physicaldocument/{identifier}
Implementation: PhysicalDocumentController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<PhysicalDocumentDTO>
POST /physicaldocument/{identifier}
Implementation: PhysicalDocumentController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<PhysicalDocumentDTO>
/physicaldocument
Doesn’t respect oas v3.1.
GET /physicaldocument?train
Implementation: PhysicalDocumentController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: findByTrainIdentifier
Request Body: TODO
Response Body: ResponseEntity<List<ListPhysicalDocumentDTO>>
GET /physicaldocument?trainDocUnits
Implementation: PhysicalDocumentController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: findByDocUnitIdentifiers
Request Body: TODO
Response Body: ResponseEntity<List<ListPhysicalDocumentDTO>>
/project
Doesn’t respect oas v3.1.
POST /project
Implementation: ProjectController.java
Required Role(s): PROJ_HAB0
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<ProjectDTO>
POST /project?delete
Implementation: ProjectController.java
Required Role(s): PROJ_HAB4
Functionality: delete
Request Body: TODO
GET /project?search
Implementation: ProjectController.java
Required Role(s): PROJ_HAB7
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| search | String | no | None |
| initiale | String | no | None |
| active | boolean | no | true |
| libraries | List<String> | no | None |
| status | List<ProjectStatus> | no | None |
| provider | List<String> | no | None |
| page | Integer | no | 0 |
Response Body: ResponseEntity<Page<SimpleProjectDTO>>
GET /project?searchProject
Implementation: ProjectController.java
Required Role(s): PROJ_HAB7
Functionality: searchProject
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| searchProject | String | no | None |
| initiale | String | no | None |
| active | boolean | no | true |
| libraries | List<String> | no | None |
Response Body: ResponseEntity<List<SimpleProjectDTO>>
GET /project?widget&from
Implementation: ProjectController.java
Required Role(s): PROJ_HAB7
Functionality: getProjectsForWidget
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| from | LocalDate | no | None |
| library | List<String> | no | None |
Response Body: ResponseEntity<List<AuditProjectRevisionDTO>>
GET /project?dto
Implementation: ProjectController.java
Required Role(s): PROJ_HAB7
Functionality: findAllActiveDTO
Request Body: TODO
Response Body: ResponseEntity<Collection<SimpleProjectDTO>>
GET /project?dto&libraries
Implementation: ProjectController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: findAllActiveDTO
Request Body: TODO
Response Body: ResponseEntity<Collection<SimpleProjectDTO>>
GET /project?dto2
Implementation: ProjectController.java
Required Role(s): PROJ_HAB7
Functionality: findAllDTO
Request Body: TODO
Response Body: ResponseEntity<Collection<SimpleProjectDTO>>
GET /project?dto2&libraries
Implementation: ProjectController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: findAllDTO
Request Body: TODO
Response Body: ResponseEntity<Collection<SimpleProjectDTO>>
/project/{id}
Doesn’t respect oas v3.1.
DELETE /project/{id}
Implementation: ProjectController.java
Required Role(s): PROJ_HAB4
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<ProjectDTO>
POST /project/{id}?idDocs
Implementation: ProjectController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: addDocUnits
Request Body: TODO
Response Body: ResponseEntity<?>
POST /project/{id}?idLibraries
Implementation: ProjectController.java
Required Role(s): PROJ_HAB3
Functionality: addLibraries
Request Body: TODO
Response Body: ResponseEntity<?>
POST /project/{id}
Implementation: ProjectController.java
Required Role(s): PROJ_HAB1
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<ProjectDTO>
POST /project/{id}?cancelProj
Implementation: ProjectController.java
Required Role(s): PROJ_HAB6
Functionality: cancelProject
Request Body: TODO
Response Body: ResponseEntity<ProjectDTO>
POST /project/{id}?suspendProj
Implementation: ProjectController.java
Required Role(s): PROJ_HAB5
Functionality: suspendProject
Request Body: TODO
Response Body: ResponseEntity<ProjectDTO>
POST /project/{id}?reactivProj
Implementation: ProjectController.java
Required Role(s): PROJ_HAB5
Functionality: reactivateProject
Request Body: TODO
Response Body: ResponseEntity<ProjectDTO>
GET /project/{id}
Implementation: ProjectController.java
Required Role(s): PROJ_HAB7
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<ProjectDTO>
/role
Doesn’t respect oas v3.1.
POST /role
Implementation: RoleController.java
Required Role(s): ROLE_HAB1
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<Role>
GET /role?search
Implementation: RoleController.java
Required Role(s): USER_HAB0
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| search | String | no | None |
Response Body: ResponseEntity<List<RoleDTO>>
GET /role?dto
Implementation: RoleController.java
Required Role(s):
- ROLE_HAB0
- USER_HAB0
- LIB_HAB5
Functionality: findAll
Request Body: TODO
Response Body: ResponseEntity<List<RoleDTO>>
GET /role
Implementation: RoleController.java
Required Role(s):
- ROLE_HAB0
- LIB_HAB5
Functionality: findAll
Request Body: TODO
Response Body: ResponseEntity<List<Role>>
/role/{identifier}
DELETE /role/{identifier}
Implementation: RoleController.java
Required Role(s): ROLE_HAB3
Functionality: delete
Request Body: TODO
GET /role/{identifier}
Implementation: RoleController.java
Required Role(s): ROLE_HAB0
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<Role>
POST /role/{identifier}
Implementation: RoleController.java
Required Role(s): ROLE_HAB2
Functionality: udpate
Request Body: TODO
Response Body: ResponseEntity<Role>
/sample/{id}
GET /sample/{id}
Implementation: SampleController.java
Required Role(s): DEL_HAB0
Functionality: getSample
Request Body: TODO
Response Body: ResponseEntity<SampleDTO>
/search
Doesn’t respect oas v3.1.
GET /search?index
Implementation: SearchController.java
Required Role(s): SUPER_ADMIN
Functionality: index
Request Body: TODO
GET /search?search
Implementation: SearchController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| page | Integer | no | 0 |
| size | Integer | no | 10 |
| get | List<SearchEntity> | no | DOCUNIT |
| fuzzy | boolean | no | true |
Response Body: ResponseEntity<Map<SearchEntity, Page<?>>>
GET /search?suggest
Implementation: SearchController.java
Required Role(s): DOC_UNIT_HAB0
Functionality: suggest
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| suggest | String | no | None |
Response Body: ResponseEntity<List<Map<String, Object>>>
/statistics
Doesn’t respect oas v3.1.
GET /statistics?projectList
Implementation: StatisticsController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: projectList
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| search | String | no | None |
| projects | List<String> | no | None |
| from | LocalDate | no | None |
| to | LocalDate | no | None |
| page | Integer | no | 0 |
| size | Integer | no | 10 |
Response Body: ResponseEntity<Page<StatisticsProjectDTO>>
GET /statistics?projectGroupByStatus
Implementation: StatisticsController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getProjectGroupByStatus
Request Body: TODO
Response Body: ResponseEntity<List<Map<String, Object>>>
GET /statistics?lotGroupByStatus
Implementation: StatisticsController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getLotGroupByStatus
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| libraries | List<String> | no | None |
Response Body: ResponseEntity<List<Map<String, Object>>>
GET /statistics?projectProgress
Implementation: StatisticsController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getProjectProgress
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| project | List<String> | no | None |
| from | LocalDate | no | None |
| to | LocalDate | no | None |
| page | Integer | no | 0 |
Response Body: ResponseEntity<Page<StatisticsProgressDTO>>
GET /statistics?lotProgress
Implementation: StatisticsController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getLotProgress
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| project | List<String> | no | None |
| from | LocalDate | no | None |
| to | LocalDate | no | None |
| page | Integer | no | 0 |
Response Body: ResponseEntity<Page<StatisticsProgressDTO>>
GET /statistics?trainGroupByStatus
Implementation: StatisticsController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getTrainGroupByStatus
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| libraries | List<String> | no | None |
Response Body: ResponseEntity<List<Map<String, Object>>>
GET /statistics?docunitGroupByStatus
Implementation: StatisticsController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getDocUnitsGroupByStatus
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| libraries | List<String> | no | None |
| project | List<String> | no | None |
Response Body: ResponseEntity<List<Map<String, Object>>>
GET /statistics?userGroupByLibrary
Implementation: StatisticsController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getUsersGroupByLibrary
Request Body: TODO
Response Body: ResponseEntity<List<Map<String, Object>>>
GET /statistics?provider_train
Implementation: StatisticsController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getProviderTrainStats
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| project | List<String> | no | None |
| train | List<String> | no | None |
| returnFrom | LocalDate | no | None |
| returnTo | LocalDate | no | None |
| sendFrom | LocalDate | no | None |
| sendTo | LocalDate | no | None |
| insuranceFrom | Double | no | None |
Response Body: ResponseEntity<List<StatisticsProviderTrainDTO>>
/statistics/csv
Doesn’t respect oas v3.1.
GET /statistics/csv?provider_train
Implementation: StatisticsCsvController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getProviderTrainStats
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| project | List<String> | no | None |
| train | List<String> | no | None |
| returnFrom | LocalDate | no | None |
| returnTo | LocalDate | no | None |
| sendFrom | LocalDate | no | None |
| sendTo | LocalDate | no | None |
| insuranceFrom | Double | no | None |
| insuranceTo | Double | no | None |
| encoding | String | no | ISO-8859-15 |
GET /statistics/csv?lotProgress
Implementation: StatisticsCsvController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getLotProgress
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| project | List<String> | no | None |
| from | LocalDate | no | None |
| to | LocalDate | no | None |
| encoding | String | no | ISO-8859-15 |
GET /statistics/csv?projectProgress
Implementation: StatisticsCsvController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getProjectProgress
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| project | List<String> | no | None |
| from | LocalDate | no | None |
| to | LocalDate | no | None |
| encoding | String | no | ISO-8859-15 |
/statistics/delivery
GET /statistics/delivery?provider_delivery
Implementation: StatisticsDeliveryController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getProviderDeliveryStats
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| provider | List<String> | no | None |
| from | LocalDate | no | None |
Response Body: ResponseEntity<List<StatisticsProviderDeliveryDTO>>
/statistics/delivery/csv
GET /statistics/delivery/csv?provider_delivery
Implementation: StatisticsDeliveryCsvController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getProviderDeliveryStats
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| provider | List<String> | no | None |
| from | LocalDate | no | None |
| to | LocalDate | no | None |
| encoding | String | no | ISO-8859-15 |
/statistics/docunit
Doesn’t respect oas v3.1.
GET /statistics/docunit?count
Implementation: StatisticsDocUnitController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getDocUnitList
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| libraries | List<String> | no | None |
| project | List<String> | no | None |
| lot | List<String> | no | None |
| page | Integer | no | 0 |
Response Body: ResponseEntity<Page<StatisticsDocUnitCountDTO>>
GET /statistics/docunit?countStatus
Implementation: StatisticsDocUnitController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getDocUnitStatusRatio
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| project | String | no | None |
| lot | String | no | None |
Response Body: ResponseEntity<StatisticsDocUnitStatusRatioDTO>
GET /statistics/docunit?average
Implementation: StatisticsDocUnitController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getDocUnitAverages
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| project | List<String> | no | None |
| lot | List<String> | no | None |
| delivery | List<String> | no | None |
| from | LocalDate | no | None |
| to | LocalDate | no | None |
Response Body: ResponseEntity<List<StatisticsDocUnitAverageDTO>>
GET /statistics/docunit?export
Implementation: StatisticsDocUnitController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getExportedDocUnitList
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| libraries | List<String> | no | None |
| from | LocalDate | no | None |
Response Body: ResponseEntity<List<StatisticsProcessedDocUnitDTO>>
GET /statistics/docunit?archive
Implementation: StatisticsDocUnitController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getArchivedDocUnitList
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| libraries | List<String> | no | None |
| from | LocalDate | no | None |
Response Body: ResponseEntity<List<StatisticsProcessedDocUnitDTO>>
GET /statistics/docunit?checkdelay
Implementation: StatisticsDocUnitController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getCheckDelayStatisitics
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| libraries | List<String> | no | None |
| project | List<String> | no | None |
| lot | List<String> | no | None |
| delivery | List<String> | no | None |
Response Body: ResponseEntity<?>
GET /statistics/docunit?doc_published
Implementation: StatisticsDocUnitController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getDocPublishedStat
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| project | List<String> | no | None |
| lot | List<String> | no | None |
| from | LocalDate | no | None |
| to | LocalDate | no | None |
| type | List<String> | no | None |
| collection | List<String> | no | None |
| page | Integer | no | 0 |
Response Body: ResponseEntity<Page<StatisticsDocPublishedDTO>>
GET /statistics/docunit?doc_rejected
Implementation: StatisticsDocUnitController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getDocRejectedStat
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| project | List<String> | no | None |
| provider | List<String> | no | None |
| from | LocalDate | no | None |
| to | LocalDate | no | None |
| page | Integer | no | 0 |
Response Body: ResponseEntity<Page<StatisticsDocRejectedDTO>>
GET /statistics/docunit?doc_types
Implementation: StatisticsDocUnitController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getDocUnitTypes
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| search | String | no | None |
| page | Integer | no | 0 |
Response Body: ResponseEntity<Page<String>>
/statistics/docunit/csv
Doesn’t respect oas v3.1.
GET /statistics/docunit/csv?average
Implementation: StatisticsDocUnitCsvController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getDocUnitAverages
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| project | List<String> | no | None |
| lot | List<String> | no | None |
| delivery | List<String> | no | None |
| from | LocalDate | no | None |
| to | LocalDate | no | None |
| encoding | String | no | ISO-8859-15 |
GET /statistics/docunit/csv?doc_published
Implementation: StatisticsDocUnitCsvController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getDocPublishedStat
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| project | List<String> | no | None |
| lot | List<String> | no | None |
| from | LocalDate | no | None |
| to | LocalDate | no | None |
| type | List<String> | no | None |
| collection | List<String> | no | None |
| encoding | String | no | ISO-8859-15 |
GET /statistics/docunit/csv?doc_rejected
Implementation: StatisticsDocUnitCsvController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getDocRejectedStat
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| project | List<String> | no | None |
| provider | List<String> | no | None |
| from | LocalDate | no | None |
| to | LocalDate | no | None |
| encoding | String | no | ISO-8859-15 |
/statistics/workflow
Doesn’t respect oas v3.1.
GET /statistics/workflow?wdelivery
Implementation: StatisticsWorkflowController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getWorkflowDeliveryProgressStatistics
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| project | List<String> | no | None |
| lot | List<String> | no | None |
| delivery | List<String> | no | None |
| pgcnid | String | no | None |
| state | List<WorkflowStateKey> | no | None |
| from | LocalDate | no | None |
| to | LocalDate | no | None |
| page | int | no | 0 |
Response Body: ResponseEntity<Page<WorkflowDeliveryProgressDTO>>
GET /statistics/workflow?wcontrol
Implementation: StatisticsWorkflowController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getWorkflowDocUnitStateControl
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| project | List<String> | no | None |
| lot | List<String> | no | None |
| state | List<DigitalDocumentStatus> | no | None |
Response Body: ResponseEntity<List<WorkflowDocUnitProgressDTO>>
GET /statistics/workflow?wdocunit
Implementation: StatisticsWorkflowController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getWorkflowDocUnitProgressStatistics
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| project | List<String> | no | None |
| project_active | boolean | no | false |
| lot | List<String> | no | None |
| train | List<String> | no | None |
| pgcnid | String | no | None |
| state | List<WorkflowStateKey> | no | None |
| status | List<WorkflowStateStatus> | no | None |
| mine | boolean | no | false |
| from | LocalDate | no | None |
| to | LocalDate | no | None |
| page | int | no | 0 |
Response Body: ResponseEntity<Page<WorkflowDocUnitProgressDTO>>
GET /statistics/workflow?wdocunitpending
Implementation: StatisticsWorkflowController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getWorkflowDocUnitProgressStatisticsLight
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| project | List<String> | no | None |
| project_active | boolean | no | false |
| lot | List<String> | no | None |
| train | List<String> | no | None |
| pgcnid | String | no | None |
| state | List<WorkflowStateKey> | no | None |
| status | List<WorkflowStateStatus> | no | None |
| mine | boolean | no | false |
| from | LocalDate | no | None |
| to | LocalDate | no | None |
| page | int | no | 0 |
Response Body: ResponseEntity<List<WorkflowDocUnitProgressDTOPending>>
GET /statistics/workflow?wdocunit¤t
Implementation: StatisticsWorkflowController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getWorkflowDocUnitCurrentStatistics
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| project | List<String> | no | None |
| lot | List<String> | no | None |
| state | List<WorkflowStateKey> | no | None |
Response Body: ResponseEntity<List<WorkflowDocUnitProgressDTO>>
GET /statistics/workflow?wstate
Implementation: StatisticsWorkflowController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getWorkflowStatesStatistics
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| workflow | List<String> | no | None |
| state | List<WorkflowStateKey> | no | None |
| from | LocalDate | no | None |
Response Body: ResponseEntity<List<WorkflowStateProgressDTO>>
GET /statistics/workflow?wuser
Implementation: StatisticsWorkflowController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getWorkflowUsersStatistics
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| project | List<String> | no | None |
| lot | List<String> | no | None |
| delivery | List<String> | no | None |
| from | LocalDate | no | None |
Response Body: ResponseEntity<Collection<WorkflowUserProgressDTO>>
GET /statistics/workflow?wprofile_activity
Implementation: StatisticsWorkflowController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getProfilesActivityStatistics
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| project | List<String> | no | None |
| lot | List<String> | no | None |
| state | List<WorkflowStateKey> | no | None |
| role | List<String> | no | None |
Response Body: ResponseEntity<Collection<WorkflowProfileActivityDTO>>
GET /statistics/workflow?wuser_activity
Implementation: StatisticsWorkflowController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getUsersActivityStatistics
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| project | List<String> | no | None |
| lot | List<String> | no | None |
| state | List<WorkflowStateKey> | no | None |
| role | List<String> | no | None |
Response Body: ResponseEntity<Collection<WorkflowUserActivityDTO>>
/statistics/workflow/csv
Doesn’t respect oas v3.1.
GET /statistics/workflow/csv?wdelivery
Implementation: StatisticsWorkflowCsvController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getWorkflowDeliveryProgressStatistics
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| project | List<String> | no | None |
| lot | List<String> | no | None |
| delivery | List<String> | no | None |
| pgcnid | String | no | None |
| state | List<WorkflowStateKey> | no | None |
| from | LocalDate | no | None |
| to | LocalDate | no | None |
| encoding | String | no | ISO-8859-15 |
GET /statistics/workflow/csv?wdocunit
Implementation: StatisticsWorkflowCsvController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getWorkflowDocUnitProgressStatistics
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| project | List<String> | no | None |
| lot | List<String> | no | None |
| train | List<String> | no | None |
| pgcnid | String | no | None |
| state | List<WorkflowStateKey> | no | None |
| status | List<WorkflowStateStatus> | no | None |
| mine | boolean | no | false |
| from | LocalDate | no | None |
| to | LocalDate | no | None |
| encoding | String | no | ISO-8859-15 |
GET /statistics/workflow/csv?wstate
Implementation: StatisticsWorkflowCsvController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getWorkflowStatesStatistics
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| workflow | List<String> | no | None |
| state | List<WorkflowStateKey> | no | None |
| from | LocalDate | no | None |
| to | LocalDate | no | None |
| encoding | String | no | ISO-8859-15 |
GET /statistics/workflow/csv?wuser
Implementation: StatisticsWorkflowCsvController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getWorkflowUsersStatistics
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| project | List<String> | no | None |
| lot | List<String> | no | None |
| delivery | List<String> | no | None |
| from | LocalDate | no | None |
| to | LocalDate | no | None |
| encoding | String | no | ISO-8859-15 |
GET /statistics/workflow/csv?wprofile_activity
Implementation: StatisticsWorkflowCsvController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getProfilesActivityStatistics
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| project | List<String> | no | None |
| lot | List<String> | no | None |
| state | List<WorkflowStateKey> | no | None |
| role | List<String> | no | None |
| from | LocalDate | no | None |
| to | LocalDate | no | None |
| encoding | String | no | ISO-8859-15 |
GET /statistics/workflow/csv?wuser_activity
Implementation: StatisticsWorkflowCsvController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getUsersActivityStatistics
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | List<String> | no | None |
| project | List<String> | no | None |
| lot | List<String> | no | None |
| state | List<WorkflowStateKey> | no | None |
| role | List<String> | no | None |
| from | LocalDate | no | None |
| to | LocalDate | no | None |
| encoding | String | no | ISO-8859-15 |
/template
POST /template
Implementation: TemplateController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<Template>
GET /template
Implementation: TemplateController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: findTemplates
Request Body: TODO
Response Body: ResponseEntity<Collection<Template>>
/template/{identifier}
Doesn’t respect oas v3.1.
DELETE /template/{identifier}
Implementation: TemplateController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: delete
Request Body: TODO
GET /template/{id}?download
Implementation: TemplateController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: downloadTemplate
Request Body: TODO
POST /template/{id}?upload
Implementation: TemplateController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: uploadAttachments
Request Body: TODO
Response Body: ResponseEntity<Template>
POST /template/{id}
Implementation: TemplateController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: udpate
Request Body: TODO
Response Body: ResponseEntity<Template>
/train
Doesn’t respect oas v3.1.
GET /train?search
Implementation: TrainController.java
Required Role(s): TRA_HAB3
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| search | String | no | None |
| libraries | List<String> | no | None |
| projects | List<String> | no | None |
| active | boolean | no | true |
| statuses | List<String> | no | None |
| providerSendingDateFrom | LocalDate | no | None |
| providerSendingDateTo | LocalDate | no | None |
| returnDateFrom | LocalDate | no | None |
| returnDateTo | LocalDate | no | None |
| docNumber | Integer | no | None |
| page | Integer | no | 0 |
Response Body: ResponseEntity<Page<SimpleTrainDTO>>
GET /train?filterByProjects
Implementation: TrainController.java
Required Role(s): LOT_HAB3
Functionality: findAllIdentifiersForProjects
Request Body: TODO
Response Body: ResponseEntity<List<SimpleTrainDTO>>
GET /train?dto
Implementation: TrainController.java
Required Role(s): TRA_HAB3
Functionality: findAllActiveDTO
Request Body: TODO
Response Body: ResponseEntity<Collection<TrainDTO>>
GET /train?dto&complete
Implementation: TrainController.java
Required Role(s): TRA_HAB3
Functionality: findAllDTO
Request Body: TODO
Response Body: ResponseEntity<Collection<TrainDTO>>
GET /train?project
Implementation: TrainController.java
Required Role(s): TRA_HAB3
Functionality: findAllForProject
Request Body: TODO
Response Body: ResponseEntity<List<TrainDTO>>
GET /train?simpleByProject&project
Implementation: TrainController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: findAllSimpleForProject
Request Body: TODO
Response Body: ResponseEntity<List<SimpleTrainDTO>>
POST /train
Implementation: TrainController.java
Required Role(s): TRA_HAB0
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<TrainDTO>
/train/{id}
GET /train/{id}
Implementation: TrainController.java
Required Role(s): TRA_HAB3
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<TrainDTO>
POST /train/{id}
Implementation: TrainController.java
Required Role(s): TRA_HAB1
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<TrainDTO>
DELETE /train/{id}
Implementation: TrainController.java
Required Role(s): TRA_HAB2
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<TrainDTO>
/train/csv/{id}
GET /train/csv/{id}
Implementation: TrainController.java
Required Role(s): COND_REPORT_HAB0
Functionality: generateSlip
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| encoding | String | no | ISO-8859-15 |
/train/pdf/{id}
GET /train/pdf/{id}
Implementation: TrainController.java
Required Role(s): COND_REPORT_HAB0
Functionality: generateSlipPdf
Request Body: TODO
/user/{id}
Doesn’t respect oas v3.1.
POST /user/{id}?change_password
Implementation: UserController.java
Required Role(s): USER_HAB2
Functionality: changePassword
Request Body: TODO
Response Body: ResponseEntity<Map<String, Object>>
POST /user/{id}
Implementation: UserController.java
Required Role(s):
- USER_HAB2
- USER_HAB6
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<UserDTO>
POST /user/{id}?signature
Implementation: UserController.java
Required Role(s):
- USER_HAB2
- USER_HAB6
Functionality: uploadSignature
Request Body: TODO
DELETE /user/{id}
Implementation: UserController.java
Required Role(s): USER_HAB3
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<UserDTO>
DELETE /user/{id}?signature
Implementation: UserController.java
Required Role(s):
- USER_HAB2
- USER_HAB6
Functionality: deleteSignature
Request Body: TODO
GET /user/{id}
Implementation: UserController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<UserDTO>
GET /user/{id}?dto
Implementation: UserController.java
Required Role(s): USER_HAB0
Functionality: getDtoById
Request Body: TODO
Response Body: ResponseEntity<UserDTO>
GET /user/{id}?duplicate
Implementation: UserController.java
Required Role(s): USER_HAB0
Functionality: duplicateBorrower
Request Body: TODO
Response Body: ResponseEntity<UserDTO>
GET /user/{id}?signature
Implementation: UserController.java
Required Role(s): USER_HAB0
Functionality: downloadSignature
Request Body: TODO
GET /user/{id}?thumbnail
Implementation: UserController.java
Required Role(s): USER_HAB0
Functionality: downloadThumbnail
Request Body: TODO
GET /user/{id}?signexists
Implementation: UserController.java
Required Role(s):
- USER_HAB0
- USER_HAB6
Functionality: hasSignature
Request Body: TODO
Response Body: ResponseEntity<Map<?, ?>>
/user
Doesn’t respect oas v3.1.
POST /user
Implementation: UserController.java
Required Role(s): USER_HAB1
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<UserDTO>
GET /user?search
Implementation: UserController.java
Required Role(s): USER_HAB0
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| search | String | no | None |
| initiale | String | no | None |
| active | boolean | no | true |
| libraries | List<String> | no | None |
| roles | List<String> | no | None |
| page | Integer | no | 0 |
Response Body: ResponseEntity<Page<SimpleUserDTO>>
GET /user?dto
Implementation: UserController.java
Required Role(s):
- LIB_HAB5
- LIB_HAB6
- LIB_HAB7
Functionality: findAllDTO
Request Body: TODO
Response Body: ResponseEntity<Collection<SimpleUserDTO>>
GET /user?providers
Implementation: UserController.java
Required Role(s):
- LIB_HAB5
- LIB_HAB6
- LIB_HAB7
Functionality: findProvidersDTO
Request Body: TODO
Response Body: ResponseEntity<Collection<SimpleUserDTO>>
/user/dashboard
POST /user/dashboard
Implementation: UserController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: saveDashboard
Request Body: TODO
/viewer/document/{identifier}/{pageNumber}/{args1}/{args2}/{test}/default.jpg
GET /viewer/document/{identifier}/{pageNumber}/{args1}/{args2}/{test}/default.jpg
Implementation: ViewerController.java
Required Role(s): CHECK_HAB3
Functionality: getZooms
Request Body: TODO
Response Body: ResponseEntity<?>
/viewer/document/{identifier}/{pageNumber}/full/{dim1}/{dim2}/default.jpg
GET /viewer/document/{identifier}/{pageNumber}/full/{dim1}/{dim2}/default.jpg
Implementation: ViewerController.java
Required Role(s): CHECK_HAB3
Functionality: getDefault
Request Body: TODO
Response Body: ResponseEntity<?>
/viewer/document/{identifier}/{pageNumber}/info.json
GET /viewer/document/{identifier}/{pageNumber}/info.json
Implementation: ViewerController.java
Required Role(s): CHECK_HAB3
Functionality: getFileInfos
Request Body: TODO
Response Body: ResponseEntity<Map<String, Object>>
/viewer/document/{identifier}/manifest
GET /viewer/document/{identifier}/manifest
Implementation: ViewerController.java
Required Role(s): CHECK_HAB3
Functionality: getManifestViewer
Request Body: TODO
Response Body: ResponseEntity<?>
/viewer/document/{identifier}/master/{pageNumber}
GET /viewer/document/{identifier}/master/{pageNumber}
Implementation: ViewerController.java
Required Role(s): CHECK_HAB3
Functionality: getMaster
Request Body: TODO
Response Body: ResponseEntity<?>
/viewer/document/{identifier}/master/
GET /viewer/document/{identifier}/master/
Implementation: ViewerController.java
Required Role(s): CHECK_HAB3
Functionality: getPdfMaster
Request Body: TODO
Response Body: ResponseEntity<?>
/viewer/document/sample/{identifier}/manifest
GET /viewer/document/sample/{identifier}/manifest
Implementation: ViewerController.java
Required Role(s): CHECK_HAB3
Functionality: getSampledManifestViewer
Request Body: TODO
Response Body: ResponseEntity<?>
/viewer/document/{identifier}/thumbnail/{pageNumber}/thumb.jpg
GET /viewer/document/{identifier}/thumbnail/{pageNumber}/thumb.jpg
Implementation: ViewerController.java
Required Role(s): CHECK_HAB3
Functionality: getThumbnail
Request Body: TODO
Response Body: ResponseEntity<?>
/viewer/document/{identifier}/toc
GET /viewer/document/{identifier}/toc
Implementation: ViewerController.java
Required Role(s): CHECK_HAB3
Functionality: getTableOfContent
Request Body: TODO
Response Body: ResponseEntity<?>
/viewsformat
Doesn’t respect oas v3.1.
GET /viewsformat?search
Implementation: ViewsFormatConfigurationController.java
Required Role(s): IMG_FORMAT_HAB0
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| search | String | no | None |
| libraries | List<String> | no | None |
| page | Integer | no | 0 |
Response Body: ResponseEntity<Page<SimpleViewsFormatConfigurationDTO>>
GET /viewsformat?project
Implementation: ViewsFormatConfigurationController.java
Required Role(s): IMG_FORMAT_HAB0
Functionality: getByProjectId
Request Body: TODO
Response Body: ResponseEntity<List<SimpleViewsFormatConfigurationDTO>>
POST /viewsformat
Implementation: ViewsFormatConfigurationController.java
Required Role(s): IMG_FORMAT_HAB1
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<ViewsFormatConfigurationDTO>
/viewsformat/{id}
POST /viewsformat/{id}
Implementation: ViewsFormatConfigurationController.java
Required Role(s): CHECK_HAB1
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<ViewsFormatConfigurationDTO>
DELETE /viewsformat/{id}
Implementation: ViewsFormatConfigurationController.java
Required Role(s): IMG_FORMAT_HAB1
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<CheckConfigurationDTO>
GET /viewsformat/{id}
Implementation: ViewsFormatConfigurationController.java
Required Role(s): IMG_FORMAT_HAB0
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<ViewsFormatConfigurationDTO>
/workflow/{identifier}
GET /workflow/{identifier}
Implementation: WorkflowController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: findByIdentifier
Request Body: TODO
Response Body: ResponseEntity<DocUnitWorkflowDTO>
/workflow
Doesn’t respect oas v3.1.
GET /workflow?canProcess&docUnit
Implementation: WorkflowController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: canCurrentUserProcessState
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| docUnit | String | no | None |
Response Body: ResponseEntity<BooleanValueDTO>
GET /workflow?process&docUnitId
Implementation: WorkflowController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: processState
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| docUnitId | String | no | None |
Response Body: ResponseEntity<?>
GET /workflow?docUnit
Implementation: WorkflowController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: findByDocUnitIdentifier
Request Body: TODO
Response Body: ResponseEntity<DocUnitWorkflowDTO>
GET /workflow?isDone
Implementation: WorkflowController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: isStateDone
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| doc | String | no | None |
Response Body: ResponseEntity<StateIsDoneDTO>
GET /workflow?isWorkflowStarted
Implementation: WorkflowController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: isWorkflowStarted
Request Body: TODO
Response Body: ResponseEntity<StateIsDoneDTO>
GET /workflow?isCheckStarted
Implementation: WorkflowController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: isCheckStarted
Request Body: TODO
Response Body: ResponseEntity<StateIsDoneDTO>
GET /workflow?isWaitingRedelivering
Implementation: WorkflowController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: isWaitingForRedelivering
Request Body: TODO
Response Body: ResponseEntity<StateIsDoneDTO>
GET /workflow?canReportBeValidated
Implementation: WorkflowController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: canReportBeValidated
Request Body: TODO
Response Body: ResponseEntity<StateIsDoneDTO>
GET /workflow?isRejectDefinitive
Implementation: WorkflowController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: isRejectDefinitive
Request Body: TODO
Response Body: ResponseEntity<StateIsDoneDTO>
POST /workflow?resetNumWaiting
Implementation: WorkflowController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: resetToNumWaiting
Request Body: TODO
Response Body: ResponseEntity<?>
POST /workflow?massValidate
Implementation: WorkflowController.java
Required Role(s): COND_REPORT_HAB2
Functionality: massValidate
Request Body: TODO
Response Body: ResponseEntity<?>
POST /workflow?massValidateRecords
Implementation: WorkflowController.java
Required Role(s): DOC_UNIT_HAB3
Functionality: massValidateRecords
Request Body: TODO
Response Body: ResponseEntity<?>
POST /workflow?endAllDocWorkflows
Implementation: WorkflowController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: endAllDocWorkflows
Request Body: TODO
Response Body: ResponseEntity<?>
POST /workflow?validDocWorkflowState
Implementation: WorkflowController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: validDocWorkflowState
Request Body: TODO
Response Body: ResponseEntity<?>
POST /workflow?reinitDocWorkflowState
Implementation: WorkflowController.java
Required Role(s): This method is either unprotected or the roles are verified manualy in the implementation. Check implementation details for more information.
Functionality: reinitDocWorkflowState
Request Body: TODO
Response Body: ResponseEntity<?>
/workflow_group
Doesn’t respect oas v3.1.
POST /workflow_group
Implementation: WorkflowGroupController.java
Required Role(s): WORKFLOW_HAB1
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<WorkflowGroupDTO>
GET /workflow_group?search
Implementation: WorkflowGroupController.java
Required Role(s): WORKFLOW_HAB4
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| search | String | no | None |
| initiale | String | no | None |
| libraries | List<String> | no | None |
| page | Integer | no | 0 |
| size | Integer | no | 10 |
Response Body: ResponseEntity<Page<SimpleWorkflowGroupDTO>>
GET /workflow_group?groups&library
Implementation: WorkflowGroupController.java
Required Role(s): WORKFLOW_HAB4
Functionality: findGroupsByLibrary
Request Body: TODO
Response Body: ResponseEntity<Collection<SimpleWorkflowGroupDTO>>
/workflow_group/{id}
DELETE /workflow_group/{id}
Implementation: WorkflowGroupController.java
Required Role(s): WORKFLOW_HAB3
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<?>
GET /workflow_group/{id}
Implementation: WorkflowGroupController.java
Required Role(s): WORKFLOW_HAB4
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<WorkflowGroupDTO>
POST /workflow_group/{id}
Implementation: WorkflowGroupController.java
Required Role(s): WORKFLOW_HAB2
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<WorkflowGroupDTO>
/workflow_model
Doesn’t respect oas v3.1.
POST /workflow_model
Implementation: WorkflowModelController.java
Required Role(s): WORKFLOW_HAB1
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<WorkflowModelDTO>
GET /workflow_model?search
Implementation: WorkflowModelController.java
Required Role(s): WORKFLOW_HAB4
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| search | String | no | None |
| initiale | String | no | None |
| libraries | List<String> | no | None |
| page | Integer | no | 0 |
| size | Integer | no | 10 |
Response Body: ResponseEntity<Page<SimpleWorkflowModelDTO>>
GET /workflow_model?models&library
Implementation: WorkflowModelController.java
Required Role(s): WORKFLOW_HAB4
Functionality: findModelsByLibrary
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | String | no | None |
Response Body: ResponseEntity<Collection<SimpleWorkflowModelDTO>>
/workflow_model/{id}
DELETE /workflow_model/{id}
Implementation: WorkflowModelController.java
Required Role(s): WORKFLOW_HAB3
Functionality: delete
Request Body: TODO
Response Body: ResponseEntity<?>
GET /workflow_model/{id}
Implementation: WorkflowModelController.java
Required Role(s): WORKFLOW_HAB4
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<WorkflowModelDTO>
POST /workflow_model/{id}
Implementation: WorkflowModelController.java
Required Role(s): WORKFLOW_HAB2
Functionality: update
Request Body: TODO
Response Body: ResponseEntity<WorkflowModelDTO>
/z3950
Doesn’t respect oas v3.1.
POST /z3950?server
Implementation: Z3950Controller.java
Required Role(s): EXC_HAB3
Functionality: search
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| server | List<String> | no | None |
| page | int | no | 0 |
Response Body: ResponseEntity<Page<Z3950RecordDTO>>
POST /z3950?mapping
Implementation: Z3950Controller.java
Required Role(s): EXC_HAB2
Functionality: importFile
Request Body: TODO
QueryParameters:
| name | type | required | default value |
|---|---|---|---|
| library | String | no | None |
| project | String | no | None |
| lot | String | no | None |
| mapping | String | no | None |
| validation | boolean | no | false |
| dedup | boolean | no | false |
Response Body: ResponseEntity<ImportReport>
/z3950Server
Doesn’t respect oas v3.1.
POST /z3950Server
Implementation: Z3950ServerController.java
Required Role(s): Z3950_HAB1
Functionality: create
Request Body: TODO
Response Body: ResponseEntity<Z3950Server>
GET /z3950Server?dto
Implementation: Z3950ServerController.java
Required Role(s): Z3950_HAB0
Functionality: findAll
Request Body: TODO
Response Body: ResponseEntity<List<Z3950ServerDTO>>
GET /z3950Server
Implementation: Z3950ServerController.java
Required Role(s): Z3950_HAB0
Functionality: findAll
Request Body: TODO
Response Body: ResponseEntity<List<Z3950Server>>
/z3950Server/{id}
GET /z3950Server/{id}
Implementation: Z3950ServerController.java
Required Role(s): Z3950_HAB0
Functionality: getById
Request Body: TODO
Response Body: ResponseEntity<Z3950Server>
POST /z3950Server/{id}
Implementation: Z3950ServerController.java
Required Role(s): Z3950_HAB1
Functionality: udpate
Request Body: TODO
Response Body: ResponseEntity<Z3950Server>
DELETE /z3950Server/{id}
Implementation: Z3950ServerController.java
Required Role(s): Z3950_HAB2
Functionality: delete
Request Body: TODO