{"openapi":"3.0.1","info":{"title":"DLCM Solution API","description":"Repository for Research Datasets","contact":{"email":"admin@dlcm.ch"},"license":{"name":"GNU General Public License v2.0 or later"},"version":"3.1.8"},"servers":[{"url":"http://localhost:8080/dlcm","description":"Generated server url"}],"tags":[{"name":"dlcm"}],"paths":{"/ingest/sip":{"get":{"tags":["ingest/sip"],"operationId":"ingest_sip_list","parameters":[{"name":"aipId","in":"query","description":"The generated AIP identifier of the SIP.","required":false,"schema":{"type":"string"}},{"name":"depositId","in":"query","description":"The source deposit identifier of the SIP.","required":false,"schema":{"type":"string"}},{"name":"dispositionApproval","in":"query","description":"If the approval step the AIP disposal is mandatory.","required":false,"schema":{"type":"boolean"}},{"name":"mainStorage","in":"query","description":"The main storage indice in configuration if the SIP. O means default storage (first one).","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","required":false,"schema":{"minimum":0,"type":"integer","default":0}},{"name":"publicationDate","in":"query","description":"The publication date of the deposit.","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":{"minimum":1,"type":"integer","default":20}},{"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":"submissionPolicyId","in":"query","description":"The submission policy identifier of the SIP.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RestCollectionSubmissionInfoPackage"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"post":{"tags":["ingest/sip"],"operationId":"ingest_sip_create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmissionInfoPackage"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SubmissionInfoPackage"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"delete":{"tags":["ingest/sip"],"operationId":"ingest_sip_deleteList","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/ingest/sip/{parentId}/data":{"get":{"tags":["ingest/sip"],"operationId":"ingest_sip_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":{"minimum":0,"type":"integer","default":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":{"minimum":1,"type":"integer","default":20}},{"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/RestCollectionSipDataFile"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"post":{"tags":["ingest/sip"],"operationId":"ingest_sip_by_id_data_create","parameters":[{"name":"parentId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SipDataFile"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SipDataFile"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"delete":{"tags":["ingest/sip"],"operationId":"ingest_sip_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":[]}]}},"/ingest/sip/{parentId}/data/{id}/resume":{"post":{"tags":["ingest/sip"],"operationId":"ingest_sip_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":[]}]}},"/ingest/sip/{parentId}/data/{id}/put-in-error":{"post":{"tags":["ingest/sip"],"operationId":"ingest_sip_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":[]}]}},"/ingest/sip/{parentId}/aip":{"get":{"tags":["ingest/sip"],"operationId":"ingest_sip_by_id_aip_list","parameters":[{"name":"parentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","required":false,"schema":{"minimum":0,"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned","required":false,"schema":{"minimum":1,"type":"integer","default":20}},{"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":["ingest/sip"],"operationId":"ingest_sip_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":["ingest/sip"],"operationId":"ingest_sip_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":[]}]}},"/ingest/sip/{id}/upload":{"post":{"tags":["ingest/sip"],"operationId":"ingest_sip_by_id_upload_sendFile","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SipDataFile"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/ingest/sip/{id}/start-metadata-upgrade":{"post":{"tags":["ingest/sip"],"operationId":"ingest_sip_by_id_start-metadata-upgrade_putInMetadataUpgrading","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/ingest/sip/{id}/start-metadata-editing":{"post":{"tags":["ingest/sip"],"operationId":"ingest_sip_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":[]}]}},"/ingest/sip/{id}/resume":{"post":{"tags":["ingest/sip"],"operationId":"ingest_sip_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":[]}]}},"/ingest/sip/{id}/resubmit":{"post":{"tags":["ingest/sip"],"operationId":"ingest_sip_by_id_resubmit","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/ingest/sip/{id}/put-in-error":{"post":{"tags":["ingest/sip"],"operationId":"ingest_sip_by_id_put-in-error_putInError","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/ingest/sip/{id}/clean":{"post":{"tags":["ingest/sip"],"operationId":"ingest_sip_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":[]}]}},"/ingest/sip/search":{"get":{"tags":["ingest/sip"],"operationId":"ingest_sip_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":{"minimum":0,"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned","required":false,"schema":{"minimum":1,"type":"integer","default":20}},{"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/RestCollectionSubmissionInfoPackage"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"post":{"tags":["ingest/sip"],"operationId":"ingest_sip_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":{"minimum":0,"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned","required":false,"schema":{"minimum":1,"type":"integer","default":20}},{"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/SubmissionInfoPackage"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RestCollectionSubmissionInfoPackage"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/ingest/sip/{parentId}/data/{id}":{"get":{"tags":["ingest/sip"],"operationId":"ingest_sip_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/SipDataFile"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"delete":{"tags":["ingest/sip"],"operationId":"ingest_sip_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":["ingest/sip"],"operationId":"ingest_sip_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":{"type":"object"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SipDataFile"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/ingest/sip/{parentId}/aip/{id}":{"get":{"tags":["ingest/sip"],"operationId":"ingest_sip_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":["ingest/sip"],"operationId":"ingest_sip_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":["ingest/sip"],"operationId":"ingest_sip_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":[]}]}},"/ingest/sip/{id}":{"get":{"tags":["ingest/sip"],"operationId":"ingest_sip_by_id_get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SubmissionInfoPackage"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"delete":{"tags":["ingest/sip"],"operationId":"ingest_sip_by_id_delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}},"security":[{"tokenAuth":[]},{"auth":[]}]},"patch":{"tags":["ingest/sip"],"operationId":"ingest_sip_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/SubmissionInfoPackage"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/ingest":{"get":{"tags":["ingest"],"operationId":"ingest_home","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Module"}}}}}}},"/ingest/sip/{parentId}/data/{id}/history":{"get":{"tags":["ingest/sip"],"operationId":"ingest_sip_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":[]}]}},"/ingest/sip/{parentId}/data/{id}/download":{"get":{"tags":["ingest/sip"],"operationId":"ingest_sip_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":[]}]}},"/ingest/sip/{parentId}/data/{id}/download-token":{"get":{"tags":["ingest/sip"],"operationId":"ingest_sip_by_id_data_by_id_download-token_getTokenForSipDataFile","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":[]}]}},"/ingest/sip/{parentId}/data/list-status":{"get":{"tags":["ingest/sip"],"operationId":"ingest_sip_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":[]}]}},"/ingest/sip/{id}/history":{"get":{"tags":["ingest/sip"],"operationId":"ingest_sip_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":[]}]}},"/ingest/sip/{id}/download":{"get":{"tags":["ingest/sip"],"operationId":"ingest_sip_by_id_download_getFiles","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/ingest/sip/{id}/download-token":{"get":{"tags":["ingest/sip"],"operationId":"ingest_sip_by_id_download-token_getTokenForSip","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DownloadToken"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/ingest/sip/{id}/aip-package":{"get":{"tags":["ingest/sip"],"operationId":"ingest_sip_by_id_aip-package_getAIP","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"delete":{"tags":["ingest/sip"],"operationId":"ingest_sip_by_id_aip-package_deleteAIP","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/ingest/sip/schema":{"get":{"tags":["ingest/sip"],"summary":"Download schema of a SIP","description":"Returns a binary stream (file) for the given SIP ID.","operationId":"ingest_sip_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 SIP not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StreamingResponseBody"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/ingest/sip/profile":{"get":{"tags":["ingest/sip"],"summary":"Download profile of a package","description":"Returns a binary stream (file).","operationId":"ingest_sip_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":[]}]}},"/ingest/sip/list-status":{"get":{"tags":["ingest/sip"],"operationId":"ingest_sip_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":[]}]}},"/ingest/sip/list-metadata-versions":{"get":{"tags":["ingest/sip"],"operationId":"ingest_sip_list-metadata-versions","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/ingest/sip/list-data-types":{"get":{"tags":["ingest/sip"],"operationId":"ingest_sip_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":[]}]}},"/ingest/sip/list-data-categories":{"get":{"tags":["ingest/sip"],"operationId":"ingest_sip_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":[]}]}}},"components":{"schemas":{"ChangeInfo":{"type":"object","properties":{"fullName":{"type":"string","description":"The full name of the user who did the action on the resource.","readOnly":true},"when":{"type":"string","description":"The date when the action was done on the resources.","format":"date-time","readOnly":true},"who":{"type":"string","description":"The user who did the action on the resource.","readOnly":true}},"description":"The change information of an action."},"EmbargoInfo":{"type":"object","properties":{"access":{"type":"string","description":"Access level of the archive:\n- PUBLIC => Open Access & Everyone\n- RESTRICTED => Team members (i.e., Org. Unit) & Trusted parties\n- CLOSED => Case by case & Individuals\n","enum":["PUBLIC","RESTRICTED","CLOSED"]},"months":{"type":"integer","description":"The month number of the embargo duration.","format":"int32"},"startDate":{"type":"string","description":"The starting date of the embargo period.","format":"date-time"}},"description":"Embargo information."},"Institution":{"required":["name"],"type":"object","properties":{"creation":{"$ref":"#/components/schemas/ChangeInfo"},"lastUpdate":{"$ref":"#/components/schemas/ChangeInfo"},"resId":{"maxLength":50,"minLength":0,"type":"string","description":"The identifier of the resource. The default format is a Universally Unique IDentifier (UUID)."},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"The description of the institution."},"emailSuffixes":{"type":"array","description":"The email suffixes list of the institution.","items":{"type":"string","description":"The email suffixes list of the institution."}},"name":{"maxLength":2147483647,"minLength":1,"type":"string","description":"The name of the institution."},"url":{"type":"string","description":"The URL of the institution.","format":"url"},"rorId":{"type":"string","description":"The ROR identifier of the institution."},"logo":{"$ref":"#/components/schemas/InstitutionLogo"},"identifiers":{"type":"object","additionalProperties":true,"description":"The other identifiers list of the institution."},"organizationalUnit":{"type":"array","writeOnly":true,"items":{"$ref":"#/components/schemas/OrganizationalUnit"}},"_links":{"$ref":"#/components/schemas/Links"}},"description":"An institution represents academic institutions, such as UNIGE and HES-SO."},"InstitutionLogo":{"type":"object","properties":{"creation":{"$ref":"#/components/schemas/ChangeInfo"},"lastUpdate":{"$ref":"#/components/schemas/ChangeInfo"},"resId":{"maxLength":50,"minLength":0,"type":"string","description":"The identifier of the resource. The default format is a Universally Unique IDentifier (UUID)."},"fileName":{"maxLength":2024,"minLength":0,"type":"string","description":"The file name."},"fileSize":{"type":"integer","description":"The file size in bytes.","format":"int64"},"mimeType":{"type":"string","description":"The content type of the file. It could be named as MIME type or media type."},"_links":{"$ref":"#/components/schemas/Links"}},"description":"The logo of the institution."},"License":{"required":["openLicenseId","title","url"],"type":"object","properties":{"creation":{"$ref":"#/components/schemas/ChangeInfo"},"lastUpdate":{"$ref":"#/components/schemas/ChangeInfo"},"resId":{"maxLength":50,"minLength":0,"type":"string","description":"The identifier of the resource. The default format is a Universally Unique IDentifier (UUID)."},"domainContent":{"type":"boolean","description":"If the license is applicable for content."},"domainData":{"type":"boolean","description":"If the license is applicable for data."},"domainSoftware":{"type":"boolean","description":"If the license is applicable for software."},"family":{"type":"string","description":"The family of the license."},"isGeneric":{"type":"boolean","description":"If the license is generic."},"maintainer":{"type":"string","description":"The maintainer of the license."},"odConformance":{"type":"string","description":"Conformance Status.","enum":["approved","","not reviewed","rejected"]},"openLicenseId":{"type":"string","description":"The open license identifier of the license. The recommanded format is SPDX short identifier."},"osdConformance":{"type":"string","description":"Conformance Status.","enum":["approved","","not reviewed","rejected"]},"status":{"type":"string","description":"License status.","enum":["active","retired","superseded"]},"title":{"type":"string","description":"The title of the license."},"url":{"type":"string","description":"The source URL of the license.","format":"url"},"logo":{"$ref":"#/components/schemas/LicenseLogo"},"description":{"type":"string","description":"The description of the license. The format is: <openLicenseId> (<title>).","readOnly":true},"_links":{"$ref":"#/components/schemas/Links"}},"description":"A license represents software licenses (Academic Free License 3.0, Design Science License, MIT License…​)."},"LicenseLogo":{"type":"object","properties":{"creation":{"$ref":"#/components/schemas/ChangeInfo"},"lastUpdate":{"$ref":"#/components/schemas/ChangeInfo"},"resId":{"maxLength":50,"minLength":0,"type":"string","description":"The identifier of the resource. The default format is a Universally Unique IDentifier (UUID)."},"fileName":{"maxLength":2024,"minLength":0,"type":"string","description":"The file name."},"fileSize":{"type":"integer","description":"The file size in bytes.","format":"int64"},"mimeType":{"type":"string","description":"The content type of the file. It could be named as MIME type or media type."},"_links":{"$ref":"#/components/schemas/Links"}},"description":"The logo of the license."},"OrganizationalUnit":{"required":["name","openingDate"],"type":"object","properties":{"creation":{"$ref":"#/components/schemas/ChangeInfo"},"lastUpdate":{"$ref":"#/components/schemas/ChangeInfo"},"resId":{"maxLength":50,"minLength":0,"type":"string","description":"The identifier of the resource. The default format is a Universally Unique IDentifier (UUID)."},"closingDate":{"type":"string","description":"The closing date of the organizational unit.","format":"date"},"defaultLicense":{"$ref":"#/components/schemas/License"},"defaultPreservationPolicy":{"$ref":"#/components/schemas/PreservationPolicy"},"defaultSubmissionPolicy":{"$ref":"#/components/schemas/SubmissionPolicy"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"The description of the organizational unit."},"institutions":{"type":"array","writeOnly":true,"items":{"$ref":"#/components/schemas/Institution"}},"isEmpty":{"type":"boolean","description":"If the organizational unit contains any data (deposits, sip, aip)."},"keywords":{"type":"array","description":"The keywords associated with this organizational unit, they are used as default for deposits created within this organizational unit.","items":{"type":"string","description":"The keywords associated with this organizational unit, they are used as default for deposits created within this organizational unit."}},"name":{"maxLength":2147483647,"minLength":1,"type":"string","description":"The name of the organizational unit."},"openingDate":{"type":"string","description":"The opening date of the organizational unit.","format":"date"},"url":{"type":"string","description":"The URL of the organizational unit.","format":"url"},"logo":{"$ref":"#/components/schemas/OrganizationalUnitLogo"},"open":{"type":"boolean","description":"If the organizational unit is currently open."},"_links":{"$ref":"#/components/schemas/Links"}},"description":"An organizational unit is a logical entity that represents a research project or laboratory or any other organizational group of researchers. A preservation space is associated to it."},"OrganizationalUnitLogo":{"type":"object","properties":{"creation":{"$ref":"#/components/schemas/ChangeInfo"},"lastUpdate":{"$ref":"#/components/schemas/ChangeInfo"},"resId":{"maxLength":50,"minLength":0,"type":"string","description":"The identifier of the resource. The default format is a Universally Unique IDentifier (UUID)."},"fileName":{"maxLength":2024,"minLength":0,"type":"string","description":"The file name."},"fileSize":{"type":"integer","description":"The file size in bytes.","format":"int64"},"mimeType":{"type":"string","description":"The content type of the file. It could be named as MIME type or media type."},"_links":{"$ref":"#/components/schemas/Links"}},"description":"The logo of the organizational unit."},"PreservationPolicy":{"required":["name"],"type":"object","properties":{"creation":{"$ref":"#/components/schemas/ChangeInfo"},"lastUpdate":{"$ref":"#/components/schemas/ChangeInfo"},"resId":{"maxLength":50,"minLength":0,"type":"string","description":"The identifier of the resource. The default format is a Universally Unique IDentifier (UUID)."},"dispositionApproval":{"type":"boolean","description":"If the approval step is mandatory during the AIP disposal process."},"retention":{"type":"integer","description":"The retention duration in days of the preservation policy. O means forever.","format":"int32"},"mainStorage":{"type":"integer","description":"The main storage indice in configuration of the preservation policy. O means default storage (first one).","format":"int32"},"name":{"maxLength":255,"minLength":1,"type":"string","description":"The name of the preservation policy."},"useNumber":{"type":"integer","description":"The number of the preservation policy use in organizational units.","format":"int32","readOnly":true},"smartRetention":{"type":"string","description":"The retention duration in human-readable format of the package.","readOnly":true},"_links":{"$ref":"#/components/schemas/Links"}},"description":"A preservation policy defines whether approval is required for an AIP’s disposition as well as how long it should be kept."},"RepresentationInfo":{"required":["metadataVersion","name","organizationalUnitId"],"type":"object","properties":{"access":{"type":"string","description":"Access level of the archive:\n- PUBLIC => Open Access & Everyone\n- RESTRICTED => Team members (i.e., Org. Unit) & Trusted parties\n- CLOSED => Case by case & Individuals\n","enum":["PUBLIC","RESTRICTED","CLOSED"]},"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"]},"dataUsePolicy":{"type":"string","description":"Data use policy defines the terms to conditions to access to an archive:\n- NONE => no policy\n- LICENSE => To respect the license\n- CLICK_THROUGH_DUA => To click to accept the Data Use Agreement (DUA)\n- SIGNED_DUA => To sign to accept the Data Use Agreement (DUA)\n- EXTERNAL_DUA => The Data Use Agreement (DUA) is managed externally\n","enum":["NONE","LICENSE","CLICK_THROUGH_DUA","SIGNED_DUA","EXTERNAL_DUA"]},"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"]},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"The description of the package."},"embargo":{"$ref":"#/components/schemas/EmbargoInfo"},"licenseId":{"type":"string","description":"The license identifier of the package."},"metadataVersion":{"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":{"maxLength":255,"minLength":1,"type":"string","description":"The name of the package."},"organizationalUnitId":{"maxLength":50,"minLength":1,"type":"string","description":"The organizational Unit ID of the package."},"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"]},"statusMessage":{"maxLength":1024,"minLength":0,"type":"string","description":"The detailed message related to the package status."},"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":"Access level of the archive:\n- PUBLIC => Open Access & Everyone\n- RESTRICTED => Team members (i.e., Org. Unit) & Trusted parties\n- CLOSED => Case by case & Individuals\n","readOnly":true,"enum":["PUBLIC","RESTRICTED","CLOSED"]},"accessCurrentlyPublic":{"type":"boolean","description":"If the current access level is public"}},"description":"OAIS Information Package: SIP, AIP or DIP."},"SubmissionAgreement":{"required":["submissionAgreementFile","title","version"],"type":"object","properties":{"creation":{"$ref":"#/components/schemas/ChangeInfo"},"lastUpdate":{"$ref":"#/components/schemas/ChangeInfo"},"resId":{"maxLength":50,"minLength":0,"type":"string","description":"The identifier of the resource. The default format is a Universally Unique IDentifier (UUID)."},"title":{"type":"string","description":"The title of the submission agreement"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"The description of the submission agreement"},"version":{"type":"string","description":"The version of the submission agreement"},"submissionAgreementFile":{"$ref":"#/components/schemas/SubmissionAgreementFile"},"_links":{"$ref":"#/components/schemas/Links"}},"description":"A submission agreement defines the conditions of the submissions."},"SubmissionAgreementFile":{"type":"object","properties":{"creation":{"$ref":"#/components/schemas/ChangeInfo"},"lastUpdate":{"$ref":"#/components/schemas/ChangeInfo"},"resId":{"maxLength":50,"minLength":0,"type":"string","description":"The identifier of the resource. The default format is a Universally Unique IDentifier (UUID)."},"fileName":{"maxLength":2024,"minLength":0,"type":"string","description":"The file name."},"fileSize":{"type":"integer","description":"The file size in bytes.","format":"int64"},"mimeType":{"type":"string","description":"The content type of the file. It could be named as MIME type or media type."},"_links":{"$ref":"#/components/schemas/Links"}},"description":"The submission agreement file"},"SubmissionInfoPackage":{"required":["info"],"type":"object","properties":{"creation":{"$ref":"#/components/schemas/ChangeInfo"},"lastUpdate":{"$ref":"#/components/schemas/ChangeInfo"},"resId":{"maxLength":50,"minLength":0,"type":"string","description":"The identifier of the resource. The default format is a Universally Unique IDentifier (UUID)."},"dispositionApproval":{"type":"boolean","description":"If the approval step the AIP disposal is mandatory."},"retention":{"type":"integer","description":"The retention duration in days of the AIP: O means forever.","format":"int32"},"mainStorage":{"type":"integer","description":"The main storage indice in configuration if the SIP. O means default storage (first one).","format":"int32"},"aipId":{"maxLength":50,"minLength":0,"type":"string","description":"The generated AIP identifier of the SIP."},"depositId":{"maxLength":50,"minLength":0,"type":"string","description":"The source deposit identifier of the SIP."},"info":{"$ref":"#/components/schemas/RepresentationInfo"},"organizationalUnit":{"$ref":"#/components/schemas/OrganizationalUnit"},"submissionPolicy":{"$ref":"#/components/schemas/SubmissionPolicy"},"submissionPolicyId":{"maxLength":50,"minLength":0,"type":"string","description":"The submission policy identifier of the SIP."},"publicationDate":{"type":"string","description":"The publication date of the deposit.","format":"date"},"organizationalUnitId":{"type":"string","description":"The organizational unit identifier of the SIP."},"ready":{"type":"boolean","description":"If SIP package is ready.","readOnly":true},"dataFileNumber":{"type":"integer","description":"The number of SIP data files.","format":"int32","readOnly":true},"collectionSize":{"type":"integer","description":"The number of AIPs in collection AIP.","format":"int32","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","writeOnly":true,"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"]},"smartRetention":{"type":"string","description":"The retention duration in human-readable format of the package.","readOnly":true},"_links":{"$ref":"#/components/schemas/Links"}},"description":"Submission Information Package (SIP)"},"SubmissionPolicy":{"required":["name"],"type":"object","properties":{"creation":{"$ref":"#/components/schemas/ChangeInfo"},"lastUpdate":{"$ref":"#/components/schemas/ChangeInfo"},"resId":{"maxLength":50,"minLength":0,"type":"string","description":"The identifier of the resource. The default format is a Universally Unique IDentifier (UUID)."},"name":{"maxLength":255,"minLength":1,"type":"string","description":"The name of the submission policy."},"submissionApproval":{"type":"boolean","description":"If approval step is mandatory for submitting a deposit."},"timeToKeep":{"type":"integer","description":"The time in days to keep completed deposit before purge.","format":"int32"},"submissionAgreementType":{"type":"string","description":"The type of submission agreement when submitting a deposit:\n- WITHOUT => No submission agreement needed.\n- ON_FIRST_DEPOSIT => For the first deposit submission, the user has to approve the submission agreement once.\n- FOR_EACH_DEPOSIT => At each deposit submission, the user has to approve the submission agreement.\n","enum":["WITHOUT","ON_FIRST_DEPOSIT","FOR_EACH_DEPOSIT"]},"submissionAgreement":{"$ref":"#/components/schemas/SubmissionAgreement"},"useNumber":{"type":"integer","description":"The number of the submission policy use in organizational units.","format":"int32","readOnly":true},"_links":{"$ref":"#/components/schemas/Links"}},"description":"A submission policy is a policy that can be associated to an SIP. It defines whether an SIP can submitted with or without approval and the amount of time it should be kept."},"DataFileChecksum":{"required":["checksum","checksumAlgo","checksumOrigin","checksumType","creationTime"],"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"}}},"FileFormat":{"type":"object","properties":{"contentType":{"maxLength":100,"minLength":0,"type":"string","description":"The content type of the file."},"details":{"type":"string","description":"The result details of the file format identification."},"format":{"type":"string","description":"The format description of the file."},"md5":{"maxLength":256,"minLength":0,"type":"string","description":"The MD5 checksum of the file."},"puid":{"maxLength":20,"minLength":0,"type":"string","description":"The format PRONOM identifier of the  file."},"tool":{"$ref":"#/components/schemas/Tool"},"version":{"maxLength":50,"minLength":0,"type":"string","description":"The format version of the file."}},"description":"File format informations."},"MetadataType":{"required":["metadataFormat","name","version"],"type":"object","properties":{"creation":{"$ref":"#/components/schemas/ChangeInfo"},"lastUpdate":{"$ref":"#/components/schemas/ChangeInfo"},"resId":{"maxLength":50,"minLength":0,"type":"string","description":"The identifier of the resource. The default format is a Universally Unique IDentifier (UUID)."},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"The description of the metadata type."},"metadataFormat":{"type":"string","description":"The metadata format:\n- JSON\n- XML\n- SCHEMA_LESS\n- CUSTOM\n","enum":["CUSTOM","JSON","SCHEMA_LESS","XML"]},"metadataSchema":{"type":"string","description":"The schema of the metadata type."},"name":{"maxLength":255,"minLength":1,"type":"string","description":"The name of the metadata type."},"url":{"type":"string","description":"The URL of the metadata type.","format":"url"},"version":{"maxLength":50,"minLength":1,"type":"string","description":"The version of the metadata type."},"fullName":{"type":"string","description":"The name and the version of the metadata type.","readOnly":true},"_links":{"$ref":"#/components/schemas/Links"}},"description":"The metadata type allow to define custom metadata."},"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":{"type":"object"}}},"SipDataFile":{"required":["dataCategory","dataType","fileName","infoPackage","sourceData"],"type":"object","properties":{"creation":{"$ref":"#/components/schemas/ChangeInfo"},"lastUpdate":{"$ref":"#/components/schemas/ChangeInfo"},"resId":{"maxLength":50,"minLength":0,"type":"string","description":"The identifier of the resource. The default format is a Universally Unique IDentifier (UUID)."},"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":{"maxLength":460,"minLength":0,"pattern":"(^\\/$)|(^\\/.*(?<!\\/)$)","type":"string"},"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":{"maxLength":1024,"minLength":0,"type":"string"},"virusCheck":{"$ref":"#/components/schemas/VirusCheck"},"checksums":{"type":"array","items":{"$ref":"#/components/schemas/DataFileChecksum"}},"infoPackage":{"$ref":"#/components/schemas/SubmissionInfoPackage"},"fileStatus":{"type":"string","writeOnly":true,"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"]},"fullFileName":{"type":"string","readOnly":true},"inProgress":{"type":"boolean"},"smartSize":{"type":"string","readOnly":true},"_links":{"$ref":"#/components/schemas/Links"}}},"Tool":{"type":"object","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."}},"description":"Software tool information."},"VirusCheck":{"type":"object","properties":{"checkDate":{"type":"string","description":"The execution date of the virus check.","format":"date-time"},"details":{"type":"string","description":"The result details of the virus check."},"tool":{"$ref":"#/components/schemas/Tool"}},"description":"Virus check information."},"Result":{"type":"object","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"}},"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"},"ArchivalInfoPackage":{"required":["archiveContainer","info","lastArchiving"],"type":"object","properties":{"creation":{"$ref":"#/components/schemas/ChangeInfo"},"lastUpdate":{"$ref":"#/components/schemas/ChangeInfo"},"resId":{"maxLength":50,"minLength":0,"type":"string","description":"The identifier of the resource. The default format is a Universally Unique IDentifier (UUID)."},"dispositionApproval":{"type":"boolean","description":"If the approval step the AIP disposal is mandatory."},"retention":{"type":"integer","description":"The retention duration in days of the AIP: O means forever.","format":"int32"},"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","description":"The total number of files in the AIP.","format":"int64"},"updateNumber":{"type":"integer","description":"The number of updates in the AIP.","format":"int64"},"collectionFileNumber":{"type":"integer","description":"The total number of filed in the collection AIP.","format":"int64"},"archiveSize":{"type":"integer","description":"The size in bytes of the AIP.","format":"int64"},"tombstoneSize":{"type":"integer","description":"The size in bytes of the tombstone AIP.","format":"int64"},"collectionArchiveSize":{"type":"integer","description":"The total size in bytes of the collection AIP.","format":"int64"},"checksumCheck":{"$ref":"#/components/schemas/ChecksumCheck"},"checksums":{"type":"array","description":"The checksum list of the AIP.","items":{"$ref":"#/components/schemas/DataFileChecksum"}},"fileFormat":{"$ref":"#/components/schemas/FileFormat"},"info":{"$ref":"#/components/schemas/RepresentationInfo"},"sipIds":{"type":"array","description":"The source SIP list (IDs) of the AIP.","items":{"type":"string","description":"The source SIP list (IDs) of the AIP."}},"virusCheck":{"$ref":"#/components/schemas/VirusCheck"},"publicationDate":{"type":"string","description":"The publication date of the AIP.","format":"date"},"lastArchiving":{"type":"string","description":"The last archiving process date of the AIP: the first archiving date or the last metadata edition.","format":"date-time"},"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","writeOnly":true,"enum":["NOT_ASSESSED","NO_COMPLIANCE","WEAK_COMPLIANCE","AVERAGE_COMPLIANCE","FULL_COMPLIANCE"]},"dataFileNumber":{"type":"integer","description":"The number of AIP data files.","format":"int32","readOnly":true},"smartSize":{"type":"string","description":"The size in human-readable format of the AIP.","readOnly":true},"retentionEnd":{"type":"string","description":"The end of the AIP retention.","format":"date-time","readOnly":true},"collectionSize":{"type":"integer","description":"The number of AIPs in collection AIP.","format":"int32","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","writeOnly":true,"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"]},"smartRetention":{"type":"string","description":"The retention duration in human-readable format of the package.","readOnly":true},"_links":{"$ref":"#/components/schemas/Links"}},"description":"Archival Information Package (AIP)"},"ChecksumCheck":{"type":"object","properties":{"checkDate":{"type":"string","description":"The execution date of checksum verification.","format":"date-time"},"checkingSucceed":{"type":"boolean","description":"The execution result of checksum verification."}},"description":"Checksum verification information."},"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"}}},"RestCollectionPage":{"type":"object","properties":{"currentPage":{"type":"integer","format":"int64"},"sizePage":{"type":"integer","format":"int64"},"totalItems":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int64"}}},"RestCollectionSubmissionInfoPackage":{"type":"object","properties":{"_links":{"$ref":"#/components/schemas/Links"},"_data":{"type":"array","items":{"$ref":"#/components/schemas/SubmissionInfoPackage"}},"_facets":{"type":"array","items":{"$ref":"#/components/schemas/FacetResult"}},"_page":{"$ref":"#/components/schemas/RestCollectionPage"}},"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"},"Module":{"type":"object","properties":{"name":{"type":"string","description":"The name of the module."},"_links":{"$ref":"#/components/schemas/Links"}},"description":"The functional module."},"RestCollectionSipDataFile":{"type":"object","properties":{"_links":{"$ref":"#/components/schemas/Links"},"_data":{"type":"array","items":{"$ref":"#/components/schemas/SipDataFile"}},"_facets":{"type":"array","items":{"$ref":"#/components/schemas/FacetResult"}},"_page":{"$ref":"#/components/schemas/RestCollectionPage"}},"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"},"Pageable":{"type":"object","properties":{"page":{"minimum":0,"type":"integer","format":"int32"},"size":{"minimum":1,"type":"integer","format":"int32"},"sort":{"type":"array","items":{"type":"string"}}}},"RestCollectionStatusHistory":{"type":"object","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"}},"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"},"StatusHistory":{"required":["changeTime","status"],"type":"object","properties":{"changeTime":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"creatorName":{"type":"string"},"description":{"maxLength":1024,"minLength":0,"type":"string"},"status":{"type":"string"}}},"DownloadToken":{"required":["resourceType"],"type":"object","properties":{"creation":{"$ref":"#/components/schemas/ChangeInfo"},"lastUpdate":{"$ref":"#/components/schemas/ChangeInfo"},"resId":{"maxLength":50,"minLength":0,"type":"string","description":"The identifier of the resource. The default format is a Universally Unique IDentifier (UUID)."},"userId":{"maxLength":50,"minLength":0,"type":"string","description":"The user identifier of the download token."},"resourceId":{"maxLength":50,"minLength":0,"type":"string","description":"The resource identifier of the download token."},"resourceType":{"type":"string","description":"The resource type of the download token."},"token":{"type":"string","description":"The token of the download token."},"_links":{"$ref":"#/components/schemas/Links"}},"description":"The download token."},"RestCollectionArchivalInfoPackage":{"type":"object","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"}},"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"},"StreamingResponseBody":{"type":"object"},"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":"doc/oauth/authorize","tokenUrl":"doc/oauth/token","scopes":{"app-dlcm":"DLCM Solution"}}}}}}}