{"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":{"/preingest/deposits":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_list","parameters":[{"name":"access","in":"query","description":"The access level of the deposit.","required":false,"schema":{"type":"string","enum":["PUBLIC","RESTRICTED","CLOSED"]}},{"name":"additionalFieldsFormId","in":"query","description":"The additional fields form ID used to generate the additional fields values.","required":false,"schema":{"type":"string"}},{"name":"additionalFieldsValues","in":"query","description":"Some eventual additional fields values generated through an additional fields form.","required":false,"schema":{"type":"string"}},{"name":"archiveTypeId","in":"query","description":"The archive type identifier of the deposit.","required":false,"schema":{"type":"string"}},{"name":"ark","in":"query","description":"The ARK Identifier of the deposit.","required":false,"schema":{"type":"string"}},{"name":"collectionBegin","in":"query","description":"The start date of the deposit for collecting data.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"collectionEnd","in":"query","description":"The end date of the deposit for collecting data.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"containsUpdatedMetadata","in":"query","description":"If the package contains updated metadata.","required":false,"schema":{"type":"boolean"}},{"name":"contentStructurePublic","in":"query","description":"If the archive structure content is public.","required":false,"schema":{"type":"boolean"}},{"name":"dataSensitivity","in":"query","description":"The data sensitivity of the deposit.","required":false,"schema":{"type":"string","enum":["UNDEFINED","BLUE","GREEN","YELLOW","ORANGE","RED","CRIMSON"]}},{"name":"dataUsePolicy","in":"query","description":"The data use policy of the deposit.","required":false,"schema":{"type":"string","enum":["NONE","LICENSE","CLICK_THROUGH_DUA","SIGNED_DUA","EXTERNAL_DUA"]}},{"name":"description","in":"query","description":"The description of the deposit.","required":false,"schema":{"type":"string"}},{"name":"doi","in":"query","description":"The Digital Object Identifier (DOI) of the deposit.","required":false,"schema":{"type":"string"}},{"name":"isIdenticalTo","in":"query","description":"DOI indicates that Archive A is identical to B, used to register two separate instances of the same resource.","required":false,"schema":{"type":"string"}},{"name":"isObsoletedBy","in":"query","description":"DOI indicates A is replaced by B.","required":false,"schema":{"type":"string"}},{"name":"languageId","in":"query","description":"The language identifier of the deposit.","required":false,"schema":{"type":"string"}},{"name":"licenseId","in":"query","description":"The license identifier of the deposit.","required":false,"schema":{"type":"string"}},{"name":"metadataVersion","in":"query","description":"The metadata version of the deposit.","required":false,"schema":{"type":"string","enum":["1.0","1.1","2.0","2.1","3.0","3.1","4.0","5.0"]}},{"name":"organizationalUnitId","in":"query","description":"The organizational unit identifier of the deposit.","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":"preparationId","in":"query","description":"The preparation identifier of the deposit.","required":false,"schema":{"type":"string"}},{"name":"preservationPolicyId","in":"query","description":"The preservation policy identifier of the deposit.","required":false,"schema":{"type":"string"}},{"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":"sipId","in":"query","description":"The generated SIP identifier of the deposit.","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":"status","in":"query","description":"The status of the deposit.","required":false,"schema":{"type":"string","enum":["APPROVED","CHECKED","CLEANED","CLEANING","COMPLETED","DELETING","IN_ERROR","IN_PROGRESS","IN_VALIDATION","REJECTED","SUBMITTED","EDITING_METADATA","UPGRADING_METADATA","CHECKING_COMPLIANCE","CHECKING_COMPLIANCE_CLEANED","COMPLIANCE_ERROR","CANCEL_EDITING_METADATA","EDITING_METADATA_REJECTED","SUBMISSION_AGREEMENT_APPROVED","RELOADING"]}},{"name":"statusMessage","in":"query","description":"The detailed message related to the deposit status.","required":false,"schema":{"type":"string"}},{"name":"submissionPolicyId","in":"query","description":"The submission policy identifier of the deposit.","required":false,"schema":{"type":"string"}},{"name":"title","in":"query","description":"The title of the deposit.","required":false,"schema":{"type":"string"}},{"name":"lightVersion","in":"query","required":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RestCollectionDeposit"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deposit"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Deposit"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"delete":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_deleteList","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{parentId}/submission-agreements":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_submission-agreements_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/RestCollectionSubmissionAgreement"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_submission-agreements_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/SubmissionAgreement"}}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"delete":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_submission-agreements_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":[]}]}},"/preingest/deposits/{parentId}/subject-areas":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_subject-areas_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/RestCollectionSubjectArea"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_subject-areas_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/SubjectArea"}}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"delete":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_subject-areas_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":[]}]}},"/preingest/deposits/{parentId}/licenses":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_licenses_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/RestCollectionLicense"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_licenses_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/License"}}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"delete":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_licenses_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":[]}]}},"/preingest/deposits/{parentId}/data":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_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/RestCollectionDepositDataFile"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_data_create","parameters":[{"name":"parentId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepositDataFile"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DepositDataFile"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"delete":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_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":[]}]}},"/preingest/deposits/{parentId}/data/{id}/validate":{"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_data_by_id_validate","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":[]}]}},"/preingest/deposits/{parentId}/data/{id}/resume":{"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_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":[]}]}},"/preingest/deposits/{parentId}/data/validate":{"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_data_validate","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":[]}]}},"/preingest/deposits/{parentId}/data/resume":{"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_data_resume","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":[]}]}},"/preingest/deposits/{parentId}/data/resume-all":{"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_data_resume-all","parameters":[{"name":"parentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{parentId}/data/delete-folder":{"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_data_delete-folder","parameters":[{"name":"parentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"relativeLocation","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{parentId}/contributors":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_contributors_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/RestCollectionPerson"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_contributors_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/Person"}}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"delete":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_contributors_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":[]}]}},"/preingest/deposits/{parentId}/aip":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_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":["preingest/deposits"],"operationId":"preingest_deposits_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":["preingest/deposits"],"operationId":"preingest_deposits_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":[]}]}},"/preingest/deposits/{id}/upload":{"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_upload","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"category","in":"query","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"type":"string"}},{"name":"folder","in":"query","required":false,"schema":{"type":"string"}},{"name":"metadataType","in":"query","required":false,"schema":{"type":"string"}},{"name":"checksumMd5","in":"query","required":false,"schema":{"type":"string"}},{"name":"checksumMd5Origin","in":"query","required":false,"schema":{"type":"string"}},{"name":"checksumSha1","in":"query","required":false,"schema":{"type":"string"}},{"name":"checksumSha1Origin","in":"query","required":false,"schema":{"type":"string"}},{"name":"checksumSha256","in":"query","required":false,"schema":{"type":"string"}},{"name":"checksumSha256Origin","in":"query","required":false,"schema":{"type":"string"}},{"name":"checksumSha512","in":"query","required":false,"schema":{"type":"string"}},{"name":"checksumSha512Origin","in":"query","required":false,"schema":{"type":"string"}},{"name":"checksumCrc32","in":"query","required":false,"schema":{"type":"string"}},{"name":"checksumCrc32Origin","in":"query","required":false,"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/DepositDataFile"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{id}/upload-metadata":{"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_upload-metadata","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/DepositDataFile"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{id}/upload-archive":{"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_upload-archive","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"category","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":"type","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":"metadataType","in":"query","required":false,"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":{"type":"array","items":{"$ref":"#/components/schemas/DepositDataFile"}}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{id}/submit-for-approval":{"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_submit-for-approval","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{id}/start-metadata-upgrade":{"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_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":[]}]}},"/preingest/deposits/{id}/start-metadata-editing":{"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_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":[]}]}},"/preingest/deposits/{id}/reserve-doi":{"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_reserve-doi","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Deposit"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{id}/reject":{"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_reject","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":[]}]}},"/preingest/deposits/{id}/put-in-error":{"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_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":[]}]}},"/preingest/deposits/{id}/generate-anonymized-deposit-page":{"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_generate-anonymized-deposit-page","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{id}/fix":{"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_fix","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{id}/enable-revision":{"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_enable-revision","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{id}/clean":{"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_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":[]}]}},"/preingest/deposits/{id}/check-submission-agreement":{"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_check-submission-agreement","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{id}/check-compliance":{"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_check-compliance","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{id}/cancel-metadata-editing":{"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_cancel-metadata-editing","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{id}/approve":{"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_approve","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{id}/approve-submission-agreement":{"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_approve-submission-agreement","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/search":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_search_advancedSearch_get","parameters":[{"name":"access","in":"query","description":"The access level of the deposit.","required":false,"schema":{"type":"string","enum":["PUBLIC","RESTRICTED","CLOSED"]}},{"name":"additionalFieldsFormId","in":"query","description":"The additional fields form ID used to generate the additional fields values.","required":false,"schema":{"type":"string"}},{"name":"additionalFieldsValues","in":"query","description":"Some eventual additional fields values generated through an additional fields form.","required":false,"schema":{"type":"string"}},{"name":"archiveTypeId","in":"query","description":"The archive type identifier of the deposit.","required":false,"schema":{"type":"string"}},{"name":"ark","in":"query","description":"The ARK Identifier of the deposit.","required":false,"schema":{"type":"string"}},{"name":"collectionBegin","in":"query","description":"The start date of the deposit for collecting data.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"collectionEnd","in":"query","description":"The end date of the deposit for collecting data.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"containsUpdatedMetadata","in":"query","description":"If the package contains updated metadata.","required":false,"schema":{"type":"boolean"}},{"name":"contentStructurePublic","in":"query","description":"If the archive structure content is public.","required":false,"schema":{"type":"boolean"}},{"name":"dataSensitivity","in":"query","description":"The data sensitivity of the deposit.","required":false,"schema":{"type":"string","enum":["UNDEFINED","BLUE","GREEN","YELLOW","ORANGE","RED","CRIMSON"]}},{"name":"dataUsePolicy","in":"query","description":"The data use policy of the deposit.","required":false,"schema":{"type":"string","enum":["NONE","LICENSE","CLICK_THROUGH_DUA","SIGNED_DUA","EXTERNAL_DUA"]}},{"name":"description","in":"query","description":"The description of the deposit.","required":false,"schema":{"type":"string"}},{"name":"doi","in":"query","description":"The Digital Object Identifier (DOI) of the deposit.","required":false,"schema":{"type":"string"}},{"name":"isIdenticalTo","in":"query","description":"DOI indicates that Archive A is identical to B, used to register two separate instances of the same resource.","required":false,"schema":{"type":"string"}},{"name":"isObsoletedBy","in":"query","description":"DOI indicates A is replaced by B.","required":false,"schema":{"type":"string"}},{"name":"languageId","in":"query","description":"The language identifier of the deposit.","required":false,"schema":{"type":"string"}},{"name":"licenseId","in":"query","description":"The license identifier of the deposit.","required":false,"schema":{"type":"string"}},{"name":"match","in":"query","required":false,"schema":{"type":"string"}},{"name":"metadataVersion","in":"query","description":"The metadata version of the deposit.","required":false,"schema":{"type":"string","enum":["1.0","1.1","2.0","2.1","3.0","3.1","4.0","5.0"]}},{"name":"organizationalUnitId","in":"query","description":"The organizational unit identifier of the deposit.","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":"preparationId","in":"query","description":"The preparation identifier of the deposit.","required":false,"schema":{"type":"string"}},{"name":"preservationPolicyId","in":"query","description":"The preservation policy identifier of the deposit.","required":false,"schema":{"type":"string"}},{"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":"search","in":"query","required":true,"schema":{"type":"string"}},{"name":"sipId","in":"query","description":"The generated SIP identifier of the deposit.","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":"status","in":"query","description":"The status of the deposit.","required":false,"schema":{"type":"string","enum":["APPROVED","CHECKED","CLEANED","CLEANING","COMPLETED","DELETING","IN_ERROR","IN_PROGRESS","IN_VALIDATION","REJECTED","SUBMITTED","EDITING_METADATA","UPGRADING_METADATA","CHECKING_COMPLIANCE","CHECKING_COMPLIANCE_CLEANED","COMPLIANCE_ERROR","CANCEL_EDITING_METADATA","EDITING_METADATA_REJECTED","SUBMISSION_AGREEMENT_APPROVED","RELOADING"]}},{"name":"statusMessage","in":"query","description":"The detailed message related to the deposit status.","required":false,"schema":{"type":"string"}},{"name":"submissionPolicyId","in":"query","description":"The submission policy identifier of the deposit.","required":false,"schema":{"type":"string"}},{"name":"title","in":"query","description":"The title of the deposit.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RestCollectionDeposit"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"post":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_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/Deposit"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RestCollectionDeposit"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{parentId}/submission-agreements/{id}":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_submission-agreements_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/SubmissionAgreement"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"delete":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_submission-agreements_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":["preingest/deposits"],"operationId":"preingest_deposits_by_id_submission-agreements_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/SubmissionAgreement"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SubmissionAgreement"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{parentId}/subject-areas/{id}":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_subject-areas_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/SubjectArea"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"delete":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_subject-areas_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":["preingest/deposits"],"operationId":"preingest_deposits_by_id_subject-areas_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/SubjectArea"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SubjectArea"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{parentId}/licenses/{id}":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_licenses_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/License"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"delete":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_licenses_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":["preingest/deposits"],"operationId":"preingest_deposits_by_id_licenses_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/License"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/License"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{parentId}/data/{id}":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_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/DepositDataFile"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"delete":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_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":["preingest/deposits"],"operationId":"preingest_deposits_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/DepositDataFile"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{parentId}/contributors/{id}":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_contributors_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/Person"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"delete":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_contributors_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":["preingest/deposits"],"operationId":"preingest_deposits_by_id_contributors_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/Person"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Person"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{parentId}/aip/{id}":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_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":["preingest/deposits"],"operationId":"preingest_deposits_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":["preingest/deposits"],"operationId":"preingest_deposits_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":[]}]}},"/preingest/deposits/{id}":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Deposit"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]},"delete":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}},"security":[{"tokenAuth":[]},{"auth":[]}]},"patch":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_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/Deposit"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest":{"get":{"tags":["preingest"],"operationId":"preingest_home","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Module"}}}}}}},"/preingest/deposits/{parentId}/data/{id}/history":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_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":[]}]}},"/preingest/deposits/{parentId}/data/{id}/download":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_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":[]}]}},"/preingest/deposits/{parentId}/data/{id}/download-token":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_data_by_id_download-token_getTokenForDepositDataFile","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":[]}]}},"/preingest/deposits/{parentId}/data/search":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_data_search_get","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":"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":"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":"search","in":"query","required":true,"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/RestCollectionDepositDataFile"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{parentId}/data/list-status":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_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":[]}]}},"/preingest/deposits/{parentId}/data/list-folders":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_data_list-folders","parameters":[{"name":"parentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{parentId}/data/list-current-status":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_data_list-current-status","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":"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":"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":{"type":"object"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{id}/sip-package":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_sip-package_getSIP","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":["preingest/deposits"],"operationId":"preingest_deposits_by_id_sip-package_deleteSIP","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{id}/history":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_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":[]}]}},"/preingest/deposits/{id}/download":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_download_getFiles","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"folder","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{id}/download-token":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_download-token_getTokenForDeposit","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DownloadToken"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/{id}/download-anonymized-deposit":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_by_id_download-anonymized-deposit","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/schema":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_schema","parameters":[{"name":"version","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StreamingResponseBody"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/profile":{"get":{"tags":["preingest/deposits"],"summary":"Download profile of a package","description":"Returns a binary stream (file).","operationId":"preingest_deposits_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":[]}]}},"/preingest/deposits/list-status":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_list-status","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"string","enum":["APPROVED","CHECKED","CLEANED","CLEANING","COMPLETED","DELETING","IN_ERROR","IN_PROGRESS","IN_VALIDATION","REJECTED","SUBMITTED","EDITING_METADATA","UPGRADING_METADATA","CHECKING_COMPLIANCE","CHECKING_COMPLIANCE_CLEANED","COMPLIANCE_ERROR","CANCEL_EDITING_METADATA","EDITING_METADATA_REJECTED","SUBMISSION_AGREEMENT_APPROVED","RELOADING"]}}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/list-metadata-versions":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_list-metadata-versions","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/list-ignore-files":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_list-ignore-files_ignoreList","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/FileList"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/list-exclude-files":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_list-exclude-files_excludeList","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/FileList"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/deposits/list-data-types":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_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":[]}]}},"/preingest/deposits/list-data-categories":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_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":[]}]}},"/preingest/deposits/list-accesses":{"get":{"tags":["preingest/deposits"],"operationId":"preingest_deposits_list-accesses","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"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"]}}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/contributors":{"get":{"tags":["preingest/contributors"],"operationId":"preingest_contributors_list","parameters":[{"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/RestCollectionContributor"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/contributors/{parentId}/deposits":{"get":{"tags":["preingest/contributors"],"operationId":"preingest_contributors_by_id_deposits_list","parameters":[{"name":"parentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"filterItem","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DepositContributor"}},{"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/RestCollectionDeposit"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/contributors/{parentId}/deposits/{id}":{"get":{"tags":["preingest/contributors"],"operationId":"preingest_contributors_by_id_deposits_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/Deposit"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}},"/preingest/contributors/{id}":{"get":{"tags":["preingest/contributors"],"operationId":"preingest_contributors_by_id_get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Contributor"}}}}},"security":[{"tokenAuth":[]},{"auth":[]}]}}},"components":{"schemas":{"ArchiveType":{"required":["typeName"],"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)."},"masterType":{"$ref":"#/components/schemas/ArchiveType"},"typeName":{"type":"string","description":"The name of the archive type."},"masterArchiveType":{"type":"boolean","description":"If the archive type is a master type.","readOnly":true},"_links":{"$ref":"#/components/schemas/Links"}},"description":"Archive type based on DataCite notion."},"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."},"Deposit":{"required":["dataSensitivity","description","metadataVersion","organizationalUnitId","publicationDate","title"],"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"}},"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"]},"dataFileNumber":{"type":"integer","description":"The number of deposit data files.","format":"int32","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"]},"collectionBegin":{"type":"string","description":"The start date of the deposit for collecting data.","format":"date-time"},"collectionEnd":{"type":"string","description":"The end date of the deposit for collecting data.","format":"date-time"},"description":{"maxLength":4096,"minLength":1,"type":"string","description":"The description of the deposit."},"doi":{"type":"string","description":"The Digital Object Identifier (DOI) of the deposit."},"ark":{"type":"string","description":"The ARK Identifier of the deposit."},"embargo":{"$ref":"#/components/schemas/EmbargoInfo"},"keywords":{"type":"array","description":"The keyword List of the deposit.","items":{"type":"string","description":"The keyword List of the deposit."}},"language":{"$ref":"#/components/schemas/Language"},"languageId":{"maxLength":50,"minLength":0,"type":"string","description":"The language identifier of the deposit."},"licenseId":{"type":"string","description":"The license identifier of the deposit."},"archiveTypeId":{"type":"string","description":"The archive type identifier of the deposit."},"archiveType":{"$ref":"#/components/schemas/ArchiveType"},"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"]},"organizationalUnit":{"$ref":"#/components/schemas/OrganizationalUnit"},"organizationalUnitId":{"maxLength":2147483647,"minLength":1,"type":"string","description":"The organizational unit identifier of the deposit."},"preparationId":{"maxLength":50,"minLength":0,"type":"string","description":"The preparation identifier of the deposit."},"preservationPolicy":{"$ref":"#/components/schemas/PreservationPolicy"},"preservationPolicyId":{"maxLength":50,"minLength":0,"type":"string","description":"The preservation policy identifier of the deposit."},"publicationDate":{"type":"string","description":"The publication date of the deposit.","format":"date"},"sipId":{"maxLength":50,"minLength":0,"type":"string","description":"The generated SIP identifier of the deposit."},"status":{"type":"string","description":"The status of the deposit.","enum":["APPROVED","CHECKED","CLEANED","CLEANING","COMPLETED","DELETING","IN_ERROR","IN_PROGRESS","IN_VALIDATION","REJECTED","SUBMITTED","EDITING_METADATA","UPGRADING_METADATA","CHECKING_COMPLIANCE","CHECKING_COMPLIANCE_CLEANED","COMPLIANCE_ERROR","CANCEL_EDITING_METADATA","EDITING_METADATA_REJECTED","SUBMISSION_AGREEMENT_APPROVED","RELOADING"]},"statusMessage":{"maxLength":1024,"minLength":0,"type":"string","description":"The detailed message related to the deposit status."},"submissionPolicy":{"$ref":"#/components/schemas/SubmissionPolicy"},"submissionPolicyId":{"maxLength":50,"minLength":0,"type":"string","description":"The submission policy identifier of the deposit."},"title":{"maxLength":255,"minLength":1,"type":"string","description":"The title of the deposit."},"containsUpdatedMetadata":{"type":"boolean","description":"If the package contains updated metadata."},"contentStructurePublic":{"type":"boolean","description":"If the archive structure content is public."},"isIdenticalTo":{"type":"string","description":"DOI indicates that Archive A is identical to B, used to register two separate instances of the same resource."},"isObsoletedBy":{"type":"string","description":"DOI indicates A is replaced by B."},"isReferencedBy":{"type":"array","description":"List of DOI or ARK which indicates A is used as a source of information by B.","items":{"type":"string","description":"List of DOI or ARK which indicates A is used as a source of information by B."}},"anonymizedDepositPageId":{"type":"string","description":"The id of the page listing all anonymized deposits of a given deposit"},"additionalFieldsValues":{"type":"string","description":"Some eventual additional fields values generated through an additional fields form."},"additionalFieldsFormId":{"maxLength":50,"minLength":0,"type":"string","description":"The additional fields form ID used to generate the additional fields values."},"errorStatusWithMessage":{"type":"string","writeOnly":true},"collectionSize":{"type":"integer","description":"The number of archives in the deposit.","format":"int32","readOnly":true},"hasEmbargo":{"type":"boolean"},"_links":{"$ref":"#/components/schemas/Links"}},"description":"A deposit is a simple package to prepare a SIP.\nDeposit status:\n- APPROVED => Approved deposit. The SIP preparation is in progress.\n- CANCEL_EDITING_METADATA => A cancellation of metadata edition is in progress.\n- CHECKED => Checked deposit. The deposit is ready for SIP preparation.\n- CHECKING_COMPLIANCE => A compliance check is in progress for completed deposits.\n- CHECKING_COMPLIANCE_CLEANED => A compliance check is in progress for cleaned deposits.\n- CLEANED => Cleaned deposit: the data file are purged based on submission policy.\n- CLEANING => A clean process is in progress.\n- COMPLETED => Completed deposit. The preparation of SIP is completed.\n- COMPLIANCE_ERROR => An error occurred during a compliance check.\n- DELETING => A deletion process is in progress.\n- EDITING_METADATA_REJECTED => The metadata edition was rejected.\n- EDITING_METADATA => The deposit is in edition mode for metadata.\n- IN_ERROR => An error occurred during the SIP preparation.\n- IN_PROGRESS => The deposit is in progress, ready for adding data files.\n- IN_VALIDATION => The deposit is waiting for an approval.\n- REJECTED => The deposit was rejected.\n- RELOADING => The deposit is a reload process.\n- SUBMITTED => Submitted deposit. The SIP preparation is in progress.\n- UPGRADING_METADATA => The deposit is in upgrade mode of metadata version.\n"},"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."},"Label":{"required":["text"],"type":"object","properties":{"language":{"$ref":"#/components/schemas/LanguageDTO"},"text":{"maxLength":1024,"minLength":0,"type":"string"}}},"Language":{"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)."},"code":{"type":"string","description":"The ISO 639-1 code of the language"},"iso6392":{"type":"string","description":"The ISO 639-2 code of the language"},"sortValue":{"type":"integer","description":"Property allowing to sort languages in lists","format":"int32"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"}},"_links":{"$ref":"#/components/schemas/Links"}},"description":"The language for internationalization (i18n) & localization (L10n)"},"LanguageDTO":{"type":"object","properties":{"resId":{"type":"string"},"code":{"type":"string"},"iso6392":{"type":"string"},"sortValue":{"type":"integer","format":"int32"}}},"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."},"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"}}},"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"},"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."},"SubjectArea":{"required":["code","name","source"],"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"}},"code":{"maxLength":50,"minLength":1,"type":"string","description":"The code of the subject area."},"labels":{"type":"array","description":"The name labels for each supported languages of the subject area.","items":{"$ref":"#/components/schemas/Label"}},"name":{"maxLength":1024,"minLength":0,"type":"string","description":"The name of the subject area."},"source":{"maxLength":30,"minLength":1,"type":"string","description":"The source of the subject area."},"_links":{"$ref":"#/components/schemas/Links"}},"description":"A subject area delineates a range of academic, administrative, and patrimonial disciplines.\nEach of these disciplines may follow its own classification system, reflecting their unique attributes and contexts (for example: SNF Disciplines, http://www.snf.ch/SiteCollectionDocuments/allg_disziplinenliste.pdf, or re3data Subjects, https://www.re3data.org/browse/by-subject/, for academic disciplines). A subject area could be associated with a specific organizational unit."},"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"}}},"DepositDataFile":{"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/Deposit"},"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"}}},"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."},"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"},"OrcidToken":{"required":["orcid","scope"],"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)."},"scope":{"type":"string"},"name":{"type":"string"},"orcid":{"type":"string"},"expiresIn":{"type":"string","format":"date-time"},"_links":{"$ref":"#/components/schemas/Links"}},"description":"Personal token allowing to interact with ORCID API."},"Person":{"required":["firstName","lastName","verifiedOrcid"],"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"}},"firstName":{"maxLength":255,"minLength":1,"type":"string","description":"The first name of the person."},"lastName":{"maxLength":255,"minLength":1,"type":"string","description":"The last name of the person."},"orcid":{"pattern":"|[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{4}|[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}X","type":"string","description":"The ORCID of the person (Format: xxxx-xxxx-xxxx-xxxx)."},"verifiedOrcid":{"type":"boolean","description":"if the person ORCID is verified with ORCID authentication."},"orcidToken":{"$ref":"#/components/schemas/OrcidToken"},"avatar":{"$ref":"#/components/schemas/PersonAvatar"},"fullName":{"type":"string","description":"The full name of the person."},"_links":{"$ref":"#/components/schemas/Links"}},"description":"A person is associated to a user on the platform. It contains information such as the person’s ORCID, institution and organizational units it belongs to."},"PersonAvatar":{"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 avatar of the person."},"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."},"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."},"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"}}},"RestCollectionDeposit":{"type":"object","properties":{"_links":{"$ref":"#/components/schemas/Links"},"_data":{"type":"array","items":{"$ref":"#/components/schemas/Deposit"}},"_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"},"RestCollectionPage":{"type":"object","properties":{"currentPage":{"type":"integer","format":"int64"},"sizePage":{"type":"integer","format":"int64"},"totalItems":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int64"}}},"Module":{"type":"object","properties":{"name":{"type":"string","description":"The name of the module."},"_links":{"$ref":"#/components/schemas/Links"}},"description":"The functional module."},"RestCollectionSubmissionAgreement":{"type":"object","properties":{"_links":{"$ref":"#/components/schemas/Links"},"_data":{"type":"array","items":{"$ref":"#/components/schemas/SubmissionAgreement"}},"_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"},"RestCollectionSubjectArea":{"type":"object","properties":{"_links":{"$ref":"#/components/schemas/Links"},"_data":{"type":"array","items":{"$ref":"#/components/schemas/SubjectArea"}},"_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"},"RestCollectionLicense":{"type":"object","properties":{"_links":{"$ref":"#/components/schemas/Links"},"_data":{"type":"array","items":{"$ref":"#/components/schemas/License"}},"_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"},"RestCollectionDepositDataFile":{"type":"object","properties":{"_links":{"$ref":"#/components/schemas/Links"},"_data":{"type":"array","items":{"$ref":"#/components/schemas/DepositDataFile"}},"_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."},"RestCollectionPerson":{"type":"object","properties":{"_links":{"$ref":"#/components/schemas/Links"},"_data":{"type":"array","items":{"$ref":"#/components/schemas/Person"}},"_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"},"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"},"FileList":{"type":"object","properties":{"files":{"type":"array","items":{"type":"string"}},"puids":{"type":"array","items":{"type":"string"}}}},"Contributor":{"type":"object","properties":{"resId":{"type":"string"},"depositNumber":{"type":"integer","description":"The deposit number of the contributor.","format":"int32"},"fullName":{"type":"string"},"lastUpdate":{"$ref":"#/components/schemas/ChangeInfo"},"orcid":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"verifiedOrcid":{"type":"boolean"},"creation":{"$ref":"#/components/schemas/ChangeInfo"},"avatar":{"$ref":"#/components/schemas/PersonAvatar"},"_links":{"$ref":"#/components/schemas/Links"}},"description":"Contributors are people who are involved in archives."},"RestCollectionContributor":{"type":"object","properties":{"_links":{"$ref":"#/components/schemas/Links"},"_data":{"type":"array","items":{"$ref":"#/components/schemas/Contributor"}},"_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"},"DepositContributor":{"type":"object","properties":{"creation":{"$ref":"#/components/schemas/ChangeInfo"},"lastUpdate":{"$ref":"#/components/schemas/ChangeInfo"},"position":{"type":"integer","format":"int32"},"compositeKey":{"$ref":"#/components/schemas/DepositContributorId"},"_links":{"$ref":"#/components/schemas/Links"}}},"DepositContributorId":{"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"}}}}}}}