{"openapi":"3.1.0","info":{"title":"OLOS API","description":"Repository for Research Datasets","contact":{"email":"admin@olos.swiss"},"license":{"name":"GNU General Public License v2.0 or later","identifier":"GPL-2.0-or-later"},"version":"3.1.6"},"servers":[{"url":"https://storage2.olos.swiss","description":"Generated server url"}],"tags":[{"name":"dlcm"}],"paths":{"/archival-storage/stored-aip":{"get":{"tags":["archival-storage/stored-aip"],"operationId":"archival-storage_stored-aip_list","parameters":[{"name":"aipId","in":"query","required":false,"schema":{"type":"string"}},{"name":"archiveUri","in":"query","required":false,"schema":{"type":"string","format":"uri"}},{"name":"organizationalUnitId","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","required":false,"schema":{"type":"integer","default":0,"minimum":0}},{"name":"resId","in":"query","required":false,"schema":{"type":"string"}},{"name":"size","in":"query","description":"The size of the page to be returned","required":false,"schema":{"type":"integer","default":20,"minimum":1}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RestCollectionStoredAIP"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"post":{"tags":["archival-storage/stored-aip"],"operationId":"archival-storage_stored-aip_create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoredAIP"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StoredAIP"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"delete":{"tags":["archival-storage/stored-aip"],"operationId":"archival-storage_stored-aip_deleteList","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip":{"get":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_list","parameters":[{"name":"archivalUnit","in":"query","description":"if the AIP is an unit (AIU) or a collection (AIC).","required":false,"schema":{"type":"boolean"}},{"name":"archiveContainer","in":"query","description":"The container type of the AIP.","required":false,"schema":{"type":"string","enum":["UNDEFINED","ZIP","BAG_IT"]}},{"name":"archiveFileNumber","in":"query","description":"The total number of files in the AIP.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"archiveId","in":"query","description":"The storage URI of the AIP.","required":false,"schema":{"type":"string"}},{"name":"archiveSize","in":"query","description":"The size in bytes of the AIP.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"collectionArchiveSize","in":"query","description":"The total size in bytes of the collection AIP.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"collectionFileNumber","in":"query","description":"The total number of filed in the collection AIP.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"dispositionApproval","in":"query","description":"If the approval step the AIP disposal is mandatory.","required":false,"schema":{"type":"boolean"}},{"name":"lastArchiving","in":"query","description":"The last archiving process date of the AIP: the first archiving date or the last metadata edition.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","required":false,"schema":{"type":"integer","default":0,"minimum":0}},{"name":"publicationDate","in":"query","description":"The publication date of the AIP.","required":false,"schema":{"type":"string","format":"date"}},{"name":"resId","in":"query","description":"The identifier of the resource. The default format is a Universally Unique IDentifier (UUID).","required":false,"schema":{"type":"string"}},{"name":"retention","in":"query","description":"The retention duration in days of the AIP: O means forever.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"The size of the page to be returned","required":false,"schema":{"type":"integer","default":20,"minimum":1}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"tombstoneSize","in":"query","description":"The size in bytes of the tombstone AIP.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"updateNumber","in":"query","description":"The number of updates in the AIP.","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RestCollectionArchivalInfoPackage"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"post":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArchivalInfoPackage"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ArchivalInfoPackage"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"delete":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_deleteList","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{parentid}/data":{"get":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_data_list","parameters":[{"name":"complianceLevel","in":"query","required":false,"schema":{"type":"string","enum":["NOT_ASSESSED","NO_COMPLIANCE","WEAK_COMPLIANCE","AVERAGE_COMPLIANCE","FULL_COMPLIANCE"]}},{"name":"dataCategory","in":"query","required":false,"schema":{"type":"string","enum":["Primary","Observational","Experimental","Simulation","Derived","Reference","Digitalized","Secondary","Publication","DataPaper","Documentation","Software","Code","Binaries","VirtualMachine","Administrative","Document","WebSite","Other","Package","InformationPackage","UpdatePackage","Metadata","CustomMetadata","UpdatedMetadata","Internal","DatasetThumbnail","ArchiveThumbnail","ArchiveReadme","DatafileThumbnail","ArchiveDataUseAgreement"]}},{"name":"dataType","in":"query","required":false,"schema":{"type":"string","enum":["Primary","Observational","Experimental","Simulation","Derived","Reference","Digitalized","Secondary","Publication","DataPaper","Documentation","Software","Code","Binaries","VirtualMachine","Administrative","Document","WebSite","Other","Package","InformationPackage","UpdatePackage","Metadata","CustomMetadata","UpdatedMetadata","Internal","DatasetThumbnail","ArchiveThumbnail","ArchiveReadme","DatafileThumbnail","ArchiveDataUseAgreement"]}},{"name":"fileName","in":"query","required":false,"schema":{"type":"string"}},{"name":"fileSize","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"finalData","in":"query","required":false,"schema":{"type":"string","format":"uri"}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","required":false,"schema":{"type":"integer","default":0,"minimum":0}},{"name":"parentid","in":"path","required":true,"schema":{"type":"string"}},{"name":"relativeLocation","in":"query","required":false,"schema":{"type":"string"}},{"name":"resId","in":"query","description":"The identifier of the resource. The default format is a Universally Unique IDentifier (UUID).","required":false,"schema":{"type":"string"}},{"name":"size","in":"query","description":"The size of the page to be returned","required":false,"schema":{"type":"integer","default":20,"minimum":1}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"sourceData","in":"query","required":false,"schema":{"type":"string","format":"uri"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["CHANGE_RELATIVE_LOCATION","CHANGE_DATA_CATEGORY","CLEANED","CLEANING","EXCLUDED_FILE","CHECK_COMPLIANCE","CHECK_COMPLIANCE_CLEANED","CHECKED_COMPLIANCE","CHECKED_COMPLIANCE_CLEANED","IGNORED_FILE","DOWNLOAD_IN_PROGRESS","FILE_FORMAT_IDENTIFIED","FILE_FORMAT_SKIPPED","FILE_FORMAT_UNKNOWN","IN_ERROR","PROCESSED","READY","RECEIVED","TO_PROCESS","VIRUS_CHECKED","VIRUS_SKIPPED"]}},{"name":"statusMessage","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RestCollectionAipDataFile"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"post":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_data_create","parameters":[{"name":"parentid","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AipDataFile"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AipDataFile"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"delete":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_data_deleteList","parameters":[{"name":"parentid","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{parentid}/data/{id}/resume":{"post":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_data_by_id_resume","parameters":[{"name":"parentid","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{parentid}/data/{id}/put-in-error":{"post":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_data_by_id_put-in-error","parameters":[{"name":"parentid","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{parentid}/aip":{"get":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_aip_list","parameters":[{"name":"archivalUnit","in":"query","description":"if the AIP is an unit (AIU) or a collection (AIC).","required":false,"schema":{"type":"boolean"}},{"name":"archiveContainer","in":"query","description":"The container type of the AIP.","required":false,"schema":{"type":"string","enum":["UNDEFINED","ZIP","BAG_IT"]}},{"name":"archiveFileNumber","in":"query","description":"The total number of files in the AIP.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"archiveId","in":"query","description":"The storage URI of the AIP.","required":false,"schema":{"type":"string"}},{"name":"archiveSize","in":"query","description":"The size in bytes of the AIP.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"collectionArchiveSize","in":"query","description":"The total size in bytes of the collection AIP.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"collectionFileNumber","in":"query","description":"The total number of filed in the collection AIP.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"dispositionApproval","in":"query","description":"If the approval step the AIP disposal is mandatory.","required":false,"schema":{"type":"boolean"}},{"name":"lastArchiving","in":"query","description":"The last archiving process date of the AIP: the first archiving date or the last metadata edition.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","required":false,"schema":{"type":"integer","default":0,"minimum":0}},{"name":"parentid","in":"path","required":true,"schema":{"type":"string"}},{"name":"publicationDate","in":"query","description":"The publication date of the AIP.","required":false,"schema":{"type":"string","format":"date"}},{"name":"resId","in":"query","description":"The identifier of the resource. The default format is a Universally Unique IDentifier (UUID).","required":false,"schema":{"type":"string"}},{"name":"retention","in":"query","description":"The retention duration in days of the AIP: O means forever.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"The size of the page to be returned","required":false,"schema":{"type":"integer","default":20,"minimum":1}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"tombstoneSize","in":"query","description":"The size in bytes of the tombstone AIP.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"updateNumber","in":"query","description":"The number of updates in the AIP.","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RestCollectionArchivalInfoPackage"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"post":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_aip_create","parameters":[{"name":"parentid","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ArchivalInfoPackage"}}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"delete":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_aip_deleteList","parameters":[{"name":"parentid","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{id}/upload":{"post":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_upload_sendFile","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}},"required":["file"]}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AipDataFile"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{id}/start-metadata-upgrade":{"post":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_start-metadata-upgrade_upgradeMetadata","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{id}/start-metadata-editing":{"post":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_start-metadata-editing_putInMetadataEditing","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{id}/start-compliance-level-update":{"post":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_start-compliance-level-update_updateComplianceLevel","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{id}/resume":{"post":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_resume","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{id}/replicate-tombstone":{"post":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_replicate-tombstone","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"lastArchiving","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"metadataVersion","in":"query","required":false,"schema":{"type":"string","description":"DLCM metadata are based on METS container, DataCite as descriptive metadata and PREMIS as administrative metadata.\nMetadata version:\n- 1.0 = DataCite 4.0 + PREMIS 3.0 + DLCM Info 1.0\n- 1.1 = DataCite 4.0 + PREMIS 3.0 + DLCM Info 1.0\n- 2.0 = DataCite 4.3 + PREMIS 3.0 + DLCM Info 2.0 + Data File Categories\n- 2.1 = DataCite 4.3 + PREMIS 3.0 + DLCM Info 2.1 + Dataset Thumbnail support\n- 3.0 = DataCite 4.4 + PREMIS 3.0 + DLCM Info 2.1\n- 3.1 = DataCite 4.4 + PREMIS 3.0 + DLCM Info 2.2 + Archive Thumbnail & DUA & README support\n- 4.0 = Datacite 4.5 + PREMIS 3.0 + DLCM Info 3.0 + Update of Archive Thumbnail & DUA & README\n- 5.0 = Datacite 4.6 + PREMIS 3.0 + DLCM Info 3.0 + Modern ARK\n","enum":["1.0","1.1","2.0","2.1","3.0","3.1","4.0","5.0"]}},{"name":"complianceLevel","in":"query","required":false,"schema":{"type":"string","description":"Compliance level to define the preservation quality based on data file format:\n- NOT_ASSESSED => The format could not be evaluated\n- NO_COMPLIANCE => The format could not be determined\n- WEAK_COMPLIANCE => The format was determined: content type detected\n- AVERAGE_COMPLIANCE => The format was determined: WEAK_COMPLIANCE + PRONOM identifier detected\n- FULL_COMPLIANCE => The format was determined: AVERAGE_COMPLIANCE + the format is part of golden formats\n","enum":["NOT_ASSESSED","NO_COMPLIANCE","WEAK_COMPLIANCE","AVERAGE_COMPLIANCE","FULL_COMPLIANCE"]}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{id}/replicate-package":{"post":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_replicate-package","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"lastArchiving","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"metadataVersion","in":"query","required":false,"schema":{"type":"string","description":"DLCM metadata are based on METS container, DataCite as descriptive metadata and PREMIS as administrative metadata.\nMetadata version:\n- 1.0 = DataCite 4.0 + PREMIS 3.0 + DLCM Info 1.0\n- 1.1 = DataCite 4.0 + PREMIS 3.0 + DLCM Info 1.0\n- 2.0 = DataCite 4.3 + PREMIS 3.0 + DLCM Info 2.0 + Data File Categories\n- 2.1 = DataCite 4.3 + PREMIS 3.0 + DLCM Info 2.1 + Dataset Thumbnail support\n- 3.0 = DataCite 4.4 + PREMIS 3.0 + DLCM Info 2.1\n- 3.1 = DataCite 4.4 + PREMIS 3.0 + DLCM Info 2.2 + Archive Thumbnail & DUA & README support\n- 4.0 = Datacite 4.5 + PREMIS 3.0 + DLCM Info 3.0 + Update of Archive Thumbnail & DUA & README\n- 5.0 = Datacite 4.6 + PREMIS 3.0 + DLCM Info 3.0 + Modern ARK\n","enum":["1.0","1.1","2.0","2.1","3.0","3.1","4.0","5.0"]}},{"name":"complianceLevel","in":"query","required":false,"schema":{"type":"string","description":"Compliance level to define the preservation quality based on data file format:\n- NOT_ASSESSED => The format could not be evaluated\n- NO_COMPLIANCE => The format could not be determined\n- WEAK_COMPLIANCE => The format was determined: content type detected\n- AVERAGE_COMPLIANCE => The format was determined: WEAK_COMPLIANCE + PRONOM identifier detected\n- FULL_COMPLIANCE => The format was determined: AVERAGE_COMPLIANCE + the format is part of golden formats\n","enum":["NOT_ASSESSED","NO_COMPLIANCE","WEAK_COMPLIANCE","AVERAGE_COMPLIANCE","FULL_COMPLIANCE"]}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{id}/reindex":{"post":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_reindex","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{id}/put-in-error":{"post":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_put-in-error","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{id}/fix-aip-info":{"post":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_fix-aip-info","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{id}/extend-retention":{"post":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_extend-retention","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"duration","in":"query","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{id}/clean":{"post":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_clean","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{id}/check":{"post":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_check","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{id}/check-fixity":{"post":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_check-fixity","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"level","in":"query","required":false,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{id}/approve-disposal":{"post":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_approve-disposal","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"reason","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{id}/approve-disposal-by-orgunit":{"post":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_approve-disposal-by-orgunit","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"reason","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/search":{"get":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_search_advancedSearch_get","parameters":[{"name":"search","in":"query","required":true,"schema":{"type":"string"}},{"name":"match","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","required":false,"schema":{"type":"integer","default":0,"minimum":0}},{"name":"size","in":"query","description":"The size of the page to be returned","required":false,"schema":{"type":"integer","default":20,"minimum":1}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RestCollectionArchivalInfoPackage"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"post":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_search_advancedSearch_post","parameters":[{"name":"match","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","required":false,"schema":{"type":"integer","default":0,"minimum":0}},{"name":"size","in":"query","description":"The size of the page to be returned","required":false,"schema":{"type":"integer","default":20,"minimum":1}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArchivalInfoPackage"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RestCollectionArchivalInfoPackage"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/stored-aip/{id}":{"get":{"tags":["archival-storage/stored-aip"],"operationId":"archival-storage_stored-aip_by_id_get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StoredAIP"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"delete":{"tags":["archival-storage/stored-aip"],"operationId":"archival-storage_stored-aip_by_id_delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}},"security":[{"tokenAuth":[]},{"auth":[]}]},"patch":{"tags":["archival-storage/stored-aip"],"operationId":"archival-storage_stored-aip_by_id_update","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoredAIP"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StoredAIP"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{parentid}/data/{id}":{"get":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_data_by_id_get","parameters":[{"name":"parentid","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AipDataFile"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"delete":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_data_by_id_delete","parameters":[{"name":"parentid","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}},"security":[{"tokenAuth":[]},{"auth":[]}]},"patch":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_data_by_id_update","parameters":[{"name":"parentid","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AipDataFile"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{parentid}/aip/{id}":{"get":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_aip_by_id_get","parameters":[{"name":"parentid","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ArchivalInfoPackage"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"delete":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_aip_by_id_delete","parameters":[{"name":"parentid","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}},"security":[{"tokenAuth":[]},{"auth":[]}]},"patch":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_aip_by_id_update","parameters":[{"name":"parentid","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArchivalInfoPackage"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ArchivalInfoPackage"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{id}":{"get":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ArchivalInfoPackage"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"delete":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}},"security":[{"tokenAuth":[]},{"auth":[]}]},"patch":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_update","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ArchivalInfoPackage"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/sso-user":{"get":{"tags":["sso-user"],"operationId":"sso-user_user","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/User"}}}}}}},"/resource-srv":{"get":{"tags":["resource-srv"],"operationId":"resource-srv_home","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Module"}}}}}}},"/resource-srv/checkTool":{"get":{"tags":["resource-srv/checkTool"],"operationId":"resource-srv_checkTool","parameters":[{"name":"toolName","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/default-configuration":{"get":{"tags":["default-configuration"],"operationId":"default-configuration_getDefaultConfiguration","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DLCMDefaultConfig"}}}}}}},"/current-configuration":{"get":{"tags":["current-configuration"],"operationId":"current-configuration_getCurrentConfiguration","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DLCMConfig"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage":{"get":{"tags":["archival-storage"],"operationId":"archival-storage_home","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Module"}}}}}}},"/archival-storage/stored-aip/{id}/download":{"get":{"tags":["archival-storage/stored-aip"],"summary":"Download AIP","description":"Returns a binary stream (archive)","operationId":"archival-storage_stored-aip_by_id_download_getFiles","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Binary file stream","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"AIP not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StreamingResponseBody"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{parentid}/data/{id}/history":{"get":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_data_by_id_history","parameters":[{"name":"parentid","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"pageable","in":"query","required":true,"schema":{"$ref":"#/components/schemas/Pageable"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RestCollectionStatusHistory"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{parentid}/data/{id}/download":{"get":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_data_by_id_download","parameters":[{"name":"parentid","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{parentid}/data/{id}/download-token":{"get":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_data_by_id_download-token_getTokenForAipDataFile","parameters":[{"name":"parentid","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DownloadToken"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{parentid}/data/list-status":{"get":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_data_list-status","parameters":[{"name":"parentid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"string","enum":["CHANGE_RELATIVE_LOCATION","CHANGE_DATA_CATEGORY","CLEANED","CLEANING","EXCLUDED_FILE","CHECK_COMPLIANCE","CHECK_COMPLIANCE_CLEANED","CHECKED_COMPLIANCE","CHECKED_COMPLIANCE_CLEANED","IGNORED_FILE","DOWNLOAD_IN_PROGRESS","FILE_FORMAT_IDENTIFIED","FILE_FORMAT_SKIPPED","FILE_FORMAT_UNKNOWN","IN_ERROR","PROCESSED","READY","RECEIVED","TO_PROCESS","VIRUS_CHECKED","VIRUS_SKIPPED"]}}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{parentid}/aip/list-status":{"get":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_aip_list-status","parameters":[{"name":"parentid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"string","description":"OAIS Package Status:\n- CHECKED => Checked package during archiving process\n- CHECKING => A package verification is in progress during checking process\n- CHECK_PENDING => A package verification is pending during checking process\n- CLEANED => Cleaned package during cleaning process for SIP only\n- CLEANING => A package clean is in progress during cleaning process for SIP only\n- COMPLIANCE_LEVEL_UPDATE_PENDING => A package compliance update is pending\n- COMPLIANCE_LEVEL_UPDATED => The compliance levels of the package have been updated\n- COMPLETED => Completed package\n- DISPOSABLE => The Package is candidate for disposal process for AIP only\n- DISPOSAL_APPROVED_BY_ORGUNIT => Disposal org. unit approval done during disposal process for AIP only\n- DISPOSAL_APPROVED => Disposal approval done during disposal process for AIP only\n- DISPOSED => Disposed package for AIP only\n- DOWNLOADING => A package download is in progress\n- EDITING_METADATA => A package metadata edition is in progress\n- FIXING => A package correction is in progress\n- FIXITY_ERROR => Error when checking checksums\n- FIX_PENDING => A package correction is pending\n- INDEXING => A package indexing is in progress\n- IN_ERROR => Package in error during archiving process\n- IN_PREPARATION => Package in preparation during archiving process\n- IN_PROGRESS => A package archiving process is in progress\n- METADATA_EDITION_PENDING => A metadata edition is pending\n- METADATA_UPGRADE_PENDING => A metadata version upgrade is pending\n- PACKAGE_REPLICATION_PENDING => A package replication is pending\n- PRESERVATION_ERROR => Package in error during checking process\n- READY => Package Ready\n- REINDEXING => A package re-indexing is in progress\n- RELOADED => Reloaded package from storage location\n- REPLICATING_PACKAGE => A package replication is in progress\n- REPLICATING_TOMBSTONE => A tombstone package replication is in progress\n- RESUBMITTING => A package re-submission is in progress\n- STORED => Package stored on storage location\n- TOMBSTONE_REPLICATION_PENDING => A tombstone replication is pending\n- UPDATING_COMPLIANCE_LEVEL => A package compliance update is in progress\n- UPDATING_RETENTION => A package retention update is in progress during disposal process\n- UPGRADING_METADATA => A metadata version upgrade is in progress\n","enum":["CHECK_PENDING","CHECKING","CHECKED","CLEANING","CLEANED","COMPLETED","DOWNLOADING","IN_PREPARATION","IN_PROGRESS","STORED","INDEXING","READY","RETRIEVING","RETRIEVING_PENDING","IN_ERROR","PRESERVATION_ERROR","FIXITY_ERROR","DISPOSABLE","DISPOSAL_APPROVED_BY_ORGUNIT","DISPOSAL_APPROVED","DISPOSED","FIX_PENDING","FIXING","METADATA_EDITION_PENDING","EDITING_METADATA","UPDATING_RETENTION","METADATA_UPGRADE_PENDING","UPGRADING_METADATA","COMPLIANCE_LEVEL_UPDATE_PENDING","UPDATING_COMPLIANCE_LEVEL","COMPLIANCE_LEVEL_UPDATED","REINDEXING","RELOADED","RESUBMITTING","PACKAGE_REPLICATION_PENDING","REPLICATING_PACKAGE","TOMBSTONE_REPLICATION_PENDING","REPLICATING_TOMBSTONE"]}}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{id}/history":{"get":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_history","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"pageable","in":"query","required":true,"schema":{"$ref":"#/components/schemas/Pageable"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RestCollectionStatusHistory"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{id}/download":{"get":{"tags":["archival-storage/aip"],"summary":"Download Archival Info Package","description":"Returns a binary stream (file)","operationId":"archival-storage_aip_by_id_download_getFiles","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Binary file stream","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"AIP not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StreamingResponseBody"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/{id}/download-token":{"get":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_by_id_download-token_getTokenForAip","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DownloadToken"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/schema":{"get":{"tags":["archival-storage/aip"],"summary":"Download schema of an AIP","description":"Returns a binary stream (file) for the given AIP ID.","operationId":"archival-storage_aip_schema","parameters":[{"name":"version","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Binary file stream","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Schema of an AIP not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StreamingResponseBody"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/profile":{"get":{"tags":["archival-storage/aip"],"summary":"Download profile of a package","description":"Returns a binary stream (file).","operationId":"archival-storage_aip_profile","parameters":[{"name":"version","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Binary file stream","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Profile not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StreamingResponseBody"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/list-status":{"get":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_list-status","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"string","description":"OAIS Package Status:\n- CHECKED => Checked package during archiving process\n- CHECKING => A package verification is in progress during checking process\n- CHECK_PENDING => A package verification is pending during checking process\n- CLEANED => Cleaned package during cleaning process for SIP only\n- CLEANING => A package clean is in progress during cleaning process for SIP only\n- COMPLIANCE_LEVEL_UPDATE_PENDING => A package compliance update is pending\n- COMPLIANCE_LEVEL_UPDATED => The compliance levels of the package have been updated\n- COMPLETED => Completed package\n- DISPOSABLE => The Package is candidate for disposal process for AIP only\n- DISPOSAL_APPROVED_BY_ORGUNIT => Disposal org. unit approval done during disposal process for AIP only\n- DISPOSAL_APPROVED => Disposal approval done during disposal process for AIP only\n- DISPOSED => Disposed package for AIP only\n- DOWNLOADING => A package download is in progress\n- EDITING_METADATA => A package metadata edition is in progress\n- FIXING => A package correction is in progress\n- FIXITY_ERROR => Error when checking checksums\n- FIX_PENDING => A package correction is pending\n- INDEXING => A package indexing is in progress\n- IN_ERROR => Package in error during archiving process\n- IN_PREPARATION => Package in preparation during archiving process\n- IN_PROGRESS => A package archiving process is in progress\n- METADATA_EDITION_PENDING => A metadata edition is pending\n- METADATA_UPGRADE_PENDING => A metadata version upgrade is pending\n- PACKAGE_REPLICATION_PENDING => A package replication is pending\n- PRESERVATION_ERROR => Package in error during checking process\n- READY => Package Ready\n- REINDEXING => A package re-indexing is in progress\n- RELOADED => Reloaded package from storage location\n- REPLICATING_PACKAGE => A package replication is in progress\n- REPLICATING_TOMBSTONE => A tombstone package replication is in progress\n- RESUBMITTING => A package re-submission is in progress\n- STORED => Package stored on storage location\n- TOMBSTONE_REPLICATION_PENDING => A tombstone replication is pending\n- UPDATING_COMPLIANCE_LEVEL => A package compliance update is in progress\n- UPDATING_RETENTION => A package retention update is in progress during disposal process\n- UPGRADING_METADATA => A metadata version upgrade is in progress\n","enum":["CHECK_PENDING","CHECKING","CHECKED","CLEANING","CLEANED","COMPLETED","DOWNLOADING","IN_PREPARATION","IN_PROGRESS","STORED","INDEXING","READY","RETRIEVING","RETRIEVING_PENDING","IN_ERROR","PRESERVATION_ERROR","FIXITY_ERROR","DISPOSABLE","DISPOSAL_APPROVED_BY_ORGUNIT","DISPOSAL_APPROVED","DISPOSED","FIX_PENDING","FIXING","METADATA_EDITION_PENDING","EDITING_METADATA","UPDATING_RETENTION","METADATA_UPGRADE_PENDING","UPGRADING_METADATA","COMPLIANCE_LEVEL_UPDATE_PENDING","UPDATING_COMPLIANCE_LEVEL","COMPLIANCE_LEVEL_UPDATED","REINDEXING","RELOADED","RESUBMITTING","PACKAGE_REPLICATION_PENDING","REPLICATING_PACKAGE","TOMBSTONE_REPLICATION_PENDING","REPLICATING_TOMBSTONE"]}}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/list-metadata-versions":{"get":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_list-metadata-versions","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/list-data-types":{"get":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_list-data-types","parameters":[{"name":"category","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"string","enum":["Primary","Observational","Experimental","Simulation","Derived","Reference","Digitalized","Secondary","Publication","DataPaper","Documentation","Software","Code","Binaries","VirtualMachine","Administrative","Document","WebSite","Other","Package","InformationPackage","UpdatePackage","Metadata","CustomMetadata","UpdatedMetadata","Internal","DatasetThumbnail","ArchiveThumbnail","ArchiveReadme","DatafileThumbnail","ArchiveDataUseAgreement"]}}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/list-data-categories":{"get":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_list-data-categories","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"string","enum":["Primary","Observational","Experimental","Simulation","Derived","Reference","Digitalized","Secondary","Publication","DataPaper","Documentation","Software","Code","Binaries","VirtualMachine","Administrative","Document","WebSite","Other","Package","InformationPackage","UpdatePackage","Metadata","CustomMetadata","UpdatedMetadata","Internal","DatasetThumbnail","ArchiveThumbnail","ArchiveReadme","DatafileThumbnail","ArchiveDataUseAgreement"]}}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/list-aip-statuses":{"get":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_list-aip-statuses","parameters":[{"name":"archivalUnit","in":"query","description":"if the AIP is an unit (AIU) or a collection (AIC).","required":false,"schema":{"type":"boolean"}},{"name":"archiveContainer","in":"query","description":"The container type of the AIP.","required":false,"schema":{"type":"string","enum":["UNDEFINED","ZIP","BAG_IT"]}},{"name":"archiveFileNumber","in":"query","description":"The total number of files in the AIP.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"archiveId","in":"query","description":"The storage URI of the AIP.","required":false,"schema":{"type":"string"}},{"name":"archiveSize","in":"query","description":"The size in bytes of the AIP.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"collectionArchiveSize","in":"query","description":"The total size in bytes of the collection AIP.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"collectionFileNumber","in":"query","description":"The total number of filed in the collection AIP.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"dispositionApproval","in":"query","description":"If the approval step the AIP disposal is mandatory.","required":false,"schema":{"type":"boolean"}},{"name":"lastArchiving","in":"query","description":"The last archiving process date of the AIP: the first archiving date or the last metadata edition.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"pageable","in":"query","required":true,"schema":{"$ref":"#/components/schemas/Pageable"}},{"name":"publicationDate","in":"query","description":"The publication date of the AIP.","required":false,"schema":{"type":"string","format":"date"}},{"name":"resId","in":"query","description":"The identifier of the resource. The default format is a Universally Unique IDentifier (UUID).","required":false,"schema":{"type":"string"}},{"name":"retention","in":"query","description":"The retention duration in days of the AIP: O means forever.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"tombstoneSize","in":"query","description":"The size in bytes of the tombstone AIP.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"updateNumber","in":"query","description":"The number of updates in the AIP.","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RestCollectionAipStatus"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/archival-storage/aip/list-aip-containers":{"get":{"tags":["archival-storage/aip"],"operationId":"archival-storage_aip_list-aip-containers","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"string","enum":["UNDEFINED","ZIP","BAG_IT"]}}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/":{"get":{"tags":["dlcm"],"operationId":"","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Module"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}}},"components":{"schemas":{"ArchivalInfoPackage":{"type":"object","description":"Archival Information Package (AIP)","properties":{"creation":{"$ref":"#/components/schemas/ChangeInfo"},"lastUpdate":{"$ref":"#/components/schemas/ChangeInfo"},"resId":{"type":"string","description":"The identifier of the resource. The default format is a Universally Unique IDentifier (UUID).","maxLength":50,"minLength":0},"dispositionApproval":{"type":"boolean","description":"If the approval step the AIP disposal is mandatory."},"retention":{"type":"integer","format":"int32","description":"The retention duration in days of the AIP: O means forever."},"archiveContainer":{"type":"string","description":"The container type of the AIP.","enum":["UNDEFINED","ZIP","BAG_IT"]},"archivalUnit":{"type":"boolean","description":"if the AIP is an unit (AIU) or a collection (AIC)."},"archiveId":{"type":"string","description":"The storage URI of the AIP."},"archiveFileNumber":{"type":"integer","format":"int64","description":"The total number of files in the AIP."},"updateNumber":{"type":"integer","format":"int64","description":"The number of updates in the AIP."},"collectionFileNumber":{"type":"integer","format":"int64","description":"The total number of filed in the collection AIP."},"archiveSize":{"type":"integer","format":"int64","description":"The size in bytes of the AIP."},"tombstoneSize":{"type":"integer","format":"int64","description":"The size in bytes of the tombstone AIP."},"collectionArchiveSize":{"type":"integer","format":"int64","description":"The total size in bytes of the collection AIP."},"checksumCheck":{"$ref":"#/components/schemas/ChecksumCheck","description":"The last checksum verification information of the AIP."},"checksums":{"type":"array","description":"The checksum list of the AIP.","items":{"$ref":"#/components/schemas/DataFileChecksum"}},"fileFormat":{"$ref":"#/components/schemas/FileFormat","description":"The file format identification of the AIP."},"info":{"$ref":"#/components/schemas/RepresentationInfo","description":"The OAIS representation information of the AIP."},"sipIds":{"type":"array","description":"The source SIP list (IDs) of the AIP.","items":{"type":"string"}},"virusCheck":{"$ref":"#/components/schemas/VirusCheck","description":"The file virus check of the AIP."},"publicationDate":{"type":"string","format":"date","description":"The publication date of the AIP."},"lastArchiving":{"type":"string","format":"date-time","description":"The last archiving process date of the AIP: the first archiving date or the last metadata edition."},"ready":{"type":"boolean","description":"If AIP package is ready.","readOnly":true},"complianceLevel":{"type":"string","description":"Compliance level to define the preservation quality based on data file format:\n- NOT_ASSESSED => The format could not be evaluated\n- NO_COMPLIANCE => The format could not be determined\n- WEAK_COMPLIANCE => The format was determined: content type detected\n- AVERAGE_COMPLIANCE => The format was determined: WEAK_COMPLIANCE + PRONOM identifier detected\n- FULL_COMPLIANCE => The format was determined: AVERAGE_COMPLIANCE + the format is part of golden formats\n","enum":["NOT_ASSESSED","NO_COMPLIANCE","WEAK_COMPLIANCE","AVERAGE_COMPLIANCE","FULL_COMPLIANCE"],"writeOnly":true},"dataFileNumber":{"type":"integer","format":"int32","description":"The number of AIP data files.","readOnly":true},"smartSize":{"type":"string","description":"The size in human-readable format of the AIP.","readOnly":true},"retentionEnd":{"type":"string","format":"date-time","description":"The end of the AIP retention.","readOnly":true},"collectionSize":{"type":"integer","format":"int32","description":"The number of AIPs in collection AIP.","readOnly":true},"smartTombstoneSize":{"type":"string","description":"The size in human-readable format of the tombstone AIP.","readOnly":true},"smartCollectionArchiveSize":{"type":"string","description":"The total size in human-readable format of the collection AIP.","readOnly":true},"packageStatus":{"type":"string","description":"OAIS Package Status:\n- CHECKED => Checked package during archiving process\n- CHECKING => A package verification is in progress during checking process\n- CHECK_PENDING => A package verification is pending during checking process\n- CLEANED => Cleaned package during cleaning process for SIP only\n- CLEANING => A package clean is in progress during cleaning process for SIP only\n- COMPLIANCE_LEVEL_UPDATE_PENDING => A package compliance update is pending\n- COMPLIANCE_LEVEL_UPDATED => The compliance levels of the package have been updated\n- COMPLETED => Completed package\n- DISPOSABLE => The Package is candidate for disposal process for AIP only\n- DISPOSAL_APPROVED_BY_ORGUNIT => Disposal org. unit approval done during disposal process for AIP only\n- DISPOSAL_APPROVED => Disposal approval done during disposal process for AIP only\n- DISPOSED => Disposed package for AIP only\n- DOWNLOADING => A package download is in progress\n- EDITING_METADATA => A package metadata edition is in progress\n- FIXING => A package correction is in progress\n- FIXITY_ERROR => Error when checking checksums\n- FIX_PENDING => A package correction is pending\n- INDEXING => A package indexing is in progress\n- IN_ERROR => Package in error during archiving process\n- IN_PREPARATION => Package in preparation during archiving process\n- IN_PROGRESS => A package archiving process is in progress\n- METADATA_EDITION_PENDING => A metadata edition is pending\n- METADATA_UPGRADE_PENDING => A metadata version upgrade is pending\n- PACKAGE_REPLICATION_PENDING => A package replication is pending\n- PRESERVATION_ERROR => Package in error during checking process\n- READY => Package Ready\n- REINDEXING => A package re-indexing is in progress\n- RELOADED => Reloaded package from storage location\n- REPLICATING_PACKAGE => A package replication is in progress\n- REPLICATING_TOMBSTONE => A tombstone package replication is in progress\n- RESUBMITTING => A package re-submission is in progress\n- STORED => Package stored on storage location\n- TOMBSTONE_REPLICATION_PENDING => A tombstone replication is pending\n- UPDATING_COMPLIANCE_LEVEL => A package compliance update is in progress\n- UPDATING_RETENTION => A package retention update is in progress during disposal process\n- UPGRADING_METADATA => A metadata version upgrade is in progress\n","enum":["CHECK_PENDING","CHECKING","CHECKED","CLEANING","CLEANED","COMPLETED","DOWNLOADING","IN_PREPARATION","IN_PROGRESS","STORED","INDEXING","READY","RETRIEVING","RETRIEVING_PENDING","IN_ERROR","PRESERVATION_ERROR","FIXITY_ERROR","DISPOSABLE","DISPOSAL_APPROVED_BY_ORGUNIT","DISPOSAL_APPROVED","DISPOSED","FIX_PENDING","FIXING","METADATA_EDITION_PENDING","EDITING_METADATA","UPDATING_RETENTION","METADATA_UPGRADE_PENDING","UPGRADING_METADATA","COMPLIANCE_LEVEL_UPDATE_PENDING","UPDATING_COMPLIANCE_LEVEL","COMPLIANCE_LEVEL_UPDATED","REINDEXING","RELOADED","RESUBMITTING","PACKAGE_REPLICATION_PENDING","REPLICATING_PACKAGE","TOMBSTONE_REPLICATION_PENDING","REPLICATING_TOMBSTONE"],"writeOnly":true},"smartRetention":{"type":"string","description":"The retention duration in human-readable format of the package.","readOnly":true},"_links":{"$ref":"#/components/schemas/Links"}}},"ChangeInfo":{"type":"object","description":"The change information of an action.","properties":{"fullName":{"type":"string","description":"The full name of the user who did the action on the resource.","readOnly":true},"who":{"type":"string","description":"The user who did the action on the resource.","readOnly":true},"when":{"type":"string","format":"date-time","description":"The date when the action was done on the resources.","readOnly":true}}},"ChecksumCheck":{"type":"object","description":"Checksum verification information.","properties":{"checkDate":{"type":"string","format":"date-time","description":"The execution date of checksum verification."},"checkingSucceed":{"type":"boolean","description":"The execution result of checksum verification."}}},"DataFileChecksum":{"type":"object","properties":{"checksum":{"type":"string"},"checksumAlgo":{"type":"string","enum":["CRC32","MD5","SHA-1","SHA-256","SHA-512"]},"checksumOrigin":{"type":"string","enum":["DLCM","DLCM_TOMBSTONE","USER","PORTAL"]},"checksumType":{"type":"string","enum":["COMPLETE","PARTIAL"]},"creationTime":{"type":"string","format":"date-time"}}},"EmbargoInfo":{"type":"object","description":"Embargo information.","properties":{"access":{"type":"string","description":"The access level during the embargo.","enum":["PUBLIC","RESTRICTED","CLOSED"]},"months":{"type":"integer","format":"int32","description":"The month number of the embargo duration."},"startDate":{"type":"string","format":"date-time","description":"The starting date of the embargo period."}}},"FileFormat":{"type":"object","description":"File format informations.","properties":{"contentType":{"type":"string","description":"The content type of the file.","maxLength":100,"minLength":0},"details":{"type":"string","description":"The result details of the file format identification."},"format":{"type":"string","description":"The format description of the file."},"md5":{"type":"string","description":"The MD5 checksum of the file.","maxLength":256,"minLength":0},"puid":{"type":"string","description":"The format PRONOM identifier of the  file.","maxLength":20,"minLength":0},"tool":{"$ref":"#/components/schemas/Tool","description":"The format identification tool used to get the file format."},"version":{"type":"string","description":"The format version of the file.","maxLength":50,"minLength":0}}},"RepresentationInfo":{"type":"object","description":"OAIS Information Package: SIP, AIP or DIP.","properties":{"access":{"type":"string","description":"The final access level of the package.","enum":["PUBLIC","RESTRICTED","CLOSED"]},"dataSensitivity":{"type":"string","description":"The data sensitivity of the package.","enum":["UNDEFINED","BLUE","GREEN","YELLOW","ORANGE","RED","CRIMSON"]},"dataUsePolicy":{"type":"string","description":"The data use policy type of the package.","enum":["NONE","LICENSE","CLICK_THROUGH_DUA","SIGNED_DUA","EXTERNAL_DUA"]},"complianceLevel":{"type":"string","description":"The compliance level of the package.","enum":["NOT_ASSESSED","NO_COMPLIANCE","WEAK_COMPLIANCE","AVERAGE_COMPLIANCE","FULL_COMPLIANCE"]},"description":{"type":"string","description":"The description of the package.","maxLength":1024,"minLength":0},"embargo":{"$ref":"#/components/schemas/EmbargoInfo"},"licenseId":{"type":"string","description":"The license identifier of the package."},"metadataVersion":{"type":"string","description":"The metadata version of the package.","enum":["1.0","1.1","2.0","2.1","3.0","3.1","4.0","5.0"]},"name":{"type":"string","description":"The name of the package.","maxLength":255,"minLength":1},"organizationalUnitId":{"type":"string","description":"The organizational Unit ID of the package.","maxLength":50,"minLength":1},"status":{"type":"string","description":"The status of the package.","enum":["CHECK_PENDING","CHECKING","CHECKED","CLEANING","CLEANED","COMPLETED","DOWNLOADING","IN_PREPARATION","IN_PROGRESS","STORED","INDEXING","READY","RETRIEVING","RETRIEVING_PENDING","IN_ERROR","PRESERVATION_ERROR","FIXITY_ERROR","DISPOSABLE","DISPOSAL_APPROVED_BY_ORGUNIT","DISPOSAL_APPROVED","DISPOSED","FIX_PENDING","FIXING","METADATA_EDITION_PENDING","EDITING_METADATA","UPDATING_RETENTION","METADATA_UPGRADE_PENDING","UPGRADING_METADATA","COMPLIANCE_LEVEL_UPDATE_PENDING","UPDATING_COMPLIANCE_LEVEL","COMPLIANCE_LEVEL_UPDATED","REINDEXING","RELOADED","RESUBMITTING","PACKAGE_REPLICATION_PENDING","REPLICATING_PACKAGE","TOMBSTONE_REPLICATION_PENDING","REPLICATING_TOMBSTONE"]},"statusMessage":{"type":"string","description":"The detailed message related to the package status.","maxLength":1024,"minLength":0},"containsUpdatedMetadata":{"type":"boolean","description":"If the package contains updated metadata."},"contentStructurePublic":{"type":"boolean","description":"If the archive structure content is public."},"currentAccess":{"type":"string","description":"The current access level of the package, deducted from the final access level and an eventual embargo.","enum":["PUBLIC","RESTRICTED","CLOSED"],"readOnly":true},"accessCurrentlyPublic":{"type":"boolean","description":"If the current access level is public"}}},"StoredAIP":{"type":"object","properties":{"resId":{"type":"string"},"aipId":{"type":"string","maxLength":2147483647,"minLength":1},"archiveUri":{"type":"string","format":"uri"},"organizationalUnitId":{"type":"string","maxLength":2147483647,"minLength":1},"aip":{"$ref":"#/components/schemas/ArchivalInfoPackage"},"dataSensitivity":{"type":"string","description":"DataTage represents the data sensitivity of the archive:\n- UNDEFINED => Not defined (Data sensitivity not set to support previous archives)\n- BLUE => Public (Non-confidential information, stored and shared freely)\n- GREEN => Controlled public (Not harmful personal information, shared with some access control)\n- YELLOW => Accountable (Potentially harmful personal information, shared with loosely verified and/or approved recipients)\n- ORANGE => More accountable (Sensitive personal information, shared with verified and/or approved recipients under agreement)\n- RED => Fully accountable (Very sensitive personal information, shared with strong verification of approved recipients under signed agreement)\n- CRIMSON => Maximum restricted (Maximum sensitive, explicit permission for each transaction, strong verification of approved recipients under signed agreement)\n","enum":["UNDEFINED","BLUE","GREEN","YELLOW","ORANGE","RED","CRIMSON"]},"archiveId":{"type":"string"},"archiveContainer":{"type":"string","enum":["UNDEFINED","ZIP","BAG_IT"]},"_links":{"$ref":"#/components/schemas/Links"}}},"Tool":{"type":"object","description":"Software tool information.","properties":{"description":{"type":"string","description":"The description of the tool."},"name":{"type":"string","description":"The name of the tool."},"puid":{"type":"string","description":"The PRONOM identifier of the tool."},"version":{"type":"string","description":"The version of the tool."}}},"VirusCheck":{"type":"object","description":"Virus check information.","properties":{"checkDate":{"type":"string","format":"date-time","description":"The execution date of the virus check."},"details":{"type":"string","description":"The result details of the virus check."},"tool":{"$ref":"#/components/schemas/Tool","description":"The virus check tool used to verify if the file contains virus."}}},"AipDataFile":{"type":"object","properties":{"creation":{"$ref":"#/components/schemas/ChangeInfo"},"lastUpdate":{"$ref":"#/components/schemas/ChangeInfo"},"resId":{"type":"string","description":"The identifier of the resource. The default format is a Universally Unique IDentifier (UUID).","maxLength":50,"minLength":0},"searchCriterias":{"type":"array","items":{"$ref":"#/components/schemas/SearchCriteria"}},"complianceLevel":{"type":"string","description":"Compliance level to define the preservation quality based on data file format:\n- NOT_ASSESSED => The format could not be evaluated\n- NO_COMPLIANCE => The format could not be determined\n- WEAK_COMPLIANCE => The format was determined: content type detected\n- AVERAGE_COMPLIANCE => The format was determined: WEAK_COMPLIANCE + PRONOM identifier detected\n- FULL_COMPLIANCE => The format was determined: AVERAGE_COMPLIANCE + the format is part of golden formats\n","enum":["NOT_ASSESSED","NO_COMPLIANCE","WEAK_COMPLIANCE","AVERAGE_COMPLIANCE","FULL_COMPLIANCE"]},"dataCategory":{"type":"string","enum":["Primary","Observational","Experimental","Simulation","Derived","Reference","Digitalized","Secondary","Publication","DataPaper","Documentation","Software","Code","Binaries","VirtualMachine","Administrative","Document","WebSite","Other","Package","InformationPackage","UpdatePackage","Metadata","CustomMetadata","UpdatedMetadata","Internal","DatasetThumbnail","ArchiveThumbnail","ArchiveReadme","DatafileThumbnail","ArchiveDataUseAgreement"]},"dataType":{"type":"string","enum":["Primary","Observational","Experimental","Simulation","Derived","Reference","Digitalized","Secondary","Publication","DataPaper","Documentation","Software","Code","Binaries","VirtualMachine","Administrative","Document","WebSite","Other","Package","InformationPackage","UpdatePackage","Metadata","CustomMetadata","UpdatedMetadata","Internal","DatasetThumbnail","ArchiveThumbnail","ArchiveReadme","DatafileThumbnail","ArchiveDataUseAgreement"]},"fileFormat":{"$ref":"#/components/schemas/FileFormat"},"fileSize":{"type":"integer","format":"int64"},"finalData":{"type":"string","format":"uri"},"fileName":{"type":"string","readOnly":true},"metadataType":{"$ref":"#/components/schemas/MetadataType"},"relativeLocation":{"type":"string","maxLength":460,"minLength":0,"pattern":"(^\\/$)|(^\\/.*(?<!\\/)$)"},"sourceData":{"type":"string","format":"uri"},"status":{"type":"string","enum":["CHANGE_RELATIVE_LOCATION","CHANGE_DATA_CATEGORY","CLEANED","CLEANING","EXCLUDED_FILE","CHECK_COMPLIANCE","CHECK_COMPLIANCE_CLEANED","CHECKED_COMPLIANCE","CHECKED_COMPLIANCE_CLEANED","IGNORED_FILE","DOWNLOAD_IN_PROGRESS","FILE_FORMAT_IDENTIFIED","FILE_FORMAT_SKIPPED","FILE_FORMAT_UNKNOWN","IN_ERROR","PROCESSED","READY","RECEIVED","TO_PROCESS","VIRUS_CHECKED","VIRUS_SKIPPED"]},"statusMessage":{"type":"string","maxLength":1024,"minLength":0},"virusCheck":{"$ref":"#/components/schemas/VirusCheck"},"checksums":{"type":"array","items":{"$ref":"#/components/schemas/DataFileChecksum"}},"infoPackage":{"$ref":"#/components/schemas/ArchivalInfoPackage"},"inProgress":{"type":"boolean"},"fileStatus":{"type":"string","enum":["CHANGE_RELATIVE_LOCATION","CHANGE_DATA_CATEGORY","CLEANED","CLEANING","EXCLUDED_FILE","CHECK_COMPLIANCE","CHECK_COMPLIANCE_CLEANED","CHECKED_COMPLIANCE","CHECKED_COMPLIANCE_CLEANED","IGNORED_FILE","DOWNLOAD_IN_PROGRESS","FILE_FORMAT_IDENTIFIED","FILE_FORMAT_SKIPPED","FILE_FORMAT_UNKNOWN","IN_ERROR","PROCESSED","READY","RECEIVED","TO_PROCESS","VIRUS_CHECKED","VIRUS_SKIPPED"],"writeOnly":true},"fullFileName":{"type":"string","readOnly":true},"smartSize":{"type":"string","readOnly":true},"_links":{"$ref":"#/components/schemas/Links"}}},"MetadataType":{"type":"object","description":"The metadata type allow to define custom metadata.","properties":{"creation":{"$ref":"#/components/schemas/ChangeInfo"},"lastUpdate":{"$ref":"#/components/schemas/ChangeInfo"},"resId":{"type":"string","description":"The identifier of the resource. The default format is a Universally Unique IDentifier (UUID).","maxLength":50,"minLength":0},"description":{"type":"string","description":"The description of the metadata type.","maxLength":1024,"minLength":0},"metadataFormat":{"type":"string","description":"The format of the metadata type.","enum":["CUSTOM","JSON","SCHEMA_LESS","XML"]},"metadataSchema":{"type":"string","description":"The schema of the metadata type."},"name":{"type":"string","description":"The name of the metadata type.","maxLength":255,"minLength":1},"url":{"type":"string","format":"url","description":"The URL of the metadata type."},"version":{"type":"string","description":"The version of the metadata type.","maxLength":50,"minLength":1},"fullName":{"type":"string","description":"The name and the version of the metadata type.","readOnly":true},"_links":{"$ref":"#/components/schemas/Links"}}},"SearchCriteria":{"type":"object","properties":{"caseInsensitive":{"type":"boolean"},"caseType":{"type":"string"},"key":{"type":"string"},"operation":{"type":"string"},"operationType":{"type":"string","enum":["BETWEEN","CONTAINS","ENDS_WITH","EQUALITY","GREATER_EQUAL","GREATER_THAN","LESS_EQUAL","LESS_THAN","NEGATION","ORACLE_CONTAINS","STARTS_WITH"]},"value":{}}},"Result":{"type":"object","description":"The result is the result of REST action (HTTP POST) with the status:\n- EXECUTED => the action was executed successfully\n- NOT_EXECUTED => the action failed and the message details the reason\n- NON_APPLICABLE => the action cannot be executed and the message details the reason\n","properties":{"message":{"type":"string","description":"The detailed message on what happens"},"resId":{"type":"string","description":"The ID of the object"},"status":{"type":"string","description":"The status of the launched action","enum":["EXECUTED","NON_APPLICABLE","NOT_EXECUTED"]},"messsage":{"type":"string","writeOnly":true},"_links":{"$ref":"#/components/schemas/Links"}}},"FacetResult":{"type":"object","properties":{"name":{"type":"string"},"field":{"type":"string"},"values":{"type":"array","items":{"$ref":"#/components/schemas/FacetResultValue"}}}},"FacetResultValue":{"type":"object","properties":{"value":{"type":"string"},"count":{"type":"integer","format":"int64"}}},"RestCollectionArchivalInfoPackage":{"type":"object","description":"The structure of the REST response:\n- data: the list of objects\n- page: the pagination information\n- links: the HATEOAS links\n- facets: the search information\n","properties":{"_links":{"$ref":"#/components/schemas/Links"},"_data":{"type":"array","items":{"$ref":"#/components/schemas/ArchivalInfoPackage"}},"_facets":{"type":"array","items":{"$ref":"#/components/schemas/FacetResult"}},"_page":{"$ref":"#/components/schemas/RestCollectionPage"}}},"RestCollectionPage":{"type":"object","properties":{"currentPage":{"type":"integer","format":"int64"},"sizePage":{"type":"integer","format":"int64"},"totalItems":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int64"}}},"User":{"type":"object","description":"The user information identify a physical person with an authentication.","properties":{"email":{"type":"string","description":"The user email which must be a valid address."},"firstName":{"type":"string","description":"The first name of the user."},"lastName":{"type":"string","description":"The last name of the user."},"homeOrganization":{"type":"string","description":"The home organiztion or institution of the user."},"roles":{"type":"array","description":"The roles of the user.","items":{"type":"string"},"uniqueItems":true},"allProperties":{"type":"object","additionalProperties":{"type":"string"}},"uniqueId":{"type":"string","description":"The unige ID of the user."}}},"Module":{"type":"object","description":"The functional module.","properties":{"name":{"type":"string","description":"The name of the module."},"_links":{"$ref":"#/components/schemas/Links"}}},"Build":{"type":"object","properties":{"host":{"type":"string"},"time":{"type":"string"},"version":{"type":"string"},"user":{"$ref":"#/components/schemas/User"}}},"Commit":{"type":"object","properties":{"time":{"type":"string"},"id":{"$ref":"#/components/schemas/Id"},"message":{"$ref":"#/components/schemas/Message"},"user":{"$ref":"#/components/schemas/User"}}},"Cookie":{"type":"object","properties":{"secure":{"type":"boolean"}}},"DLCMDefaultConfig":{"type":"object","properties":{"solidify":{"$ref":"#/components/schemas/SolidifyProperties"},"solidify.index":{},"solidify.oai-pmh":{},"solidify.citation":{},"dlcm":{},"dlcm.repository":{},"auth":{},"spring.datasource":{},"spring.jpa":{},"spring.activemq":{},"spring.jms":{},"spring.mail":{},"management.endpoints.web":{},"springdoc":{}}},"Debug":{"type":"object","properties":{"badRequestStacktrace":{"type":"boolean"},"accessDeniedStacktrace":{"type":"boolean"}}},"DownloadToken":{"type":"object","properties":{"cookie":{"$ref":"#/components/schemas/Cookie"}}},"Email":{"type":"object","properties":{"senderAddress":{"type":"string"},"ccList":{"type":"array","items":{"type":"string"}},"bccList":{"type":"array","items":{"type":"string"}},"externalTemplates":{"type":"string"},"internalTemplates":{"type":"string"}}},"GitInfoProperties":{"type":"object","properties":{"branch":{"type":"string"},"build":{"$ref":"#/components/schemas/Build"},"commit":{"$ref":"#/components/schemas/Commit"},"remote":{"$ref":"#/components/schemas/Remote"}}},"Id":{"type":"object","properties":{"abbrev":{"type":"string"}}},"LanguageDTO":{"type":"object","properties":{"resId":{"type":"string"},"code":{"type":"string"},"iso6392":{"type":"string"},"sortValue":{"type":"integer","format":"int32"}}},"Message":{"type":"object","properties":{"full":{"type":"string"}}},"Orcid":{"type":"object","properties":{"baseUrl":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"grantType":{"type":"string"},"scope":{"type":"string"},"apiBaseUrl":{"type":"string"},"websites":{"type":"array","items":{"$ref":"#/components/schemas/OrcidWebsite"}},"tokenUrl":{"type":"string"},"authorizeUrl":{"type":"string"}}},"OrcidWebsite":{"type":"object","properties":{"labels":{"type":"array","items":{"$ref":"#/components/schemas/WebPageLabel"}},"checkUrl":{"type":"string"}}},"Origin":{"type":"object","properties":{"url":{"type":"string"}}},"Remote":{"type":"object","properties":{"origin":{"$ref":"#/components/schemas/Origin"}}},"Security":{"type":"object","properties":{"downloadTokenLifeTimeMinutes":{"type":"integer","format":"int32"},"cipherPassword":{"type":"string"},"downloadToken":{"$ref":"#/components/schemas/DownloadToken"}}},"Sitemap":{"type":"object","properties":{"enable":{"type":"boolean"},"pageSize":{"type":"integer","format":"int32"},"locationPrefix":{"type":"string"}}},"SolidifyProperties":{"type":"object","properties":{"applicationName":{"type":"string"},"serverDisplayName":{"type":"string"},"email":{"$ref":"#/components/schemas/Email"},"orcid":{"$ref":"#/components/schemas/Orcid"},"sitemap":{"$ref":"#/components/schemas/Sitemap"},"debug":{"$ref":"#/components/schemas/Debug"},"security":{"$ref":"#/components/schemas/Security"},"applicationVersion":{"type":"string"},"gitInfoService":{"$ref":"#/components/schemas/GitInfoProperties"}}},"WebPageLabel":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/LanguageDTO","writeOnly":true},"text":{"type":"string","maxLength":1024,"minLength":0},"url":{"type":"string"}}},"DLCMConfig":{"type":"object","properties":{"solidify":{"$ref":"#/components/schemas/SolidifyProperties"},"solidify.index":{},"solidify.oai-pmh":{},"solidify.citation":{},"dlcm":{},"dlcm.repository":{},"auth":{},"spring.datasource":{},"spring.jpa":{},"spring.activemq":{},"spring.jms":{},"spring.mail":{},"management.endpoints.web":{},"springdoc":{}}},"RestCollectionStoredAIP":{"type":"object","description":"The structure of the REST response:\n- data: the list of objects\n- page: the pagination information\n- links: the HATEOAS links\n- facets: the search information\n","properties":{"_links":{"$ref":"#/components/schemas/Links"},"_data":{"type":"array","items":{"$ref":"#/components/schemas/StoredAIP"}},"_facets":{"type":"array","items":{"$ref":"#/components/schemas/FacetResult"}},"_page":{"$ref":"#/components/schemas/RestCollectionPage"}}},"StreamingResponseBody":{},"RestCollectionAipDataFile":{"type":"object","description":"The structure of the REST response:\n- data: the list of objects\n- page: the pagination information\n- links: the HATEOAS links\n- facets: the search information\n","properties":{"_links":{"$ref":"#/components/schemas/Links"},"_data":{"type":"array","items":{"$ref":"#/components/schemas/AipDataFile"}},"_facets":{"type":"array","items":{"$ref":"#/components/schemas/FacetResult"}},"_page":{"$ref":"#/components/schemas/RestCollectionPage"}}},"Pageable":{"type":"object","properties":{"page":{"type":"integer","format":"int32","minimum":0},"size":{"type":"integer","format":"int32","minimum":1},"sort":{"type":"array","items":{"type":"string"}}}},"RestCollectionStatusHistory":{"type":"object","description":"The structure of the REST response:\n- data: the list of objects\n- page: the pagination information\n- links: the HATEOAS links\n- facets: the search information\n","properties":{"_links":{"$ref":"#/components/schemas/Links"},"_data":{"type":"array","items":{"$ref":"#/components/schemas/StatusHistory"}},"_facets":{"type":"array","items":{"$ref":"#/components/schemas/FacetResult"}},"_page":{"$ref":"#/components/schemas/RestCollectionPage"}}},"StatusHistory":{"type":"object","properties":{"changeTime":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"creatorName":{"type":"string"},"description":{"type":"string","maxLength":1024,"minLength":0},"status":{"type":"string"}}},"AipStatus":{"type":"object","properties":{"creationTime":{"type":"string","format":"date-time"},"resId":{"type":"string"},"status":{"type":"string","description":"OAIS Package Status:\n- CHECKED => Checked package during archiving process\n- CHECKING => A package verification is in progress during checking process\n- CHECK_PENDING => A package verification is pending during checking process\n- CLEANED => Cleaned package during cleaning process for SIP only\n- CLEANING => A package clean is in progress during cleaning process for SIP only\n- COMPLIANCE_LEVEL_UPDATE_PENDING => A package compliance update is pending\n- COMPLIANCE_LEVEL_UPDATED => The compliance levels of the package have been updated\n- COMPLETED => Completed package\n- DISPOSABLE => The Package is candidate for disposal process for AIP only\n- DISPOSAL_APPROVED_BY_ORGUNIT => Disposal org. unit approval done during disposal process for AIP only\n- DISPOSAL_APPROVED => Disposal approval done during disposal process for AIP only\n- DISPOSED => Disposed package for AIP only\n- DOWNLOADING => A package download is in progress\n- EDITING_METADATA => A package metadata edition is in progress\n- FIXING => A package correction is in progress\n- FIXITY_ERROR => Error when checking checksums\n- FIX_PENDING => A package correction is pending\n- INDEXING => A package indexing is in progress\n- IN_ERROR => Package in error during archiving process\n- IN_PREPARATION => Package in preparation during archiving process\n- IN_PROGRESS => A package archiving process is in progress\n- METADATA_EDITION_PENDING => A metadata edition is pending\n- METADATA_UPGRADE_PENDING => A metadata version upgrade is pending\n- PACKAGE_REPLICATION_PENDING => A package replication is pending\n- PRESERVATION_ERROR => Package in error during checking process\n- READY => Package Ready\n- REINDEXING => A package re-indexing is in progress\n- RELOADED => Reloaded package from storage location\n- REPLICATING_PACKAGE => A package replication is in progress\n- REPLICATING_TOMBSTONE => A tombstone package replication is in progress\n- RESUBMITTING => A package re-submission is in progress\n- STORED => Package stored on storage location\n- TOMBSTONE_REPLICATION_PENDING => A tombstone replication is pending\n- UPDATING_COMPLIANCE_LEVEL => A package compliance update is in progress\n- UPDATING_RETENTION => A package retention update is in progress during disposal process\n- UPGRADING_METADATA => A metadata version upgrade is in progress\n","enum":["CHECK_PENDING","CHECKING","CHECKED","CLEANING","CLEANED","COMPLETED","DOWNLOADING","IN_PREPARATION","IN_PROGRESS","STORED","INDEXING","READY","RETRIEVING","RETRIEVING_PENDING","IN_ERROR","PRESERVATION_ERROR","FIXITY_ERROR","DISPOSABLE","DISPOSAL_APPROVED_BY_ORGUNIT","DISPOSAL_APPROVED","DISPOSED","FIX_PENDING","FIXING","METADATA_EDITION_PENDING","EDITING_METADATA","UPDATING_RETENTION","METADATA_UPGRADE_PENDING","UPGRADING_METADATA","COMPLIANCE_LEVEL_UPDATE_PENDING","UPDATING_COMPLIANCE_LEVEL","COMPLIANCE_LEVEL_UPDATED","REINDEXING","RELOADED","RESUBMITTING","PACKAGE_REPLICATION_PENDING","REPLICATING_PACKAGE","TOMBSTONE_REPLICATION_PENDING","REPLICATING_TOMBSTONE"]},"updateTime":{"type":"string","format":"date-time"}}},"RestCollectionAipStatus":{"type":"object","description":"The structure of the REST response:\n- data: the list of objects\n- page: the pagination information\n- links: the HATEOAS links\n- facets: the search information\n","properties":{"_links":{"$ref":"#/components/schemas/Links"},"_data":{"type":"array","items":{"$ref":"#/components/schemas/AipStatus"}},"_facets":{"type":"array","items":{"$ref":"#/components/schemas/FacetResult"}},"_page":{"$ref":"#/components/schemas/RestCollectionPage"}}},"Link":{"type":"object","properties":{"href":{"type":"string"},"hreflang":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"deprecation":{"type":"string"},"profile":{"type":"string"},"name":{"type":"string"},"templated":{"type":"boolean"}}},"Links":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Link"}}},"securitySchemes":{"tokenAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"},"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://auth.olos.swiss/authorization/oauth/authorize","tokenUrl":"https://auth.olos.swiss/authorization/oauth/token","scopes":{"app-dlcm":"OLOS"}}}}}}}