openapi: 3.0.3 info: title: Yareta Research Data API description: 'Yareta is the University of Geneva (UNIGE) e-Research long-term research-data preservation and access platform, built on the DLCM (Data Life Cycle Management) software stack. This OpenAPI description merges the public DLCM/Yareta backend modules: the Accession/Access service (https://access.yareta.unige.ch) for discovering, ordering and downloading archives (AIP/DIP), and the Ingestion/Pre-ingest service (https://ingest.yareta.unige.ch) for depositing and submitting research data. Faithfully converted from the live OpenAPI 3.1 definitions (Yareta API v3.1.7); only real paths and schemas are retained.' version: 3.1.7 contact: email: yareta-admin@unige.ch servers: - url: https://access.yareta.unige.ch description: Accession / Access module (discovery, orders, DIP download) - url: https://ingest.yareta.unige.ch description: Pre-ingest / Ingestion module (deposits, submission) tags: - name: Access description: Discover, order and download archives (AIP/DIP). - name: Ingest description: Deposit, validate and submit research data. - name: OAI-PMH description: OAI-PMH provider information and metadata formats. paths: /oai-info/oai-sets: get: tags: - OAI-PMH operationId: oai-info_oai-sets_list parameters: - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionOAISet' security: - tokenAuth: [] - auth: [] post: tags: - OAI-PMH operationId: oai-info_oai-sets_create requestBody: content: application/json: schema: $ref: '#/components/schemas/OAISet' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/OAISet' security: - tokenAuth: [] - auth: [] delete: tags: - OAI-PMH operationId: oai-info_oai-sets_deleteList requestBody: content: application/json: schema: type: array items: type: string required: true responses: '200': description: OK security: - tokenAuth: [] - auth: [] /oai-info/oai-sets/search: get: tags: - OAI-PMH operationId: oai-info_oai-sets_search_advancedSearch_get parameters: - name: search in: query required: true schema: type: string - name: match in: query required: false schema: type: string - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionOAISet' security: - tokenAuth: [] - auth: [] post: tags: - OAI-PMH operationId: oai-info_oai-sets_search_advancedSearch_post parameters: - name: match in: query required: false schema: type: string - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OAISet' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionOAISet' security: - tokenAuth: [] - auth: [] /oai-info/oai-provider/oai: get: tags: - OAI-PMH operationId: oai-info_oai-provider_oai_process parameters: - name: verb in: query required: false schema: type: string - name: identifier in: query required: false schema: type: string - name: metadataPrefix in: query required: false schema: type: string - name: from in: query required: false schema: type: string - name: until in: query required: false schema: type: string - name: set in: query required: false schema: type: string - name: resumptionToken in: query required: false schema: type: string - name: smartView in: query required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: string post: tags: - OAI-PMH operationId: oai-info_oai-provider_oai_processPost requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/MultiValueMapStringString' required: true responses: '200': description: OK content: '*/*': schema: type: string /oai-info/oai-metadata-prefixes: get: tags: - OAI-PMH operationId: oai-info_oai-metadata-prefixes_list parameters: - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionOAIMetadataPrefix' security: - tokenAuth: [] - auth: [] post: tags: - OAI-PMH operationId: oai-info_oai-metadata-prefixes_create requestBody: content: application/json: schema: $ref: '#/components/schemas/OAIMetadataPrefix' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/OAIMetadataPrefix' security: - tokenAuth: [] - auth: [] delete: tags: - OAI-PMH operationId: oai-info_oai-metadata-prefixes_deleteList requestBody: content: application/json: schema: type: array items: type: string required: true responses: '200': description: OK security: - tokenAuth: [] - auth: [] /oai-info/oai-metadata-prefixes/search: get: tags: - OAI-PMH operationId: oai-info_oai-metadata-prefixes_search_advancedSearch_get parameters: - name: search in: query required: true schema: type: string - name: match in: query required: false schema: type: string - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionOAIMetadataPrefix' security: - tokenAuth: [] - auth: [] post: tags: - OAI-PMH operationId: oai-info_oai-metadata-prefixes_search_advancedSearch_post parameters: - name: match in: query required: false schema: type: string - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OAIMetadataPrefix' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionOAIMetadataPrefix' security: - tokenAuth: [] - auth: [] /access/refresh/{aipId}: post: tags: - Access operationId: access_refresh_by_id_refresh parameters: - name: aipId in: path required: true schema: type: string responses: '200': description: OK security: - tokenAuth: [] - auth: [] /access/private-metadata/{aipId}/prepare-download: post: tags: - Access operationId: access_private-metadata_by_id_prepare-download parameters: - name: aipId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DisseminationPolicyDto' responses: '200': description: OK content: '*/*': schema: type: string security: - tokenAuth: [] - auth: [] /access/private-metadata/search: get: tags: - Access operationId: access_private-metadata_search_get parameters: - name: query in: query required: false schema: type: string - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionArchiveMetadata' security: - tokenAuth: [] - auth: [] post: tags: - Access operationId: access_private-metadata_search_post parameters: - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SearchCondition' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/MultiValueMapStringString' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionArchiveMetadata' security: - tokenAuth: [] - auth: [] /access/orders: get: tags: - Access operationId: access_orders_list parameters: - name: disseminationPolicyId in: query description: The dissemination policy identifier linked to the order. required: false schema: type: string - name: metadataVersion in: query description: The metadata version of the order query. required: false schema: type: string enum: - '1.0' - '1.1' - '2.0' - '2.1' - '3.0' - '3.1' - '4.0' - '5.0' - name: name in: query description: The name of the order query. required: false schema: type: string - name: organizationalUnitDisseminationPolicyId in: query description: The dissemination policy identifier linked to the orgunit. required: false schema: type: string - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: publicOrder in: query description: If the order is public, false otherwise. required: false schema: type: boolean - name: query in: query description: The query of the order query. required: false schema: type: string - name: queryType in: query description: The type of the order query. required: false schema: type: string enum: - ADVANCED - DIRECT - SIMPLE - name: resId in: query description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). required: false schema: type: string - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string - name: status in: query description: The status of the order query. required: false schema: type: string enum: - DOWNLOADING - IN_DISSEMINATION_PREPARATION - IN_ERROR - IN_PREPARATION - IN_PROGRESS - READY - SUBMITTED - name: statusMessage in: query description: The message related to the status of the order query. required: false schema: type: string - name: subitemsChecksum in: query description: The checksum of the order subitems list. required: false schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionOrder' security: - tokenAuth: [] - auth: [] post: tags: - Access operationId: access_orders_create requestBody: content: application/json: schema: $ref: '#/components/schemas/Order' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Order' security: - tokenAuth: [] - auth: [] delete: tags: - Access operationId: access_orders_deleteList requestBody: content: application/json: schema: type: array items: type: string required: true responses: '200': description: OK security: - tokenAuth: [] - auth: [] /access/orders/{parentid}/dip: get: tags: - Access operationId: access_orders_by_id_dip_list parameters: - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: parentid in: path required: true schema: type: string - name: resId in: query description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). required: false schema: type: string - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionDisseminationInfoPackage' security: - tokenAuth: [] - auth: [] post: tags: - Access operationId: access_orders_by_id_dip_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/DisseminationInfoPackage' security: - tokenAuth: [] - auth: [] delete: tags: - Access operationId: access_orders_by_id_dip_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: [] /access/orders/{parentid}/aip: get: tags: - Access operationId: access_orders_by_id_aip_list parameters: - name: archivalUnit in: query description: if the AIP is an unit (AIU) or a collection (AIC). required: false schema: type: boolean - name: archiveContainer in: query description: The container type of the AIP. required: false schema: type: string enum: - UNDEFINED - ZIP - BAG_IT - name: archiveFileNumber in: query description: The total number of files in the AIP. required: false schema: type: integer format: int64 - name: archiveId in: query description: The storage URI of the AIP. required: false schema: type: string - name: archiveSize in: query description: The size in bytes of the AIP. required: false schema: type: integer format: int64 - name: collectionArchiveSize in: query description: The total size in bytes of the collection AIP. required: false schema: type: integer format: int64 - name: collectionFileNumber in: query description: The total number of filed in the collection AIP. required: false schema: type: integer format: int64 - name: dispositionApproval in: query description: If the approval step the AIP disposal is mandatory. required: false schema: type: boolean - name: lastArchiving in: query description: 'The last archiving process date of the AIP: the first archiving date or the last metadata edition.' required: false schema: type: string format: date-time - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: parentid in: path required: true schema: type: string - name: publicationDate in: query description: The publication date of the AIP. required: false schema: type: string format: date - name: resId in: query description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). required: false schema: type: string - name: retention in: query description: 'The retention duration in days of the AIP: O means forever.' required: false schema: type: integer format: int32 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string - name: tombstoneSize in: query description: The size in bytes of the tombstone AIP. required: false schema: type: integer format: int64 - name: updateNumber in: query description: The number of updates in the AIP. required: false schema: type: integer format: int64 responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionArchivalInfoPackage' security: - tokenAuth: [] - auth: [] post: tags: - Access operationId: access_orders_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: - Access operationId: access_orders_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: [] /access/orders/{id}/submit: post: tags: - Access operationId: access_orders_by_id_submit parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Result' security: - tokenAuth: [] - auth: [] /access/orders/{id}/save: post: tags: - Access operationId: access_orders_by_id_save parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Order' security: - tokenAuth: [] - auth: [] /access/orders/{id}/resume: post: tags: - Access operationId: access_orders_by_id_resume parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Result' security: - tokenAuth: [] - auth: [] /access/orders/{id}/put-in-error: post: tags: - Access operationId: access_orders_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: [] /access/orders/search: get: tags: - Access operationId: access_orders_search_advancedSearch_get parameters: - name: search in: query required: true schema: type: string - name: match in: query required: false schema: type: string - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionOrder' security: - tokenAuth: [] - auth: [] post: tags: - Access operationId: access_orders_search_advancedSearch_post parameters: - name: match in: query required: false schema: type: string - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Order' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionOrder' security: - tokenAuth: [] - auth: [] /access/metadata/{parentid}/ratings: get: tags: - Access operationId: access_metadata_by_id_ratings_getArchiveUserRating parameters: - name: parentid 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/RestCollectionArchiveUserRating' security: - tokenAuth: [] - auth: [] post: tags: - Access operationId: access_metadata_by_id_ratings_create parameters: - name: parentid in: path required: true schema: type: string - name: ratingType in: query required: true schema: type: string - name: grade in: query required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ArchiveUserRating' security: - tokenAuth: [] - auth: [] delete: tags: - Access operationId: access_metadata_by_id_ratings_delete parameters: - name: parentid in: path required: true schema: type: string responses: '200': description: OK security: - tokenAuth: [] - auth: [] patch: tags: - Access operationId: access_metadata_by_id_ratings_update parameters: - name: parentid in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ArchiveUserRating' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ArchiveUserRating' security: - tokenAuth: [] - auth: [] /access/metadata/{aipId}/prepare-download: post: tags: - Access operationId: access_metadata_by_id_prepare-download parameters: - name: aipId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DisseminationPolicyDto' responses: '200': description: OK content: '*/*': schema: type: string security: - tokenAuth: [] - auth: [] /access/metadata/search: get: tags: - Access operationId: access_metadata_search_get parameters: - name: query in: query required: false schema: type: string - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionArchiveMetadata' security: - tokenAuth: [] - auth: [] post: tags: - Access operationId: access_metadata_search_post parameters: - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SearchCondition' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/MultiValueMapStringString' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionArchiveMetadata' security: - tokenAuth: [] - auth: [] /access/dip: get: tags: - Access operationId: access_dip_list parameters: - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: resId in: query description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). required: false schema: type: string - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionDisseminationInfoPackage' security: - tokenAuth: [] - auth: [] post: tags: - Access operationId: access_dip_create requestBody: content: application/json: schema: $ref: '#/components/schemas/DisseminationInfoPackage' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/DisseminationInfoPackage' security: - tokenAuth: [] - auth: [] delete: tags: - Access operationId: access_dip_deleteList requestBody: content: application/json: schema: type: array items: type: string required: true responses: '200': description: OK security: - tokenAuth: [] - auth: [] /access/dip/{parentid}/data: get: tags: - Access operationId: access_dip_by_id_data_list parameters: - name: complianceLevel in: query required: false schema: type: string enum: - NOT_ASSESSED - NO_COMPLIANCE - WEAK_COMPLIANCE - AVERAGE_COMPLIANCE - FULL_COMPLIANCE - name: dataCategory in: query required: false schema: type: string enum: - Primary - Observational - Experimental - Simulation - Derived - Reference - Digitalized - Secondary - Publication - DataPaper - Documentation - Software - Code - Binaries - VirtualMachine - Administrative - Document - WebSite - Other - Package - InformationPackage - UpdatePackage - Metadata - CustomMetadata - UpdatedMetadata - Internal - DatasetThumbnail - ArchiveThumbnail - ArchiveReadme - DatafileThumbnail - ArchiveDataUseAgreement - name: dataType in: query required: false schema: type: string enum: - Primary - Observational - Experimental - Simulation - Derived - Reference - Digitalized - Secondary - Publication - DataPaper - Documentation - Software - Code - Binaries - VirtualMachine - Administrative - Document - WebSite - Other - Package - InformationPackage - UpdatePackage - Metadata - CustomMetadata - UpdatedMetadata - Internal - DatasetThumbnail - ArchiveThumbnail - ArchiveReadme - DatafileThumbnail - ArchiveDataUseAgreement - name: fileName in: query required: false schema: type: string - name: fileSize in: query required: false schema: type: integer format: int64 - name: finalData in: query required: false schema: type: string format: uri - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: parentid in: path required: true schema: type: string - name: relativeLocation in: query required: false schema: type: string - name: resId in: query description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). required: false schema: type: string - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string - name: sourceData in: query required: false schema: type: string format: uri - name: status in: query required: false schema: type: string enum: - CHANGE_RELATIVE_LOCATION - CHANGE_DATA_CATEGORY - CLEANED - CLEANING - EXCLUDED_FILE - CHECK_COMPLIANCE - CHECK_COMPLIANCE_CLEANED - CHECKED_COMPLIANCE - CHECKED_COMPLIANCE_CLEANED - IGNORED_FILE - DOWNLOAD_IN_PROGRESS - FILE_FORMAT_IDENTIFIED - FILE_FORMAT_SKIPPED - FILE_FORMAT_UNKNOWN - IN_ERROR - PROCESSED - READY - RECEIVED - TO_PROCESS - VIRUS_CHECKED - VIRUS_SKIPPED - name: statusMessage in: query required: false schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionDipDataFile' security: - tokenAuth: [] - auth: [] post: tags: - Access operationId: access_dip_by_id_data_create parameters: - name: parentid in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DipDataFile' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/DipDataFile' security: - tokenAuth: [] - auth: [] delete: tags: - Access operationId: access_dip_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: [] /access/dip/{parentid}/data/{id}/resume: post: tags: - Access operationId: access_dip_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: [] /access/dip/{parentid}/aip: get: tags: - Access operationId: access_dip_by_id_aip_list parameters: - name: archivalUnit in: query description: if the AIP is an unit (AIU) or a collection (AIC). required: false schema: type: boolean - name: archiveContainer in: query description: The container type of the AIP. required: false schema: type: string enum: - UNDEFINED - ZIP - BAG_IT - name: archiveFileNumber in: query description: The total number of files in the AIP. required: false schema: type: integer format: int64 - name: archiveId in: query description: The storage URI of the AIP. required: false schema: type: string - name: archiveSize in: query description: The size in bytes of the AIP. required: false schema: type: integer format: int64 - name: collectionArchiveSize in: query description: The total size in bytes of the collection AIP. required: false schema: type: integer format: int64 - name: collectionFileNumber in: query description: The total number of filed in the collection AIP. required: false schema: type: integer format: int64 - name: dispositionApproval in: query description: If the approval step the AIP disposal is mandatory. required: false schema: type: boolean - name: lastArchiving in: query description: 'The last archiving process date of the AIP: the first archiving date or the last metadata edition.' required: false schema: type: string format: date-time - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: parentid in: path required: true schema: type: string - name: publicationDate in: query description: The publication date of the AIP. required: false schema: type: string format: date - name: resId in: query description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). required: false schema: type: string - name: retention in: query description: 'The retention duration in days of the AIP: O means forever.' required: false schema: type: integer format: int32 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string - name: tombstoneSize in: query description: The size in bytes of the tombstone AIP. required: false schema: type: integer format: int64 - name: updateNumber in: query description: The number of updates in the AIP. required: false schema: type: integer format: int64 responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionArchivalInfoPackage' security: - tokenAuth: [] - auth: [] post: tags: - Access operationId: access_dip_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: - Access operationId: access_dip_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: [] /access/dip/{id}/resume: post: tags: - Access operationId: access_dip_by_id_resume parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Result' security: - tokenAuth: [] - auth: [] /access/dip/{id}/put-in-error: post: tags: - Access operationId: access_dip_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: [] /access/dip/search: get: tags: - Access operationId: access_dip_search_advancedSearch_get parameters: - name: search in: query required: true schema: type: string - name: match in: query required: false schema: type: string - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionDisseminationInfoPackage' security: - tokenAuth: [] - auth: [] post: tags: - Access operationId: access_dip_search_advancedSearch_post parameters: - name: match in: query required: false schema: type: string - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DisseminationInfoPackage' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionDisseminationInfoPackage' security: - tokenAuth: [] - auth: [] /access/all-metadata/{aipId}/prepare-download: post: tags: - Access operationId: access_all-metadata_by_id_prepare-download parameters: - name: aipId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DisseminationPolicyDto' responses: '200': description: OK content: '*/*': schema: type: string security: - tokenAuth: [] - auth: [] /access/all-metadata/search: get: tags: - Access operationId: access_all-metadata_search_get parameters: - name: query in: query required: false schema: type: string - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionArchiveMetadata' security: - tokenAuth: [] - auth: [] post: tags: - Access operationId: access_all-metadata_search_post parameters: - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SearchCondition' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/MultiValueMapStringString' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionArchiveMetadata' security: - tokenAuth: [] - auth: [] /access/aip: get: tags: - Access operationId: access_aip_list parameters: - name: archivalUnit in: query description: if the AIP is an unit (AIU) or a collection (AIC). required: false schema: type: boolean - name: archiveContainer in: query description: The container type of the AIP. required: false schema: type: string enum: - UNDEFINED - ZIP - BAG_IT - name: archiveFileNumber in: query description: The total number of files in the AIP. required: false schema: type: integer format: int64 - name: archiveId in: query description: The storage URI of the AIP. required: false schema: type: string - name: archiveSize in: query description: The size in bytes of the AIP. required: false schema: type: integer format: int64 - name: collectionArchiveSize in: query description: The total size in bytes of the collection AIP. required: false schema: type: integer format: int64 - name: collectionFileNumber in: query description: The total number of filed in the collection AIP. required: false schema: type: integer format: int64 - name: dispositionApproval in: query description: If the approval step the AIP disposal is mandatory. required: false schema: type: boolean - name: lastArchiving in: query description: 'The last archiving process date of the AIP: the first archiving date or the last metadata edition.' required: false schema: type: string format: date-time - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: publicationDate in: query description: The publication date of the AIP. required: false schema: type: string format: date - name: resId in: query description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). required: false schema: type: string - name: retention in: query description: 'The retention duration in days of the AIP: O means forever.' required: false schema: type: integer format: int32 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string - name: tombstoneSize in: query description: The size in bytes of the tombstone AIP. required: false schema: type: integer format: int64 - name: updateNumber in: query description: The number of updates in the AIP. required: false schema: type: integer format: int64 responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionArchivalInfoPackage' security: - tokenAuth: [] - auth: [] post: tags: - Access operationId: access_aip_create requestBody: content: application/json: schema: $ref: '#/components/schemas/ArchivalInfoPackage' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ArchivalInfoPackage' security: - tokenAuth: [] - auth: [] delete: tags: - Access operationId: access_aip_deleteList requestBody: content: application/json: schema: type: array items: type: string required: true responses: '200': description: OK security: - tokenAuth: [] - auth: [] /access/aip/{parentid}/data: get: tags: - Access operationId: access_aip_by_id_data_list parameters: - name: complianceLevel in: query required: false schema: type: string enum: - NOT_ASSESSED - NO_COMPLIANCE - WEAK_COMPLIANCE - AVERAGE_COMPLIANCE - FULL_COMPLIANCE - name: dataCategory in: query required: false schema: type: string enum: - Primary - Observational - Experimental - Simulation - Derived - Reference - Digitalized - Secondary - Publication - DataPaper - Documentation - Software - Code - Binaries - VirtualMachine - Administrative - Document - WebSite - Other - Package - InformationPackage - UpdatePackage - Metadata - CustomMetadata - UpdatedMetadata - Internal - DatasetThumbnail - ArchiveThumbnail - ArchiveReadme - DatafileThumbnail - ArchiveDataUseAgreement - name: dataType in: query required: false schema: type: string enum: - Primary - Observational - Experimental - Simulation - Derived - Reference - Digitalized - Secondary - Publication - DataPaper - Documentation - Software - Code - Binaries - VirtualMachine - Administrative - Document - WebSite - Other - Package - InformationPackage - UpdatePackage - Metadata - CustomMetadata - UpdatedMetadata - Internal - DatasetThumbnail - ArchiveThumbnail - ArchiveReadme - DatafileThumbnail - ArchiveDataUseAgreement - name: fileName in: query required: false schema: type: string - name: fileSize in: query required: false schema: type: integer format: int64 - name: finalData in: query required: false schema: type: string format: uri - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: parentid in: path required: true schema: type: string - name: relativeLocation in: query required: false schema: type: string - name: resId in: query description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). required: false schema: type: string - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string - name: sourceData in: query required: false schema: type: string format: uri - name: status in: query required: false schema: type: string enum: - CHANGE_RELATIVE_LOCATION - CHANGE_DATA_CATEGORY - CLEANED - CLEANING - EXCLUDED_FILE - CHECK_COMPLIANCE - CHECK_COMPLIANCE_CLEANED - CHECKED_COMPLIANCE - CHECKED_COMPLIANCE_CLEANED - IGNORED_FILE - DOWNLOAD_IN_PROGRESS - FILE_FORMAT_IDENTIFIED - FILE_FORMAT_SKIPPED - FILE_FORMAT_UNKNOWN - IN_ERROR - PROCESSED - READY - RECEIVED - TO_PROCESS - VIRUS_CHECKED - VIRUS_SKIPPED - name: statusMessage in: query required: false schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionAipDataFile' security: - tokenAuth: [] - auth: [] post: tags: - Access operationId: access_aip_by_id_data_create parameters: - name: parentid in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AipDataFile' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/AipDataFile' security: - tokenAuth: [] - auth: [] delete: tags: - Access operationId: access_aip_by_id_data_deleteList parameters: - name: parentid in: path required: true schema: type: string requestBody: content: application/json: schema: type: array items: type: string required: true responses: '200': description: OK security: - tokenAuth: [] - auth: [] /access/aip/{parentid}/data/{id}/resume: post: tags: - Access operationId: access_aip_by_id_data_by_id_resume parameters: - name: parentid in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Result' security: - tokenAuth: [] - auth: [] /access/aip/{parentid}/data/{id}/put-in-error: post: tags: - Access operationId: access_aip_by_id_data_by_id_put-in-error parameters: - name: parentid in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Result' security: - tokenAuth: [] - auth: [] /access/aip/{parentid}/aip: get: tags: - Access operationId: access_aip_by_id_aip_list parameters: - name: archivalUnit in: query description: if the AIP is an unit (AIU) or a collection (AIC). required: false schema: type: boolean - name: archiveContainer in: query description: The container type of the AIP. required: false schema: type: string enum: - UNDEFINED - ZIP - BAG_IT - name: archiveFileNumber in: query description: The total number of files in the AIP. required: false schema: type: integer format: int64 - name: archiveId in: query description: The storage URI of the AIP. required: false schema: type: string - name: archiveSize in: query description: The size in bytes of the AIP. required: false schema: type: integer format: int64 - name: collectionArchiveSize in: query description: The total size in bytes of the collection AIP. required: false schema: type: integer format: int64 - name: collectionFileNumber in: query description: The total number of filed in the collection AIP. required: false schema: type: integer format: int64 - name: dispositionApproval in: query description: If the approval step the AIP disposal is mandatory. required: false schema: type: boolean - name: lastArchiving in: query description: 'The last archiving process date of the AIP: the first archiving date or the last metadata edition.' required: false schema: type: string format: date-time - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: parentid in: path required: true schema: type: string - name: publicationDate in: query description: The publication date of the AIP. required: false schema: type: string format: date - name: resId in: query description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). required: false schema: type: string - name: retention in: query description: 'The retention duration in days of the AIP: O means forever.' required: false schema: type: integer format: int32 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string - name: tombstoneSize in: query description: The size in bytes of the tombstone AIP. required: false schema: type: integer format: int64 - name: updateNumber in: query description: The number of updates in the AIP. required: false schema: type: integer format: int64 responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionArchivalInfoPackage' security: - tokenAuth: [] - auth: [] post: tags: - Access operationId: access_aip_by_id_aip_create parameters: - name: parentid in: path required: true schema: type: string requestBody: content: application/json: schema: type: array items: type: string required: true responses: '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/ArchivalInfoPackage' security: - tokenAuth: [] - auth: [] delete: tags: - Access operationId: access_aip_by_id_aip_deleteList parameters: - name: parentid in: path required: true schema: type: string requestBody: content: application/json: schema: type: array items: type: string required: true responses: '200': description: OK security: - tokenAuth: [] - auth: [] /access/aip/{id}/resume: post: tags: - Access operationId: access_aip_by_id_resume parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Result' security: - tokenAuth: [] - auth: [] /access/aip/{id}/put-in-error: post: tags: - Access operationId: access_aip_by_id_put-in-error parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Result' security: - tokenAuth: [] - auth: [] /access/aip/search: get: tags: - Access operationId: access_aip_search_advancedSearch_get parameters: - name: search in: query required: true schema: type: string - name: match in: query required: false schema: type: string - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionArchivalInfoPackage' security: - tokenAuth: [] - auth: [] post: tags: - Access operationId: access_aip_search_advancedSearch_post parameters: - name: match in: query required: false schema: type: string - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ArchivalInfoPackage' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionArchivalInfoPackage' security: - tokenAuth: [] - auth: [] /oai-info/oai-sets/{id}: get: tags: - OAI-PMH operationId: oai-info_oai-sets_by_id_get parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/OAISet' security: - tokenAuth: [] - auth: [] delete: tags: - OAI-PMH operationId: oai-info_oai-sets_by_id_delete parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK security: - tokenAuth: [] - auth: [] patch: tags: - OAI-PMH operationId: oai-info_oai-sets_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/OAISet' security: - tokenAuth: [] - auth: [] /oai-info/oai-metadata-prefixes/{id}: get: tags: - OAI-PMH operationId: oai-info_oai-metadata-prefixes_by_id_get parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/OAIMetadataPrefix' security: - tokenAuth: [] - auth: [] delete: tags: - OAI-PMH operationId: oai-info_oai-metadata-prefixes_by_id_delete parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK security: - tokenAuth: [] - auth: [] patch: tags: - OAI-PMH operationId: oai-info_oai-metadata-prefixes_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/OAIMetadataPrefix' security: - tokenAuth: [] - auth: [] /access/orders/{parentid}/dip/{id}: get: tags: - Access operationId: access_orders_by_id_dip_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/DisseminationInfoPackage' security: - tokenAuth: [] - auth: [] delete: tags: - Access operationId: access_orders_by_id_dip_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: - Access operationId: access_orders_by_id_dip_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/DisseminationInfoPackage' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/DisseminationInfoPackage' security: - tokenAuth: [] - auth: [] /access/orders/{parentid}/aip/{id}: get: tags: - Access operationId: access_orders_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: - Access operationId: access_orders_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: - Access operationId: access_orders_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: [] /access/orders/{id}: get: tags: - Access operationId: access_orders_by_id_get parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Order' security: - tokenAuth: [] - auth: [] delete: tags: - Access operationId: access_orders_by_id_delete parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK security: - tokenAuth: [] - auth: [] patch: tags: - Access operationId: access_orders_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/Order' security: - tokenAuth: [] - auth: [] /access/dip/{parentid}/data/{id}: get: tags: - Access operationId: access_dip_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/DipDataFile' security: - tokenAuth: [] - auth: [] delete: tags: - Access operationId: access_dip_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: - Access operationId: access_dip_by_id_data_by_id_update parameters: - name: parentid in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: {} required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/DipDataFile' security: - tokenAuth: [] - auth: [] /access/dip/{parentid}/aip/{id}: get: tags: - Access operationId: access_dip_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: - Access operationId: access_dip_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: - Access operationId: access_dip_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: [] /access/dip/{id}: get: tags: - Access operationId: access_dip_by_id_get parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/DisseminationInfoPackage' security: - tokenAuth: [] - auth: [] delete: tags: - Access operationId: access_dip_by_id_delete parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK security: - tokenAuth: [] - auth: [] patch: tags: - Access operationId: access_dip_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/DisseminationInfoPackage' security: - tokenAuth: [] - auth: [] /access/aip/{parentid}/data/{id}: get: tags: - Access operationId: access_aip_by_id_data_by_id_get parameters: - name: parentid in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/AipDataFile' security: - tokenAuth: [] - auth: [] delete: tags: - Access operationId: access_aip_by_id_data_by_id_delete parameters: - name: parentid in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: OK security: - tokenAuth: [] - auth: [] patch: tags: - Access operationId: access_aip_by_id_data_by_id_update parameters: - name: parentid in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: {} required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/AipDataFile' security: - tokenAuth: [] - auth: [] /access/aip/{parentid}/aip/{id}: get: tags: - Access operationId: access_aip_by_id_aip_by_id_get parameters: - name: parentid in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ArchivalInfoPackage' security: - tokenAuth: [] - auth: [] delete: tags: - Access operationId: access_aip_by_id_aip_by_id_delete parameters: - name: parentid in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: OK security: - tokenAuth: [] - auth: [] patch: tags: - Access operationId: access_aip_by_id_aip_by_id_update parameters: - name: parentid in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ArchivalInfoPackage' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ArchivalInfoPackage' security: - tokenAuth: [] - auth: [] /access/aip/{id}: get: tags: - Access operationId: access_aip_by_id_get parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ArchivalInfoPackage' security: - tokenAuth: [] - auth: [] delete: tags: - Access operationId: access_aip_by_id_delete parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK security: - tokenAuth: [] - auth: [] patch: tags: - Access operationId: access_aip_by_id_update parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: true required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ArchivalInfoPackage' security: - tokenAuth: [] - auth: [] /sso-user: get: tags: - Access operationId: sso-user_user responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/User' /sitemap.xml: get: tags: - Access operationId: sitemap.xml_getSitemapIndex parameters: - name: extra in: query required: true schema: type: string responses: '200': description: OK content: application/xml: schema: oneOf: - $ref: '#/components/schemas/Urlset' - $ref: '#/components/schemas/Sitemapindex' /sitemap-{name}.xml: get: tags: - Access operationId: sitemap-by_id.xml_getSitemap parameters: - name: name in: path required: true schema: type: string - name: from in: query required: true schema: type: string responses: '200': description: OK content: application/xml: schema: $ref: '#/components/schemas/Urlset' /resource-srv: get: tags: - Access operationId: resource-srv_home responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Module' /resource-srv/checkTool: get: tags: - Access operationId: resource-srv_checkTool parameters: - name: toolName in: query required: true schema: type: string responses: '200': description: OK content: application/json: schema: type: string /oai-info: get: tags: - OAI-PMH operationId: oai-info_home responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Module' /oai-info/oai-provider: get: tags: - OAI-PMH operationId: oai-info_oai-provider_status responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/OAIPMH' /oai-info/oai-provider/oai/xsl: get: tags: - OAI-PMH operationId: oai-info_oai-provider_oai_xsl parameters: - name: smartView in: query required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: string /oai-info/oai-provider/oai/schema: get: tags: - OAI-PMH operationId: oai-info_oai-provider_oai_schema_xsd responses: '200': description: OK content: '*/*': schema: type: string /default-configuration: get: tags: - Access operationId: default-configuration_getDefaultConfiguration responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/DLCMDefaultConfig' /current-configuration: get: tags: - Access operationId: current-configuration_getCurrentConfiguration responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/DLCMConfig' security: - tokenAuth: [] - auth: [] /access: get: tags: - Access operationId: access_home responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Module' /access/system-properties: get: tags: - Access operationId: access_system-properties responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/SystemProperties' /access/private-metadata: get: tags: - Access operationId: access_private-metadata_list parameters: - name: index in: query description: Name of the index required: false schema: type: string - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: resId in: query required: false schema: type: string - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionArchiveMetadata' security: - tokenAuth: [] - auth: [] /access/private-metadata/{orderId}/download-status: get: tags: - Access operationId: access_private-metadata_by_id_download-status_getDownloadStatus parameters: - name: orderId in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: string enum: - DOWNLOADING - IN_DISSEMINATION_PREPARATION - IN_ERROR - IN_PREPARATION - IN_PROGRESS - READY - SUBMITTED security: - tokenAuth: [] - auth: [] /access/private-metadata/{id}: get: tags: - Access operationId: access_private-metadata_by_id_get parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ArchiveMetadata' security: - tokenAuth: [] - auth: [] /access/private-metadata/{id}/citations: get: tags: - Access operationId: access_private-metadata_by_id_citations parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/CitationDto' security: - tokenAuth: [] - auth: [] /access/private-metadata/{id}/bibliographies: get: tags: - Access operationId: access_private-metadata_by_id_bibliographies parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/CitationDto' security: - tokenAuth: [] - auth: [] /access/private-metadata/{dipName}/download: get: tags: - Access operationId: access_private-metadata_by_id_download parameters: - name: dipName in: path required: true schema: type: string - name: orderId in: query required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: string format: binary security: - tokenAuth: [] - auth: [] /access/private-metadata/list-download-status: get: tags: - Access operationId: access_private-metadata_list-download-status responses: '200': description: OK content: '*/*': schema: type: array items: type: string enum: - DOWNLOADING - IN_DISSEMINATION_PREPARATION - IN_ERROR - IN_PREPARATION - IN_PROGRESS - READY - SUBMITTED security: - tokenAuth: [] - auth: [] /access/organizational-units: get: tags: - Access operationId: access_organizational-units_list parameters: - name: closingDate in: query description: The closing date of the organizational unit. required: false schema: type: string format: date - name: description in: query description: The description of the organizational unit. required: false schema: type: string - name: name in: query description: The name of the organizational unit. required: false schema: type: string - name: openingDate in: query description: The opening date of the organizational unit. required: false schema: type: string format: date - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: resId in: query required: false schema: type: string - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionOrgUnit' security: - tokenAuth: [] - auth: [] /access/organizational-units/{parentid}/archives: get: tags: - Access operationId: access_organizational-units_by_id_archives_list parameters: - name: index in: query description: Name of the index required: false schema: type: string - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: parentid in: path required: true schema: type: string - name: resId in: query required: false schema: type: string - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionArchiveMetadata' security: - tokenAuth: [] - auth: [] /access/organizational-units/{parentid}/archives/{id}: get: tags: - Access operationId: access_organizational-units_by_id_archives_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/ArchiveMetadata' security: - tokenAuth: [] - auth: [] /access/organizational-units/{id}: get: tags: - Access operationId: access_organizational-units_by_id_get parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/OrgUnit' security: - tokenAuth: [] - auth: [] /access/organizational-units/{id}/download-logo: get: tags: - Access summary: Download Logo of an organizational unit description: Returns a binary stream (image or file) for the given organizational unit ID. operationId: access_organizational-units_by_id_download-logo parameters: - name: id in: path required: true schema: type: string responses: '200': description: Binary file stream content: application/octet-stream: schema: type: string format: binary '404': description: Logo of an organizational unit not found content: '*/*': schema: $ref: '#/components/schemas/StreamingResponseBody' security: - tokenAuth: [] - auth: [] /access/orders/{id}/view: get: tags: - Access operationId: access_orders_by_id_view parameters: - name: id in: path required: true schema: type: string - name: allInfo in: query required: false schema: type: boolean default: false - name: pageable in: query required: true schema: $ref: '#/components/schemas/Pageable' responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionOrderArchive' security: - tokenAuth: [] - auth: [] /access/orders/{id}/history: get: tags: - Access operationId: access_orders_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: [] /access/orders/{id}/download: get: tags: - Access operationId: access_orders_by_id_download_getFiles parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: string format: binary security: - tokenAuth: [] - auth: [] /access/orders/{id}/download-token: get: tags: - Access operationId: access_orders_by_id_download-token_getTokenForOrder parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/DownloadToken' security: - tokenAuth: [] - auth: [] /access/orders/list-status: get: tags: - Access operationId: access_orders_list-status responses: '200': description: OK content: '*/*': schema: type: array items: type: string enum: - DOWNLOADING - IN_DISSEMINATION_PREPARATION - IN_ERROR - IN_PREPARATION - IN_PROGRESS - READY - SUBMITTED security: - tokenAuth: [] - auth: [] /access/orders/list-query-types: get: tags: - Access operationId: access_orders_list-query-types responses: '200': description: OK content: '*/*': schema: type: array items: type: string enum: - ADVANCED - DIRECT - SIMPLE security: - tokenAuth: [] - auth: [] /access/orders/list-public: get: tags: - Access operationId: access_orders_list-public parameters: - name: disseminationPolicyId in: query description: The dissemination policy identifier linked to the order. required: false schema: type: string - name: metadataVersion in: query description: The metadata version of the order query. required: false schema: type: string enum: - '1.0' - '1.1' - '2.0' - '2.1' - '3.0' - '3.1' - '4.0' - '5.0' - name: name in: query description: The name of the order query. required: false schema: type: string - name: order in: query required: true schema: $ref: '#/components/schemas/Order' - name: organizationalUnitDisseminationPolicyId in: query description: The dissemination policy identifier linked to the orgunit. required: false schema: type: string - name: pageable in: query required: true schema: $ref: '#/components/schemas/Pageable' - name: publicOrder in: query description: If the order is public, false otherwise. required: false schema: type: boolean - name: query in: query description: The query of the order query. required: false schema: type: string - name: queryType in: query description: The type of the order query. required: false schema: type: string enum: - ADVANCED - DIRECT - SIMPLE - 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: status in: query description: The status of the order query. required: false schema: type: string enum: - DOWNLOADING - IN_DISSEMINATION_PREPARATION - IN_ERROR - IN_PREPARATION - IN_PROGRESS - READY - SUBMITTED - name: statusMessage in: query description: The message related to the status of the order query. required: false schema: type: string - name: subitemsChecksum in: query description: The checksum of the order subitems list. required: false schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionOrder' security: - tokenAuth: [] - auth: [] /access/orders/list-created-by-user: get: tags: - Access operationId: access_orders_list-created-by-user parameters: - name: disseminationPolicyId in: query description: The dissemination policy identifier linked to the order. required: false schema: type: string - name: metadataVersion in: query description: The metadata version of the order query. required: false schema: type: string enum: - '1.0' - '1.1' - '2.0' - '2.1' - '3.0' - '3.1' - '4.0' - '5.0' - name: name in: query description: The name of the order query. required: false schema: type: string - name: order in: query required: true schema: $ref: '#/components/schemas/Order' - name: organizationalUnitDisseminationPolicyId in: query description: The dissemination policy identifier linked to the orgunit. required: false schema: type: string - name: pageable in: query required: true schema: $ref: '#/components/schemas/Pageable' - name: publicOrder in: query description: If the order is public, false otherwise. required: false schema: type: boolean - name: query in: query description: The query of the order query. required: false schema: type: string - name: queryType in: query description: The type of the order query. required: false schema: type: string enum: - ADVANCED - DIRECT - SIMPLE - 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: status in: query description: The status of the order query. required: false schema: type: string enum: - DOWNLOADING - IN_DISSEMINATION_PREPARATION - IN_ERROR - IN_PREPARATION - IN_PROGRESS - READY - SUBMITTED - name: statusMessage in: query description: The message related to the status of the order query. required: false schema: type: string - name: subitemsChecksum in: query description: The checksum of the order subitems list. required: false schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionOrder' security: - tokenAuth: [] - auth: [] /access/metadata: get: tags: - Access operationId: access_metadata_list parameters: - name: index in: query description: Name of the index required: false schema: type: string - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: resId in: query required: false schema: type: string - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionArchiveMetadata' security: - tokenAuth: [] - auth: [] /access/metadata/{parentid}/ratings/list-for-user: get: tags: - Access operationId: access_metadata_by_id_ratings_list-for-user_getUserRating parameters: - name: parentid in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionArchiveUserRating' security: - tokenAuth: [] - auth: [] /access/metadata/{parentid}/data/{id}: get: tags: - Access operationId: access_metadata_by_id_data_by_id_getDataFile 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/ArchiveMetadata' security: - tokenAuth: [] - auth: [] /access/metadata/{parentid}/data/{id}/ready-for-download: get: tags: - Access operationId: access_metadata_by_id_data_by_id_ready-for-download_checkDataFileIfIsReadyDownload 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: [] /access/metadata/{parentid}/data/{id}/download: get: tags: - Access summary: Download data file description: Returns a binary stream (file). operationId: access_metadata_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: Binary file stream content: application/octet-stream: schema: type: string format: binary '404': description: Archive not found content: '*/*': schema: $ref: '#/components/schemas/StreamingResponseBody' security: - tokenAuth: [] - auth: [] /access/metadata/{parentid}/data/{id}/download-token: get: tags: - Access operationId: access_metadata_by_id_data_by_id_download-token_getTokenForDataFile 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: [] /access/metadata/{orderId}/download-status: get: tags: - Access operationId: access_metadata_by_id_download-status_getDownloadStatus parameters: - name: orderId in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: string enum: - DOWNLOADING - IN_DISSEMINATION_PREPARATION - IN_ERROR - IN_PREPARATION - IN_PROGRESS - READY - SUBMITTED security: - tokenAuth: [] - auth: [] /access/metadata/{id}: get: tags: - Access operationId: access_metadata_by_id_get parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ArchiveMetadata' security: - tokenAuth: [] - auth: [] /access/metadata/{id}/thumbnail: get: tags: - Access summary: Download thumbnail of an archive description: Returns a binary stream (image or file) for the given archive ID. operationId: access_metadata_by_id_thumbnail_downloadThumbnail parameters: - name: id in: path required: true schema: type: string responses: '200': description: Binary file stream content: application/octet-stream: schema: type: string format: binary '404': description: Thumbnail of an archive not found content: '*/*': schema: $ref: '#/components/schemas/StreamingResponseBody' security: - tokenAuth: [] - auth: [] /access/metadata/{id}/statistics: get: tags: - Access operationId: access_metadata_by_id_statistics_getStatistics parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ArchiveStatisticsDto' security: - tokenAuth: [] - auth: [] /access/metadata/{id}/readme: get: tags: - Access summary: Download readme of an archive description: Returns a binary stream (file) for the given archive ID. operationId: access_metadata_by_id_readme_downloadReadme parameters: - name: id in: path required: true schema: type: string responses: '200': description: Binary file stream content: application/octet-stream: schema: type: string format: binary '404': description: Readme of an archive not found content: '*/*': schema: $ref: '#/components/schemas/StreamingResponseBody' security: - tokenAuth: [] - auth: [] /access/metadata/{id}/packages: get: tags: - Access operationId: access_metadata_by_id_packages_getPackages parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ArchiveMetadata' security: - tokenAuth: [] - auth: [] /access/metadata/{id}/list-folders: get: tags: - Access operationId: access_metadata_by_id_list-folders parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: array items: type: string security: - tokenAuth: [] - auth: [] /access/metadata/{id}/dua: get: tags: - Access summary: Download DUA of an archive description: Returns a binary stream (image or file) for the given archive ID. operationId: access_metadata_by_id_dua_downloadDua parameters: - name: id in: path required: true schema: type: string responses: '200': description: Binary file stream content: application/octet-stream: schema: type: string format: binary '404': description: DUA of an archive not found content: '*/*': schema: $ref: '#/components/schemas/StreamingResponseBody' security: - tokenAuth: [] - auth: [] /access/metadata/{id}/data: get: tags: - Access operationId: access_metadata_by_id_data_getDataFiles parameters: - name: id in: path required: true schema: type: string - name: path in: query required: false schema: type: string - name: file in: query required: false schema: type: string default: '*' - name: minSize in: query required: false schema: type: string default: '0' - name: maxSize in: query required: false schema: type: string - name: pageable in: query required: true schema: $ref: '#/components/schemas/Pageable' responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionArchiveMetadata' security: - tokenAuth: [] - auth: [] /access/metadata/{id}/citations: get: tags: - Access operationId: access_metadata_by_id_citations parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/CitationDto' security: - tokenAuth: [] - auth: [] /access/metadata/{id}/bibliographies: get: tags: - Access operationId: access_metadata_by_id_bibliographies parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/CitationDto' security: - tokenAuth: [] - auth: [] /access/metadata/{id}/aip: get: tags: - Access operationId: access_metadata_by_id_aip_getAip parameters: - name: id in: path required: true schema: type: string - name: minSize in: query required: false schema: type: string default: '0' - name: maxSize in: query required: false schema: type: string - name: pageable in: query required: true schema: $ref: '#/components/schemas/Pageable' responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionArchiveMetadata' security: - tokenAuth: [] - auth: [] /access/metadata/{dipName}/download: get: tags: - Access operationId: access_metadata_by_id_download parameters: - name: dipName in: path required: true schema: type: string - name: orderId in: query required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: string format: binary security: - tokenAuth: [] - auth: [] /access/metadata/{dipName}/download-token: get: tags: - Access operationId: access_metadata_by_id_download-token_getTokenForArchive parameters: - name: dipName in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/DownloadToken' security: - tokenAuth: [] - auth: [] /access/metadata/search-doi: get: tags: - Access operationId: access_metadata_search-doi parameters: - name: doi in: query required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ArchiveMetadata' security: - tokenAuth: [] - auth: [] /access/metadata/list-download-status: get: tags: - Access operationId: access_metadata_list-download-status responses: '200': description: OK content: '*/*': schema: type: array items: type: string enum: - DOWNLOADING - IN_DISSEMINATION_PREPARATION - IN_ERROR - IN_PREPARATION - IN_PROGRESS - READY - SUBMITTED security: - tokenAuth: [] - auth: [] /access/dip/{parentid}/data/{id}/history: get: tags: - Access operationId: access_dip_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: [] /access/dip/{parentid}/data/{id}/download: get: tags: - Access operationId: access_dip_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: [] /access/dip/{parentid}/data/{id}/download-token: get: tags: - Access operationId: access_dip_by_id_data_by_id_download-token_getTokenForDipDataFile 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: [] /access/dip/{parentid}/data/list-status: get: tags: - Access operationId: access_dip_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: [] /access/dip/{parentid}/aip/status: get: tags: - Access operationId: access_dip_by_id_aip_status_listStatus parameters: - name: parentid in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: array items: type: string description: 'OAIS Package Status: - CHECKED => Checked package during archiving process - CHECKING => A package verification is in progress during checking process - CHECK_PENDING => A package verification is pending during checking process - CLEANED => Cleaned package during cleaning process for SIP only - CLEANING => A package clean is in progress during cleaning process for SIP only - COMPLIANCE_LEVEL_UPDATE_PENDING => A package compliance update is pending - COMPLIANCE_LEVEL_UPDATED => The compliance levels of the package have been updated - COMPLETED => Completed package - DISPOSABLE => The Package is candidate for disposal process for AIP only - DISPOSAL_APPROVED_BY_ORGUNIT => Disposal org. unit approval done during disposal process for AIP only - DISPOSAL_APPROVED => Disposal approval done during disposal process for AIP only - DISPOSED => Disposed package for AIP only - DOWNLOADING => A package download is in progress - EDITING_METADATA => A package metadata edition is in progress - FIXING => A package correction is in progress - FIXITY_ERROR => Error when checking checksums - FIX_PENDING => A package correction is pending - INDEXING => A package indexing is in progress - IN_ERROR => Package in error during archiving process - IN_PREPARATION => Package in preparation during archiving process - IN_PROGRESS => A package archiving process is in progress - METADATA_EDITION_PENDING => A metadata edition is pending - METADATA_UPGRADE_PENDING => A metadata version upgrade is pending - PACKAGE_REPLICATION_PENDING => A package replication is pending - PRESERVATION_ERROR => Package in error during checking process - READY => Package Ready - REINDEXING => A package re-indexing is in progress - RELOADED => Reloaded package from storage location - REPLICATING_PACKAGE => A package replication is in progress - REPLICATING_TOMBSTONE => A tombstone package replication is in progress - RESUBMITTING => A package re-submission is in progress - STORED => Package stored on storage location - TOMBSTONE_REPLICATION_PENDING => A tombstone replication is pending - UPDATING_COMPLIANCE_LEVEL => A package compliance update is in progress - UPDATING_RETENTION => A package retention update is in progress during disposal process - UPGRADING_METADATA => A metadata version upgrade is in progress ' enum: - CHECK_PENDING - CHECKING - CHECKED - CLEANING - CLEANED - COMPLETED - DOWNLOADING - IN_PREPARATION - IN_PROGRESS - STORED - INDEXING - READY - RETRIEVING - RETRIEVING_PENDING - IN_ERROR - PRESERVATION_ERROR - FIXITY_ERROR - DISPOSABLE - DISPOSAL_APPROVED_BY_ORGUNIT - DISPOSAL_APPROVED - DISPOSED - FIX_PENDING - FIXING - METADATA_EDITION_PENDING - EDITING_METADATA - UPDATING_RETENTION - METADATA_UPGRADE_PENDING - UPGRADING_METADATA - COMPLIANCE_LEVEL_UPDATE_PENDING - UPDATING_COMPLIANCE_LEVEL - COMPLIANCE_LEVEL_UPDATED - REINDEXING - RELOADED - RESUBMITTING - PACKAGE_REPLICATION_PENDING - REPLICATING_PACKAGE - TOMBSTONE_REPLICATION_PENDING - REPLICATING_TOMBSTONE security: - tokenAuth: [] - auth: [] /access/dip/{id}/history: get: tags: - Access operationId: access_dip_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: [] /access/dip/{id}/download: get: tags: - Access operationId: access_dip_by_id_download_getFiles parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: string format: binary security: - tokenAuth: [] - auth: [] /access/dip/{id}/download-token: get: tags: - Access operationId: access_dip_by_id_download-token_getTokenDip parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/DownloadToken' security: - tokenAuth: [] - auth: [] /access/dip/total-for-completed-order: get: tags: - Access operationId: access_dip_total-for-completed-order_getCountForCompletedOrders responses: '200': description: OK content: '*/*': schema: type: integer format: int32 security: - tokenAuth: [] - auth: [] /access/dip/schema: get: tags: - Access summary: Download schema of a DIP description: Returns a binary stream (file) for the given DIP ID. operationId: access_dip_schema parameters: - name: version in: query required: false schema: type: string - name: disseminationPolicy in: query required: false schema: type: string default: PUBLIC description: 'Type of dissemination: IIIF or WEB.' enum: - IIIF - HEDERA - BASIC - OAIS responses: '200': description: Binary file stream content: application/octet-stream: schema: type: string format: binary '404': description: Schema DIP not found content: '*/*': schema: $ref: '#/components/schemas/StreamingResponseBody' security: - tokenAuth: [] - auth: [] /access/dip/profile: get: tags: - Access summary: Download profile of a package description: Returns a binary stream (file). operationId: access_dip_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: [] /access/dip/list-status: get: tags: - Access operationId: access_dip_list-status responses: '200': description: OK content: '*/*': schema: type: array items: type: string description: 'OAIS Package Status: - CHECKED => Checked package during archiving process - CHECKING => A package verification is in progress during checking process - CHECK_PENDING => A package verification is pending during checking process - CLEANED => Cleaned package during cleaning process for SIP only - CLEANING => A package clean is in progress during cleaning process for SIP only - COMPLIANCE_LEVEL_UPDATE_PENDING => A package compliance update is pending - COMPLIANCE_LEVEL_UPDATED => The compliance levels of the package have been updated - COMPLETED => Completed package - DISPOSABLE => The Package is candidate for disposal process for AIP only - DISPOSAL_APPROVED_BY_ORGUNIT => Disposal org. unit approval done during disposal process for AIP only - DISPOSAL_APPROVED => Disposal approval done during disposal process for AIP only - DISPOSED => Disposed package for AIP only - DOWNLOADING => A package download is in progress - EDITING_METADATA => A package metadata edition is in progress - FIXING => A package correction is in progress - FIXITY_ERROR => Error when checking checksums - FIX_PENDING => A package correction is pending - INDEXING => A package indexing is in progress - IN_ERROR => Package in error during archiving process - IN_PREPARATION => Package in preparation during archiving process - IN_PROGRESS => A package archiving process is in progress - METADATA_EDITION_PENDING => A metadata edition is pending - METADATA_UPGRADE_PENDING => A metadata version upgrade is pending - PACKAGE_REPLICATION_PENDING => A package replication is pending - PRESERVATION_ERROR => Package in error during checking process - READY => Package Ready - REINDEXING => A package re-indexing is in progress - RELOADED => Reloaded package from storage location - REPLICATING_PACKAGE => A package replication is in progress - REPLICATING_TOMBSTONE => A tombstone package replication is in progress - RESUBMITTING => A package re-submission is in progress - STORED => Package stored on storage location - TOMBSTONE_REPLICATION_PENDING => A tombstone replication is pending - UPDATING_COMPLIANCE_LEVEL => A package compliance update is in progress - UPDATING_RETENTION => A package retention update is in progress during disposal process - UPGRADING_METADATA => A metadata version upgrade is in progress ' enum: - CHECK_PENDING - CHECKING - CHECKED - CLEANING - CLEANED - COMPLETED - DOWNLOADING - IN_PREPARATION - IN_PROGRESS - STORED - INDEXING - READY - RETRIEVING - RETRIEVING_PENDING - IN_ERROR - PRESERVATION_ERROR - FIXITY_ERROR - DISPOSABLE - DISPOSAL_APPROVED_BY_ORGUNIT - DISPOSAL_APPROVED - DISPOSED - FIX_PENDING - FIXING - METADATA_EDITION_PENDING - EDITING_METADATA - UPDATING_RETENTION - METADATA_UPGRADE_PENDING - UPGRADING_METADATA - COMPLIANCE_LEVEL_UPDATE_PENDING - UPDATING_COMPLIANCE_LEVEL - COMPLIANCE_LEVEL_UPDATED - REINDEXING - RELOADED - RESUBMITTING - PACKAGE_REPLICATION_PENDING - REPLICATING_PACKAGE - TOMBSTONE_REPLICATION_PENDING - REPLICATING_TOMBSTONE security: - tokenAuth: [] - auth: [] /access/dip/list-metadata-versions: get: tags: - Access operationId: access_dip_list-metadata-versions responses: '200': description: OK content: '*/*': schema: type: array items: type: string security: - tokenAuth: [] - auth: [] /access/dip/list-data-types: get: tags: - Access operationId: access_dip_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: [] /access/dip/list-data-categories: get: tags: - Access operationId: access_dip_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: [] /access/dip/get-by-aip-id/{id}: get: tags: - Access operationId: access_dip_get-by-aip-id_by_id_getDipContainingAip 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/RestCollectionDisseminationInfoPackage' security: - tokenAuth: [] - auth: [] /access/archives/metadata/**: get: tags: - Access operationId: access_archives_metadata_get responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ArchiveMetadata' /access/all-metadata: get: tags: - Access operationId: access_all-metadata_list parameters: - name: index in: query description: Name of the index required: false schema: type: string - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: resId in: query required: false schema: type: string - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionArchiveMetadata' security: - tokenAuth: [] - auth: [] /access/all-metadata/{orderId}/download-status: get: tags: - Access operationId: access_all-metadata_by_id_download-status_getDownloadStatus parameters: - name: orderId in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: string enum: - DOWNLOADING - IN_DISSEMINATION_PREPARATION - IN_ERROR - IN_PREPARATION - IN_PROGRESS - READY - SUBMITTED security: - tokenAuth: [] - auth: [] /access/all-metadata/{id}: get: tags: - Access operationId: access_all-metadata_by_id_get parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ArchiveMetadata' security: - tokenAuth: [] - auth: [] /access/all-metadata/{id}/citations: get: tags: - Access operationId: access_all-metadata_by_id_citations parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/CitationDto' security: - tokenAuth: [] - auth: [] /access/all-metadata/{id}/bibliographies: get: tags: - Access operationId: access_all-metadata_by_id_bibliographies parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/CitationDto' security: - tokenAuth: [] - auth: [] /access/all-metadata/{dipName}/download: get: tags: - Access operationId: access_all-metadata_by_id_download parameters: - name: dipName in: path required: true schema: type: string - name: orderId in: query required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: string format: binary security: - tokenAuth: [] - auth: [] /access/all-metadata/list-download-status: get: tags: - Access operationId: access_all-metadata_list-download-status responses: '200': description: OK content: '*/*': schema: type: array items: type: string enum: - DOWNLOADING - IN_DISSEMINATION_PREPARATION - IN_ERROR - IN_PREPARATION - IN_PROGRESS - READY - SUBMITTED security: - tokenAuth: [] - auth: [] /access/aip/{parentid}/data/{id}/history: get: tags: - Access operationId: access_aip_by_id_data_by_id_history parameters: - name: parentid in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: pageable in: query required: true schema: $ref: '#/components/schemas/Pageable' responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionStatusHistory' security: - tokenAuth: [] - auth: [] /access/aip/{parentid}/data/{id}/download: get: tags: - Access operationId: access_aip_by_id_data_by_id_download parameters: - name: parentid in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: string format: binary security: - tokenAuth: [] - auth: [] /access/aip/{parentid}/data/{id}/download-token: get: tags: - Access operationId: access_aip_by_id_data_by_id_download-token_getTokenForAipDownloadedDataFile 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: [] /access/aip/{parentid}/data/list-status: get: tags: - Access operationId: access_aip_by_id_data_list-status parameters: - name: parentid in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: array items: type: string enum: - CHANGE_RELATIVE_LOCATION - CHANGE_DATA_CATEGORY - CLEANED - CLEANING - EXCLUDED_FILE - CHECK_COMPLIANCE - CHECK_COMPLIANCE_CLEANED - CHECKED_COMPLIANCE - CHECKED_COMPLIANCE_CLEANED - IGNORED_FILE - DOWNLOAD_IN_PROGRESS - FILE_FORMAT_IDENTIFIED - FILE_FORMAT_SKIPPED - FILE_FORMAT_UNKNOWN - IN_ERROR - PROCESSED - READY - RECEIVED - TO_PROCESS - VIRUS_CHECKED - VIRUS_SKIPPED security: - tokenAuth: [] - auth: [] /access/aip/{parentid}/aip/status: get: tags: - Access operationId: access_aip_by_id_aip_status_listStatus parameters: - name: parentid in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: array items: type: string description: 'OAIS Package Status: - CHECKED => Checked package during archiving process - CHECKING => A package verification is in progress during checking process - CHECK_PENDING => A package verification is pending during checking process - CLEANED => Cleaned package during cleaning process for SIP only - CLEANING => A package clean is in progress during cleaning process for SIP only - COMPLIANCE_LEVEL_UPDATE_PENDING => A package compliance update is pending - COMPLIANCE_LEVEL_UPDATED => The compliance levels of the package have been updated - COMPLETED => Completed package - DISPOSABLE => The Package is candidate for disposal process for AIP only - DISPOSAL_APPROVED_BY_ORGUNIT => Disposal org. unit approval done during disposal process for AIP only - DISPOSAL_APPROVED => Disposal approval done during disposal process for AIP only - DISPOSED => Disposed package for AIP only - DOWNLOADING => A package download is in progress - EDITING_METADATA => A package metadata edition is in progress - FIXING => A package correction is in progress - FIXITY_ERROR => Error when checking checksums - FIX_PENDING => A package correction is pending - INDEXING => A package indexing is in progress - IN_ERROR => Package in error during archiving process - IN_PREPARATION => Package in preparation during archiving process - IN_PROGRESS => A package archiving process is in progress - METADATA_EDITION_PENDING => A metadata edition is pending - METADATA_UPGRADE_PENDING => A metadata version upgrade is pending - PACKAGE_REPLICATION_PENDING => A package replication is pending - PRESERVATION_ERROR => Package in error during checking process - READY => Package Ready - REINDEXING => A package re-indexing is in progress - RELOADED => Reloaded package from storage location - REPLICATING_PACKAGE => A package replication is in progress - REPLICATING_TOMBSTONE => A tombstone package replication is in progress - RESUBMITTING => A package re-submission is in progress - STORED => Package stored on storage location - TOMBSTONE_REPLICATION_PENDING => A tombstone replication is pending - UPDATING_COMPLIANCE_LEVEL => A package compliance update is in progress - UPDATING_RETENTION => A package retention update is in progress during disposal process - UPGRADING_METADATA => A metadata version upgrade is in progress ' enum: - CHECK_PENDING - CHECKING - CHECKED - CLEANING - CLEANED - COMPLETED - DOWNLOADING - IN_PREPARATION - IN_PROGRESS - STORED - INDEXING - READY - RETRIEVING - RETRIEVING_PENDING - IN_ERROR - PRESERVATION_ERROR - FIXITY_ERROR - DISPOSABLE - DISPOSAL_APPROVED_BY_ORGUNIT - DISPOSAL_APPROVED - DISPOSED - FIX_PENDING - FIXING - METADATA_EDITION_PENDING - EDITING_METADATA - UPDATING_RETENTION - METADATA_UPGRADE_PENDING - UPGRADING_METADATA - COMPLIANCE_LEVEL_UPDATE_PENDING - UPDATING_COMPLIANCE_LEVEL - COMPLIANCE_LEVEL_UPDATED - REINDEXING - RELOADED - RESUBMITTING - PACKAGE_REPLICATION_PENDING - REPLICATING_PACKAGE - TOMBSTONE_REPLICATION_PENDING - REPLICATING_TOMBSTONE security: - tokenAuth: [] - auth: [] /access/aip/{id}/history: get: tags: - Access operationId: access_aip_by_id_history parameters: - name: id in: path required: true schema: type: string - name: pageable in: query required: true schema: $ref: '#/components/schemas/Pageable' responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionStatusHistory' security: - tokenAuth: [] - auth: [] /access/aip/{id}/download: get: tags: - Access operationId: access_aip_by_id_download_getFiles parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: string format: binary security: - tokenAuth: [] - auth: [] /access/aip/{id}/download-token: get: tags: - Access operationId: access_aip_by_id_download-token_getTokenAip parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/DownloadToken' security: - tokenAuth: [] - auth: [] /access/aip/total-for-completed-order: get: tags: - Access operationId: access_aip_total-for-completed-order_getCountForCompletedOrders responses: '200': description: OK content: '*/*': schema: type: integer format: int32 security: - tokenAuth: [] - auth: [] /access/aip/profile: get: tags: - Access summary: Download profile of a package description: Returns a binary stream (file). operationId: access_aip_profile parameters: - name: version in: query required: false schema: type: string responses: '200': description: Binary file stream content: application/octet-stream: schema: type: string format: binary '404': description: Profile not found content: '*/*': schema: $ref: '#/components/schemas/StreamingResponseBody' security: - tokenAuth: [] - auth: [] /access/aip/list-status: get: tags: - Access operationId: access_aip_list-status responses: '200': description: OK content: '*/*': schema: type: array items: type: string description: 'OAIS Package Status: - CHECKED => Checked package during archiving process - CHECKING => A package verification is in progress during checking process - CHECK_PENDING => A package verification is pending during checking process - CLEANED => Cleaned package during cleaning process for SIP only - CLEANING => A package clean is in progress during cleaning process for SIP only - COMPLIANCE_LEVEL_UPDATE_PENDING => A package compliance update is pending - COMPLIANCE_LEVEL_UPDATED => The compliance levels of the package have been updated - COMPLETED => Completed package - DISPOSABLE => The Package is candidate for disposal process for AIP only - DISPOSAL_APPROVED_BY_ORGUNIT => Disposal org. unit approval done during disposal process for AIP only - DISPOSAL_APPROVED => Disposal approval done during disposal process for AIP only - DISPOSED => Disposed package for AIP only - DOWNLOADING => A package download is in progress - EDITING_METADATA => A package metadata edition is in progress - FIXING => A package correction is in progress - FIXITY_ERROR => Error when checking checksums - FIX_PENDING => A package correction is pending - INDEXING => A package indexing is in progress - IN_ERROR => Package in error during archiving process - IN_PREPARATION => Package in preparation during archiving process - IN_PROGRESS => A package archiving process is in progress - METADATA_EDITION_PENDING => A metadata edition is pending - METADATA_UPGRADE_PENDING => A metadata version upgrade is pending - PACKAGE_REPLICATION_PENDING => A package replication is pending - PRESERVATION_ERROR => Package in error during checking process - READY => Package Ready - REINDEXING => A package re-indexing is in progress - RELOADED => Reloaded package from storage location - REPLICATING_PACKAGE => A package replication is in progress - REPLICATING_TOMBSTONE => A tombstone package replication is in progress - RESUBMITTING => A package re-submission is in progress - STORED => Package stored on storage location - TOMBSTONE_REPLICATION_PENDING => A tombstone replication is pending - UPDATING_COMPLIANCE_LEVEL => A package compliance update is in progress - UPDATING_RETENTION => A package retention update is in progress during disposal process - UPGRADING_METADATA => A metadata version upgrade is in progress ' enum: - CHECK_PENDING - CHECKING - CHECKED - CLEANING - CLEANED - COMPLETED - DOWNLOADING - IN_PREPARATION - IN_PROGRESS - STORED - INDEXING - READY - RETRIEVING - RETRIEVING_PENDING - IN_ERROR - PRESERVATION_ERROR - FIXITY_ERROR - DISPOSABLE - DISPOSAL_APPROVED_BY_ORGUNIT - DISPOSAL_APPROVED - DISPOSED - FIX_PENDING - FIXING - METADATA_EDITION_PENDING - EDITING_METADATA - UPDATING_RETENTION - METADATA_UPGRADE_PENDING - UPGRADING_METADATA - COMPLIANCE_LEVEL_UPDATE_PENDING - UPDATING_COMPLIANCE_LEVEL - COMPLIANCE_LEVEL_UPDATED - REINDEXING - RELOADED - RESUBMITTING - PACKAGE_REPLICATION_PENDING - REPLICATING_PACKAGE - TOMBSTONE_REPLICATION_PENDING - REPLICATING_TOMBSTONE security: - tokenAuth: [] - auth: [] /access/aip/list-metadata-versions: get: tags: - Access operationId: access_aip_list-metadata-versions responses: '200': description: OK content: '*/*': schema: type: array items: type: string security: - tokenAuth: [] - auth: [] /access/aip/list-data-types: get: tags: - Access operationId: access_aip_list-data-types parameters: - name: category in: query required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: array items: type: string enum: - Primary - Observational - Experimental - Simulation - Derived - Reference - Digitalized - Secondary - Publication - DataPaper - Documentation - Software - Code - Binaries - VirtualMachine - Administrative - Document - WebSite - Other - Package - InformationPackage - UpdatePackage - Metadata - CustomMetadata - UpdatedMetadata - Internal - DatasetThumbnail - ArchiveThumbnail - ArchiveReadme - DatafileThumbnail - ArchiveDataUseAgreement security: - tokenAuth: [] - auth: [] /access/aip/list-data-categories: get: tags: - Access operationId: access_aip_list-data-categories responses: '200': description: OK content: '*/*': schema: type: array items: type: string enum: - Primary - Observational - Experimental - Simulation - Derived - Reference - Digitalized - Secondary - Publication - DataPaper - Documentation - Software - Code - Binaries - VirtualMachine - Administrative - Document - WebSite - Other - Package - InformationPackage - UpdatePackage - Metadata - CustomMetadata - UpdatedMetadata - Internal - DatasetThumbnail - ArchiveThumbnail - ArchiveReadme - DatafileThumbnail - ArchiveDataUseAgreement security: - tokenAuth: [] - auth: [] /: get: tags: - Access operationId: '' responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Module' security: - tokenAuth: [] - auth: [] /access/metadata/{parentid}/ratings/by-rating: delete: tags: - Access operationId: access_metadata_by_id_ratings_by-rating_delete parameters: - name: parentid in: path required: true schema: type: string requestBody: content: application/json: schema: type: string required: true responses: '200': description: OK security: - tokenAuth: [] - auth: [] /preingest/deposits: get: tags: - Ingest 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: type: integer default: 0 minimum: 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: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string - name: 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: - Ingest 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: - Ingest 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: - Ingest 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: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionSubmissionAgreement' security: - tokenAuth: [] - auth: [] post: tags: - Ingest 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: - Ingest 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: - Ingest 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: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionSubjectArea' security: - tokenAuth: [] - auth: [] post: tags: - Ingest 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: - Ingest 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: - Ingest 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: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionLicense' security: - tokenAuth: [] - auth: [] post: tags: - Ingest 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: - Ingest operationId: preingest_deposits_by_id_licenses_deleteList parameters: - name: parentid in: path required: true schema: type: string responses: '200': description: OK security: - tokenAuth: [] - auth: [] /preingest/deposits/{parentid}/data: get: tags: - Ingest 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: type: integer default: 0 minimum: 0 - name: parentid in: path required: true schema: type: string - name: relativeLocation in: query required: false schema: type: string - name: resId in: query description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). required: false schema: type: string - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string - name: sourceData in: query required: false schema: type: string format: uri - name: status in: query required: false schema: type: string enum: - CHANGE_RELATIVE_LOCATION - CHANGE_DATA_CATEGORY - CLEANED - CLEANING - EXCLUDED_FILE - CHECK_COMPLIANCE - CHECK_COMPLIANCE_CLEANED - CHECKED_COMPLIANCE - CHECKED_COMPLIANCE_CLEANED - IGNORED_FILE - DOWNLOAD_IN_PROGRESS - FILE_FORMAT_IDENTIFIED - FILE_FORMAT_SKIPPED - FILE_FORMAT_UNKNOWN - IN_ERROR - PROCESSED - READY - RECEIVED - TO_PROCESS - VIRUS_CHECKED - VIRUS_SKIPPED - name: statusMessage in: query required: false schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionDepositDataFile' security: - tokenAuth: [] - auth: [] post: tags: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest operationId: preingest_deposits_by_id_data_resume-all_resumeList 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: - Ingest 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: - Ingest 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: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionPerson' security: - tokenAuth: [] - auth: [] post: tags: - Ingest 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: - Ingest 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: - Ingest 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: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionArchivalInfoPackage' security: - tokenAuth: [] - auth: [] post: tags: - Ingest 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: - Ingest operationId: preingest_deposits_by_id_aip_deleteList parameters: - name: parentid in: path required: true schema: type: string responses: '200': description: OK security: - tokenAuth: [] - auth: [] /preingest/deposits/{id}/upload: post: tags: - Ingest 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: type: object properties: file: type: string format: binary required: - file responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/DepositDataFile' security: - tokenAuth: [] - auth: [] /preingest/deposits/{id}/upload-metadata: post: tags: - Ingest operationId: preingest_deposits_by_id_upload-metadata parameters: - name: id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: file: type: string format: binary required: - file responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/DepositDataFile' security: - tokenAuth: [] - auth: [] /preingest/deposits/{id}/upload-archive: post: tags: - Ingest 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: type: object properties: file: type: string format: binary required: - file responses: '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/DepositDataFile' security: - tokenAuth: [] - auth: [] /preingest/deposits/{id}/submit-for-approval: post: tags: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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}/enable-revision: post: tags: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: type: integer default: 0 minimum: 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: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string - name: 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: - Ingest 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: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Deposit' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionDeposit' security: - tokenAuth: [] - auth: [] /ingest/sip: get: tags: - Ingest operationId: ingest_sip_list parameters: - name: aipId in: query description: The generated AIP identifier of the SIP. required: false schema: type: string - name: depositId in: query description: The source deposit identifier of the SIP. required: false schema: type: string - name: dispositionApproval in: query description: If the approval step the AIP disposal is mandatory. required: false schema: type: boolean - name: mainStorage in: query description: The main storage indice in configuration if the SIP. O means default storage (first one). required: false schema: type: integer format: int32 - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: publicationDate in: query description: The publication date of the deposit. required: false schema: type: string format: date - name: resId in: query description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). required: false schema: type: string - name: retention in: query description: 'The retention duration in days of the AIP: O means forever.' required: false schema: type: integer format: int32 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string - name: submissionPolicyId in: query description: The submission policy identifier of the SIP. required: false schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionSubmissionInfoPackage' security: - tokenAuth: [] - auth: [] post: tags: - Ingest operationId: ingest_sip_create requestBody: content: application/json: schema: $ref: '#/components/schemas/SubmissionInfoPackage' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/SubmissionInfoPackage' security: - tokenAuth: [] - auth: [] delete: tags: - Ingest operationId: ingest_sip_deleteList requestBody: content: application/json: schema: type: array items: type: string required: true responses: '200': description: OK security: - tokenAuth: [] - auth: [] /ingest/sip/{parentid}/data: get: tags: - Ingest operationId: ingest_sip_by_id_data_list parameters: - name: complianceLevel in: query required: false schema: type: string enum: - NOT_ASSESSED - NO_COMPLIANCE - WEAK_COMPLIANCE - AVERAGE_COMPLIANCE - FULL_COMPLIANCE - name: dataCategory in: query required: false schema: type: string enum: - Primary - Observational - Experimental - Simulation - Derived - Reference - Digitalized - Secondary - Publication - DataPaper - Documentation - Software - Code - Binaries - VirtualMachine - Administrative - Document - WebSite - Other - Package - InformationPackage - UpdatePackage - Metadata - CustomMetadata - UpdatedMetadata - Internal - DatasetThumbnail - ArchiveThumbnail - ArchiveReadme - DatafileThumbnail - ArchiveDataUseAgreement - name: dataType in: query required: false schema: type: string enum: - Primary - Observational - Experimental - Simulation - Derived - Reference - Digitalized - Secondary - Publication - DataPaper - Documentation - Software - Code - Binaries - VirtualMachine - Administrative - Document - WebSite - Other - Package - InformationPackage - UpdatePackage - Metadata - CustomMetadata - UpdatedMetadata - Internal - DatasetThumbnail - ArchiveThumbnail - ArchiveReadme - DatafileThumbnail - ArchiveDataUseAgreement - name: fileName in: query required: false schema: type: string - name: fileSize in: query required: false schema: type: integer format: int64 - name: finalData in: query required: false schema: type: string format: uri - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: parentid in: path required: true schema: type: string - name: relativeLocation in: query required: false schema: type: string - name: resId in: query description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). required: false schema: type: string - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string - name: sourceData in: query required: false schema: type: string format: uri - name: status in: query required: false schema: type: string enum: - CHANGE_RELATIVE_LOCATION - CHANGE_DATA_CATEGORY - CLEANED - CLEANING - EXCLUDED_FILE - CHECK_COMPLIANCE - CHECK_COMPLIANCE_CLEANED - CHECKED_COMPLIANCE - CHECKED_COMPLIANCE_CLEANED - IGNORED_FILE - DOWNLOAD_IN_PROGRESS - FILE_FORMAT_IDENTIFIED - FILE_FORMAT_SKIPPED - FILE_FORMAT_UNKNOWN - IN_ERROR - PROCESSED - READY - RECEIVED - TO_PROCESS - VIRUS_CHECKED - VIRUS_SKIPPED - name: statusMessage in: query required: false schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionSipDataFile' security: - tokenAuth: [] - auth: [] post: tags: - Ingest operationId: ingest_sip_by_id_data_create parameters: - name: parentid in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SipDataFile' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/SipDataFile' security: - tokenAuth: [] - auth: [] delete: tags: - Ingest operationId: ingest_sip_by_id_data_deleteList parameters: - name: parentid in: path required: true schema: type: string requestBody: content: application/json: schema: type: array items: type: string required: true responses: '200': description: OK security: - tokenAuth: [] - auth: [] /ingest/sip/{parentid}/data/{id}/resume: post: tags: - Ingest operationId: ingest_sip_by_id_data_by_id_resume parameters: - name: parentid in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Result' security: - tokenAuth: [] - auth: [] /ingest/sip/{parentid}/data/{id}/put-in-error: post: tags: - Ingest operationId: ingest_sip_by_id_data_by_id_put-in-error parameters: - name: parentid in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Result' security: - tokenAuth: [] - auth: [] /ingest/sip/{parentid}/aip: get: tags: - Ingest operationId: ingest_sip_by_id_aip_list parameters: - name: parentid in: path required: true schema: type: string - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionArchivalInfoPackage' security: - tokenAuth: [] - auth: [] post: tags: - Ingest operationId: ingest_sip_by_id_aip_create parameters: - name: parentid in: path required: true schema: type: string requestBody: content: application/json: schema: type: array items: type: string required: true responses: '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/ArchivalInfoPackage' security: - tokenAuth: [] - auth: [] delete: tags: - Ingest operationId: ingest_sip_by_id_aip_deleteList parameters: - name: parentid in: path required: true schema: type: string requestBody: content: application/json: schema: type: array items: type: string required: true responses: '200': description: OK security: - tokenAuth: [] - auth: [] /ingest/sip/{id}/upload: post: tags: - Ingest operationId: ingest_sip_by_id_upload_sendFile parameters: - name: id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: file: type: string format: binary required: - file responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/SipDataFile' security: - tokenAuth: [] - auth: [] /ingest/sip/{id}/start-metadata-upgrade: post: tags: - Ingest operationId: ingest_sip_by_id_start-metadata-upgrade_putInMetadataUpgrading parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Result' security: - tokenAuth: [] - auth: [] /ingest/sip/{id}/start-metadata-editing: post: tags: - Ingest operationId: ingest_sip_by_id_start-metadata-editing_putInMetadataEditing parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Result' security: - tokenAuth: [] - auth: [] /ingest/sip/{id}/resume: post: tags: - Ingest operationId: ingest_sip_by_id_resume parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Result' security: - tokenAuth: [] - auth: [] /ingest/sip/{id}/resubmit: post: tags: - Ingest operationId: ingest_sip_by_id_resubmit parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Result' security: - tokenAuth: [] - auth: [] /ingest/sip/{id}/put-in-error: post: tags: - Ingest operationId: ingest_sip_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: [] /ingest/sip/{id}/clean: post: tags: - Ingest operationId: ingest_sip_by_id_clean parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Result' security: - tokenAuth: [] - auth: [] /ingest/sip/search: get: tags: - Ingest operationId: ingest_sip_search_advancedSearch_get parameters: - name: search in: query required: true schema: type: string - name: match in: query required: false schema: type: string - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionSubmissionInfoPackage' security: - tokenAuth: [] - auth: [] post: tags: - Ingest operationId: ingest_sip_search_advancedSearch_post parameters: - name: match in: query required: false schema: type: string - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubmissionInfoPackage' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionSubmissionInfoPackage' security: - tokenAuth: [] - auth: [] /preingest/deposits/{parentid}/submission-agreements/{id}: get: tags: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: {} required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/DepositDataFile' security: - tokenAuth: [] - auth: [] /preingest/deposits/{parentid}/contributors/{id}: get: tags: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: [] /ingest/sip/{parentid}/data/{id}: get: tags: - Ingest operationId: ingest_sip_by_id_data_by_id_get parameters: - name: parentid in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/SipDataFile' security: - tokenAuth: [] - auth: [] delete: tags: - Ingest operationId: ingest_sip_by_id_data_by_id_delete parameters: - name: parentid in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: OK security: - tokenAuth: [] - auth: [] patch: tags: - Ingest operationId: ingest_sip_by_id_data_by_id_update parameters: - name: parentid in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: {} required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/SipDataFile' security: - tokenAuth: [] - auth: [] /ingest/sip/{parentid}/aip/{id}: get: tags: - Ingest operationId: ingest_sip_by_id_aip_by_id_get parameters: - name: parentid in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ArchivalInfoPackage' security: - tokenAuth: [] - auth: [] delete: tags: - Ingest operationId: ingest_sip_by_id_aip_by_id_delete parameters: - name: parentid in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: OK security: - tokenAuth: [] - auth: [] patch: tags: - Ingest operationId: ingest_sip_by_id_aip_by_id_update parameters: - name: parentid in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ArchivalInfoPackage' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ArchivalInfoPackage' security: - tokenAuth: [] - auth: [] /ingest/sip/{id}: get: tags: - Ingest operationId: ingest_sip_by_id_get parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/SubmissionInfoPackage' security: - tokenAuth: [] - auth: [] delete: tags: - Ingest operationId: ingest_sip_by_id_delete parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK security: - tokenAuth: [] - auth: [] patch: tags: - Ingest operationId: ingest_sip_by_id_update parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: true required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/SubmissionInfoPackage' security: - tokenAuth: [] - auth: [] /preingest: get: tags: - Ingest operationId: preingest_home responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Module' /preingest/deposits/{parentid}/data/{id}/history: get: tags: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: type: integer default: 0 minimum: 0 - name: parentid in: path required: true schema: type: string - name: relativeLocation in: query required: false schema: type: string - name: resId in: query description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). required: false schema: type: string - name: search in: query required: true schema: type: string - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string - name: sourceData in: query required: false schema: type: string format: uri - name: status in: query required: false schema: type: string enum: - CHANGE_RELATIVE_LOCATION - CHANGE_DATA_CATEGORY - CLEANED - CLEANING - EXCLUDED_FILE - CHECK_COMPLIANCE - CHECK_COMPLIANCE_CLEANED - CHECKED_COMPLIANCE - CHECKED_COMPLIANCE_CLEANED - IGNORED_FILE - DOWNLOAD_IN_PROGRESS - FILE_FORMAT_IDENTIFIED - FILE_FORMAT_SKIPPED - FILE_FORMAT_UNKNOWN - IN_ERROR - PROCESSED - READY - RECEIVED - TO_PROCESS - VIRUS_CHECKED - VIRUS_SKIPPED - name: statusMessage in: query required: false schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionDepositDataFile' security: - tokenAuth: [] - auth: [] /preingest/deposits/{parentid}/data/list-status: get: tags: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest 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: - Ingest operationId: preingest_deposits_list-accesses responses: '200': description: OK content: '*/*': schema: type: array items: type: string description: 'Access level of the archive: - PUBLIC => Open Access & Everyone - RESTRICTED => Team members (i.e., Org. Unit) & Trusted parties - CLOSED => Case by case & Individuals ' enum: - PUBLIC - RESTRICTED - CLOSED security: - tokenAuth: [] - auth: [] /preingest/contributors: get: tags: - Ingest operationId: preingest_contributors_list parameters: - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionContributor' security: - tokenAuth: [] - auth: [] /preingest/contributors/{parentid}/deposits: get: tags: - Ingest 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: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 20 minimum: 1 - name: sort in: query description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' required: false schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionDeposit' security: - tokenAuth: [] - auth: [] /preingest/contributors/{parentid}/deposits/{id}: get: tags: - Ingest 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: - Ingest 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: [] /ingest: get: tags: - Ingest operationId: ingest_home responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Module' /ingest/sip/{parentid}/data/{id}/history: get: tags: - Ingest operationId: ingest_sip_by_id_data_by_id_history parameters: - name: parentid in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: pageable in: query required: true schema: $ref: '#/components/schemas/Pageable' responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionStatusHistory' security: - tokenAuth: [] - auth: [] /ingest/sip/{parentid}/data/{id}/download: get: tags: - Ingest operationId: ingest_sip_by_id_data_by_id_download parameters: - name: parentid in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: string format: binary security: - tokenAuth: [] - auth: [] /ingest/sip/{parentid}/data/{id}/download-token: get: tags: - Ingest operationId: ingest_sip_by_id_data_by_id_download-token_getTokenForSipDataFile parameters: - name: parentid in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/DownloadToken' security: - tokenAuth: [] - auth: [] /ingest/sip/{parentid}/data/list-status: get: tags: - Ingest operationId: ingest_sip_by_id_data_list-status parameters: - name: parentid in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: array items: type: string enum: - CHANGE_RELATIVE_LOCATION - CHANGE_DATA_CATEGORY - CLEANED - CLEANING - EXCLUDED_FILE - CHECK_COMPLIANCE - CHECK_COMPLIANCE_CLEANED - CHECKED_COMPLIANCE - CHECKED_COMPLIANCE_CLEANED - IGNORED_FILE - DOWNLOAD_IN_PROGRESS - FILE_FORMAT_IDENTIFIED - FILE_FORMAT_SKIPPED - FILE_FORMAT_UNKNOWN - IN_ERROR - PROCESSED - READY - RECEIVED - TO_PROCESS - VIRUS_CHECKED - VIRUS_SKIPPED security: - tokenAuth: [] - auth: [] /ingest/sip/{id}/history: get: tags: - Ingest operationId: ingest_sip_by_id_history parameters: - name: id in: path required: true schema: type: string - name: pageable in: query required: true schema: $ref: '#/components/schemas/Pageable' responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RestCollectionStatusHistory' security: - tokenAuth: [] - auth: [] /ingest/sip/{id}/download: get: tags: - Ingest operationId: ingest_sip_by_id_download_getFiles parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: string format: binary security: - tokenAuth: [] - auth: [] /ingest/sip/{id}/download-token: get: tags: - Ingest operationId: ingest_sip_by_id_download-token_getTokenForSip parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/DownloadToken' security: - tokenAuth: [] - auth: [] /ingest/sip/{id}/aip-package: get: tags: - Ingest operationId: ingest_sip_by_id_aip-package_getAIP parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: string format: binary security: - tokenAuth: [] - auth: [] delete: tags: - Ingest operationId: ingest_sip_by_id_aip-package_deleteAIP parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK security: - tokenAuth: [] - auth: [] /ingest/sip/schema: get: tags: - Ingest summary: Download schema of a SIP description: Returns a binary stream (file) for the given SIP ID. operationId: ingest_sip_schema parameters: - name: version in: query required: false schema: type: string responses: '200': description: Binary file stream content: application/octet-stream: schema: type: string format: binary '404': description: Schema of SIP not found content: '*/*': schema: $ref: '#/components/schemas/StreamingResponseBody' security: - tokenAuth: [] - auth: [] /ingest/sip/profile: get: tags: - Ingest summary: Download profile of a package description: Returns a binary stream (file). operationId: ingest_sip_profile parameters: - name: version in: query required: false schema: type: string responses: '200': description: Binary file stream content: application/octet-stream: schema: type: string format: binary '404': description: Profile not found content: '*/*': schema: $ref: '#/components/schemas/StreamingResponseBody' security: - tokenAuth: [] - auth: [] /ingest/sip/list-status: get: tags: - Ingest operationId: ingest_sip_list-status responses: '200': description: OK content: '*/*': schema: type: array items: type: string description: 'OAIS Package Status: - CHECKED => Checked package during archiving process - CHECKING => A package verification is in progress during checking process - CHECK_PENDING => A package verification is pending during checking process - CLEANED => Cleaned package during cleaning process for SIP only - CLEANING => A package clean is in progress during cleaning process for SIP only - COMPLIANCE_LEVEL_UPDATE_PENDING => A package compliance update is pending - COMPLIANCE_LEVEL_UPDATED => The compliance levels of the package have been updated - COMPLETED => Completed package - DISPOSABLE => The Package is candidate for disposal process for AIP only - DISPOSAL_APPROVED_BY_ORGUNIT => Disposal org. unit approval done during disposal process for AIP only - DISPOSAL_APPROVED => Disposal approval done during disposal process for AIP only - DISPOSED => Disposed package for AIP only - DOWNLOADING => A package download is in progress - EDITING_METADATA => A package metadata edition is in progress - FIXING => A package correction is in progress - FIXITY_ERROR => Error when checking checksums - FIX_PENDING => A package correction is pending - INDEXING => A package indexing is in progress - IN_ERROR => Package in error during archiving process - IN_PREPARATION => Package in preparation during archiving process - IN_PROGRESS => A package archiving process is in progress - METADATA_EDITION_PENDING => A metadata edition is pending - METADATA_UPGRADE_PENDING => A metadata version upgrade is pending - PACKAGE_REPLICATION_PENDING => A package replication is pending - PRESERVATION_ERROR => Package in error during checking process - READY => Package Ready - REINDEXING => A package re-indexing is in progress - RELOADED => Reloaded package from storage location - REPLICATING_PACKAGE => A package replication is in progress - REPLICATING_TOMBSTONE => A tombstone package replication is in progress - RESUBMITTING => A package re-submission is in progress - STORED => Package stored on storage location - TOMBSTONE_REPLICATION_PENDING => A tombstone replication is pending - UPDATING_COMPLIANCE_LEVEL => A package compliance update is in progress - UPDATING_RETENTION => A package retention update is in progress during disposal process - UPGRADING_METADATA => A metadata version upgrade is in progress ' enum: - CHECK_PENDING - CHECKING - CHECKED - CLEANING - CLEANED - COMPLETED - DOWNLOADING - IN_PREPARATION - IN_PROGRESS - STORED - INDEXING - READY - RETRIEVING - RETRIEVING_PENDING - IN_ERROR - PRESERVATION_ERROR - FIXITY_ERROR - DISPOSABLE - DISPOSAL_APPROVED_BY_ORGUNIT - DISPOSAL_APPROVED - DISPOSED - FIX_PENDING - FIXING - METADATA_EDITION_PENDING - EDITING_METADATA - UPDATING_RETENTION - METADATA_UPGRADE_PENDING - UPGRADING_METADATA - COMPLIANCE_LEVEL_UPDATE_PENDING - UPDATING_COMPLIANCE_LEVEL - COMPLIANCE_LEVEL_UPDATED - REINDEXING - RELOADED - RESUBMITTING - PACKAGE_REPLICATION_PENDING - REPLICATING_PACKAGE - TOMBSTONE_REPLICATION_PENDING - REPLICATING_TOMBSTONE security: - tokenAuth: [] - auth: [] /ingest/sip/list-metadata-versions: get: tags: - Ingest operationId: ingest_sip_list-metadata-versions responses: '200': description: OK content: '*/*': schema: type: array items: type: string security: - tokenAuth: [] - auth: [] /ingest/sip/list-data-types: get: tags: - Ingest operationId: ingest_sip_list-data-types parameters: - name: category in: query required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: array items: type: string enum: - Primary - Observational - Experimental - Simulation - Derived - Reference - Digitalized - Secondary - Publication - DataPaper - Documentation - Software - Code - Binaries - VirtualMachine - Administrative - Document - WebSite - Other - Package - InformationPackage - UpdatePackage - Metadata - CustomMetadata - UpdatedMetadata - Internal - DatasetThumbnail - ArchiveThumbnail - ArchiveReadme - DatafileThumbnail - ArchiveDataUseAgreement security: - tokenAuth: [] - auth: [] /ingest/sip/list-data-categories: get: tags: - Ingest operationId: ingest_sip_list-data-categories responses: '200': description: OK content: '*/*': schema: type: array items: type: string enum: - Primary - Observational - Experimental - Simulation - Derived - Reference - Digitalized - Secondary - Publication - DataPaper - Documentation - Software - Code - Binaries - VirtualMachine - Administrative - Document - WebSite - Other - Package - InformationPackage - UpdatePackage - Metadata - CustomMetadata - UpdatedMetadata - Internal - DatasetThumbnail - ArchiveThumbnail - ArchiveReadme - DatafileThumbnail - ArchiveDataUseAgreement security: - tokenAuth: [] - auth: [] components: schemas: ChangeInfo: type: object description: The change information of an action. properties: fullName: type: string description: The full name of the user who did the action on the resource. readOnly: true who: type: string description: The user who did the action on the resource. readOnly: true when: type: string format: date-time description: The date when the action was done on the resources. readOnly: true OAISet: type: object description: OAI set. properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 description: type: string description: The description of the OAI set. maxLength: 1024 minLength: 1 enabled: type: boolean description: If the OAI set is enable. name: type: string description: The name of the OAI set. maxLength: 2147483647 minLength: 1 query: type: string description: 'The criteria to define the OAI set: query compliant with indexing search.' maxLength: 1024 minLength: 1 spec: type: string description: The spec of OAI set, which is an unique identifier for the set. maxLength: 2147483647 minLength: 1 _links: $ref: '#/components/schemas/Links' FacetResult: type: object properties: name: type: string field: type: string values: type: array items: $ref: '#/components/schemas/FacetResultValue' FacetResultValue: type: object properties: value: type: string count: type: integer format: int64 RestCollectionOAISet: type: object description: 'The structure of the REST response: - data: the list of objects - page: the pagination information - links: the HATEOAS links - facets: the search information ' properties: _links: $ref: '#/components/schemas/Links' _data: type: array items: $ref: '#/components/schemas/OAISet' _facets: type: array items: $ref: '#/components/schemas/FacetResult' _page: $ref: '#/components/schemas/RestCollectionPage' RestCollectionPage: type: object properties: currentPage: type: integer format: int64 sizePage: type: integer format: int64 totalItems: type: integer format: int64 totalPages: type: integer format: int64 MultiValueMapStringString: type: object additionalProperties: type: array items: type: string properties: all: type: object additionalProperties: type: string writeOnly: true empty: type: boolean OAIMetadataPrefix: type: object description: The OAI metadata prefixes defined the metadata formats supported by OAI-PMH provider. The default metadata prefix is oai_dc, derived from Dublin Core. properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 prefix: type: string description: The name of the OAI metadata prefix. maxLength: 255 minLength: 1 schemaUrl: type: string format: uri description: The XML schema URL of the OAI metadata prefix. schemaNamespace: type: string description: The XML schema namespace of the OAI metadata prefix. name: type: string description: The name of the OAI metadata prefix. maxLength: 255 minLength: 1 description: type: string description: The description of the OAI metadata prefix. maxLength: 1024 minLength: 1 enabled: type: boolean description: If the OAI metadata prefix is enable. reference: type: boolean description: If the OAI metadata prefix is the reference prefix. xmlClass: type: string description: The XML class of the OAI metadata prefix.. metadataSchema: type: string description: The XML schema content of the OAI metadata prefix. maxLength: 102400 minLength: 0 metadataXmlTransformation: type: string description: The XML transformation from reference prefix to the OAI metadata prefix. maxLength: 102400 minLength: 0 _links: $ref: '#/components/schemas/Links' RestCollectionOAIMetadataPrefix: type: object description: 'The structure of the REST response: - data: the list of objects - page: the pagination information - links: the HATEOAS links - facets: the search information ' properties: _links: $ref: '#/components/schemas/Links' _data: type: array items: $ref: '#/components/schemas/OAIMetadataPrefix' _facets: type: array items: $ref: '#/components/schemas/FacetResult' _page: $ref: '#/components/schemas/RestCollectionPage' DisseminationPolicyDto: type: object properties: disseminationPolicyId: type: string organizationalUnitDisseminationPolicyId: type: string subsetItemList: type: array items: $ref: '#/components/schemas/OrderSubsetItem' OrderSubsetItem: type: object properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 itemPath: type: string _links: $ref: '#/components/schemas/Links' SearchCondition: type: object description: 'The search conditions describes the query to search in the indexes. ' properties: type: type: string enum: - MATCH - TERM - WILDCARD - RANGE - QUERY - SIMPLE_QUERY - NESTED_BOOLEAN searchOperator: type: string enum: - AND - OR booleanClauseType: type: string enum: - MUST - FILTER - SHOULD - MUST_NOT field: type: string multiMatchFields: type: array items: type: string value: type: string terms: type: array items: type: string upperValue: type: string lowerValue: type: string nestedConditions: type: array items: $ref: '#/components/schemas/SearchCondition' ArchiveMetadata: type: object description: Public metadata of an archive properties: resId: type: string index: type: string description: Name of the index metadata: type: object additionalProperties: true description: The dynamic metadata list of the index. currentAccess: type: string description: The current access level of the archive, deducted from the final access level and an eventual embargo. enum: - PUBLIC - RESTRICTED - CLOSED readOnly: true _links: $ref: '#/components/schemas/Links' RestCollectionArchiveMetadata: type: object description: 'The structure of the REST response: - data: the list of objects - page: the pagination information - links: the HATEOAS links - facets: the search information ' properties: _links: $ref: '#/components/schemas/Links' _data: type: array items: $ref: '#/components/schemas/ArchiveMetadata' _facets: type: array items: $ref: '#/components/schemas/FacetResult' _page: $ref: '#/components/schemas/RestCollectionPage' Order: type: object description: Orders allow to prepare archive download (DIP) from the archives (AIP). properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 publicOrder: type: boolean description: If the order is public, false otherwise. subsetItems: type: array items: $ref: '#/components/schemas/OrderSubsetItem' metadataVersion: type: string description: The metadata version of the order query. enum: - '1.0' - '1.1' - '2.0' - '2.1' - '3.0' - '3.1' - '4.0' - '5.0' name: type: string description: The name of the order query. maxLength: 255 minLength: 1 query: type: string description: The query of the order query. maxLength: 5099 minLength: 0 queryType: type: string description: The type of the order query. enum: - ADVANCED - DIRECT - SIMPLE status: type: string description: The status of the order query. enum: - DOWNLOADING - IN_DISSEMINATION_PREPARATION - IN_ERROR - IN_PREPARATION - IN_PROGRESS - READY - SUBMITTED statusMessage: type: string description: The message related to the status of the order query. maxLength: 1024 minLength: 0 disseminationPolicyId: type: string description: The dissemination policy identifier linked to the order. maxLength: 2147483647 minLength: 1 organizationalUnitDisseminationPolicyId: type: string description: The dissemination policy identifier linked to the orgunit. maxLength: 2147483647 minLength: 1 subitemsChecksum: type: string description: The checksum of the order subitems list. orderStatus: type: string enum: - DOWNLOADING - IN_DISSEMINATION_PREPARATION - IN_ERROR - IN_PREPARATION - IN_PROGRESS - READY - SUBMITTED writeOnly: true errorStatus: type: string writeOnly: true dipNumber: type: integer format: int32 description: The DIP number of the order query. aipNumber: type: integer format: int32 description: The AIP number of the order query. _links: $ref: '#/components/schemas/Links' DisseminationInfoPackage: type: object description: Dissemination Information Package (DIP) properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 info: $ref: '#/components/schemas/RepresentationInfo' description: The OAIS representation information of the DIP. ready: type: boolean description: If DIP package is ready. readOnly: true aipIds: type: array description: The source AIP identifier list of the DIP. items: type: string readOnly: true packageStatus: type: string description: 'OAIS Package Status: - CHECKED => Checked package during archiving process - CHECKING => A package verification is in progress during checking process - CHECK_PENDING => A package verification is pending during checking process - CLEANED => Cleaned package during cleaning process for SIP only - CLEANING => A package clean is in progress during cleaning process for SIP only - COMPLIANCE_LEVEL_UPDATE_PENDING => A package compliance update is pending - COMPLIANCE_LEVEL_UPDATED => The compliance levels of the package have been updated - COMPLETED => Completed package - DISPOSABLE => The Package is candidate for disposal process for AIP only - DISPOSAL_APPROVED_BY_ORGUNIT => Disposal org. unit approval done during disposal process for AIP only - DISPOSAL_APPROVED => Disposal approval done during disposal process for AIP only - DISPOSED => Disposed package for AIP only - DOWNLOADING => A package download is in progress - EDITING_METADATA => A package metadata edition is in progress - FIXING => A package correction is in progress - FIXITY_ERROR => Error when checking checksums - FIX_PENDING => A package correction is pending - INDEXING => A package indexing is in progress - IN_ERROR => Package in error during archiving process - IN_PREPARATION => Package in preparation during archiving process - IN_PROGRESS => A package archiving process is in progress - METADATA_EDITION_PENDING => A metadata edition is pending - METADATA_UPGRADE_PENDING => A metadata version upgrade is pending - PACKAGE_REPLICATION_PENDING => A package replication is pending - PRESERVATION_ERROR => Package in error during checking process - READY => Package Ready - REINDEXING => A package re-indexing is in progress - RELOADED => Reloaded package from storage location - REPLICATING_PACKAGE => A package replication is in progress - REPLICATING_TOMBSTONE => A tombstone package replication is in progress - RESUBMITTING => A package re-submission is in progress - STORED => Package stored on storage location - TOMBSTONE_REPLICATION_PENDING => A tombstone replication is pending - UPDATING_COMPLIANCE_LEVEL => A package compliance update is in progress - UPDATING_RETENTION => A package retention update is in progress during disposal process - UPGRADING_METADATA => A metadata version upgrade is in progress ' enum: - CHECK_PENDING - CHECKING - CHECKED - CLEANING - CLEANED - COMPLETED - DOWNLOADING - IN_PREPARATION - IN_PROGRESS - STORED - INDEXING - READY - RETRIEVING - RETRIEVING_PENDING - IN_ERROR - PRESERVATION_ERROR - FIXITY_ERROR - DISPOSABLE - DISPOSAL_APPROVED_BY_ORGUNIT - DISPOSAL_APPROVED - DISPOSED - FIX_PENDING - FIXING - METADATA_EDITION_PENDING - EDITING_METADATA - UPDATING_RETENTION - METADATA_UPGRADE_PENDING - UPGRADING_METADATA - COMPLIANCE_LEVEL_UPDATE_PENDING - UPDATING_COMPLIANCE_LEVEL - COMPLIANCE_LEVEL_UPDATED - REINDEXING - RELOADED - RESUBMITTING - PACKAGE_REPLICATION_PENDING - REPLICATING_PACKAGE - TOMBSTONE_REPLICATION_PENDING - REPLICATING_TOMBSTONE writeOnly: true _links: $ref: '#/components/schemas/Links' EmbargoInfo: type: object description: Embargo information. properties: access: type: string description: The access level during the embargo. enum: - PUBLIC - RESTRICTED - CLOSED months: type: integer format: int32 description: The month number of the embargo duration. startDate: type: string format: date-time description: The starting date of the embargo period. RepresentationInfo: type: object description: 'OAIS Information Package: SIP, AIP or DIP.' properties: access: type: string description: The final access level of the package. enum: - PUBLIC - RESTRICTED - CLOSED dataSensitivity: type: string description: The data sensitivity of the package. enum: - UNDEFINED - BLUE - GREEN - YELLOW - ORANGE - RED - CRIMSON dataUsePolicy: type: string description: The data use policy type of the package. enum: - NONE - LICENSE - CLICK_THROUGH_DUA - SIGNED_DUA - EXTERNAL_DUA complianceLevel: type: string description: The compliance level of the package. enum: - NOT_ASSESSED - NO_COMPLIANCE - WEAK_COMPLIANCE - AVERAGE_COMPLIANCE - FULL_COMPLIANCE description: type: string description: The description of the package. maxLength: 1024 minLength: 0 embargo: $ref: '#/components/schemas/EmbargoInfo' licenseId: type: string description: The license identifier of the package. metadataVersion: type: string description: The metadata version of the package. enum: - '1.0' - '1.1' - '2.0' - '2.1' - '3.0' - '3.1' - '4.0' - '5.0' name: type: string description: The name of the package. maxLength: 255 minLength: 1 organizationalUnitId: type: string description: The organizational Unit ID of the package. maxLength: 50 minLength: 1 status: type: string description: The status of the package. enum: - CHECK_PENDING - CHECKING - CHECKED - CLEANING - CLEANED - COMPLETED - DOWNLOADING - IN_PREPARATION - IN_PROGRESS - STORED - INDEXING - READY - RETRIEVING - RETRIEVING_PENDING - IN_ERROR - PRESERVATION_ERROR - FIXITY_ERROR - DISPOSABLE - DISPOSAL_APPROVED_BY_ORGUNIT - DISPOSAL_APPROVED - DISPOSED - FIX_PENDING - FIXING - METADATA_EDITION_PENDING - EDITING_METADATA - UPDATING_RETENTION - METADATA_UPGRADE_PENDING - UPGRADING_METADATA - COMPLIANCE_LEVEL_UPDATE_PENDING - UPDATING_COMPLIANCE_LEVEL - COMPLIANCE_LEVEL_UPDATED - REINDEXING - RELOADED - RESUBMITTING - PACKAGE_REPLICATION_PENDING - REPLICATING_PACKAGE - TOMBSTONE_REPLICATION_PENDING - REPLICATING_TOMBSTONE statusMessage: type: string description: The detailed message related to the package status. maxLength: 1024 minLength: 0 containsUpdatedMetadata: type: boolean description: If the package contains updated metadata. contentStructurePublic: type: boolean description: If the archive structure content is public. accessCurrentlyPublic: type: boolean description: If the current access level is public currentAccess: type: string description: The current access level of the package, deducted from the final access level and an eventual embargo. enum: - PUBLIC - RESTRICTED - CLOSED readOnly: true ArchivalInfoPackage: type: object description: Archival Information Package (AIP) properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 dispositionApproval: type: boolean description: If the approval step the AIP disposal is mandatory. retention: type: integer format: int32 description: 'The retention duration in days of the AIP: O means forever.' archiveContainer: type: string description: The container type of the AIP. enum: - UNDEFINED - ZIP - BAG_IT archivalUnit: type: boolean description: if the AIP is an unit (AIU) or a collection (AIC). archiveId: type: string description: The storage URI of the AIP. archiveFileNumber: type: integer format: int64 description: The total number of files in the AIP. updateNumber: type: integer format: int64 description: The number of updates in the AIP. collectionFileNumber: type: integer format: int64 description: The total number of filed in the collection AIP. archiveSize: type: integer format: int64 description: The size in bytes of the AIP. tombstoneSize: type: integer format: int64 description: The size in bytes of the tombstone AIP. collectionArchiveSize: type: integer format: int64 description: The total size in bytes of the collection AIP. checksumCheck: $ref: '#/components/schemas/ChecksumCheck' description: The last checksum verification information of the AIP. checksums: type: array description: The checksum list of the AIP. items: $ref: '#/components/schemas/DataFileChecksum' fileFormat: $ref: '#/components/schemas/FileFormat' description: The file format identification of the AIP. info: $ref: '#/components/schemas/RepresentationInfo' description: The OAIS representation information of the AIP. sipIds: type: array description: The source SIP list (IDs) of the AIP. items: type: string virusCheck: $ref: '#/components/schemas/VirusCheck' description: The file virus check of the AIP. publicationDate: type: string format: date description: The publication date of the AIP. lastArchiving: type: string format: date-time description: 'The last archiving process date of the AIP: the first archiving date or the last metadata edition.' ready: type: boolean description: If AIP package is ready. readOnly: true dataFileNumber: type: integer format: int32 description: The number of AIP data files. readOnly: true complianceLevel: type: string description: 'Compliance level to define the preservation quality based on data file format: - NOT_ASSESSED => The format could not be evaluated - NO_COMPLIANCE => The format could not be determined - WEAK_COMPLIANCE => The format was determined: content type detected - AVERAGE_COMPLIANCE => The format was determined: WEAK_COMPLIANCE + PRONOM identifier detected - FULL_COMPLIANCE => The format was determined: AVERAGE_COMPLIANCE + the format is part of golden formats ' enum: - NOT_ASSESSED - NO_COMPLIANCE - WEAK_COMPLIANCE - AVERAGE_COMPLIANCE - FULL_COMPLIANCE writeOnly: true smartSize: type: string description: The size in human-readable format of the AIP. readOnly: true collectionSize: type: integer format: int32 description: The number of AIPs in collection AIP. readOnly: true smartTombstoneSize: type: string description: The size in human-readable format of the tombstone AIP. readOnly: true smartCollectionArchiveSize: type: string description: The total size in human-readable format of the collection AIP. readOnly: true retentionEnd: type: string format: date-time description: The end of the AIP retention. readOnly: true packageStatus: type: string description: 'OAIS Package Status: - CHECKED => Checked package during archiving process - CHECKING => A package verification is in progress during checking process - CHECK_PENDING => A package verification is pending during checking process - CLEANED => Cleaned package during cleaning process for SIP only - CLEANING => A package clean is in progress during cleaning process for SIP only - COMPLIANCE_LEVEL_UPDATE_PENDING => A package compliance update is pending - COMPLIANCE_LEVEL_UPDATED => The compliance levels of the package have been updated - COMPLETED => Completed package - DISPOSABLE => The Package is candidate for disposal process for AIP only - DISPOSAL_APPROVED_BY_ORGUNIT => Disposal org. unit approval done during disposal process for AIP only - DISPOSAL_APPROVED => Disposal approval done during disposal process for AIP only - DISPOSED => Disposed package for AIP only - DOWNLOADING => A package download is in progress - EDITING_METADATA => A package metadata edition is in progress - FIXING => A package correction is in progress - FIXITY_ERROR => Error when checking checksums - FIX_PENDING => A package correction is pending - INDEXING => A package indexing is in progress - IN_ERROR => Package in error during archiving process - IN_PREPARATION => Package in preparation during archiving process - IN_PROGRESS => A package archiving process is in progress - METADATA_EDITION_PENDING => A metadata edition is pending - METADATA_UPGRADE_PENDING => A metadata version upgrade is pending - PACKAGE_REPLICATION_PENDING => A package replication is pending - PRESERVATION_ERROR => Package in error during checking process - READY => Package Ready - REINDEXING => A package re-indexing is in progress - RELOADED => Reloaded package from storage location - REPLICATING_PACKAGE => A package replication is in progress - REPLICATING_TOMBSTONE => A tombstone package replication is in progress - RESUBMITTING => A package re-submission is in progress - STORED => Package stored on storage location - TOMBSTONE_REPLICATION_PENDING => A tombstone replication is pending - UPDATING_COMPLIANCE_LEVEL => A package compliance update is in progress - UPDATING_RETENTION => A package retention update is in progress during disposal process - UPGRADING_METADATA => A metadata version upgrade is in progress ' enum: - CHECK_PENDING - CHECKING - CHECKED - CLEANING - CLEANED - COMPLETED - DOWNLOADING - IN_PREPARATION - IN_PROGRESS - STORED - INDEXING - READY - RETRIEVING - RETRIEVING_PENDING - IN_ERROR - PRESERVATION_ERROR - FIXITY_ERROR - DISPOSABLE - DISPOSAL_APPROVED_BY_ORGUNIT - DISPOSAL_APPROVED - DISPOSED - FIX_PENDING - FIXING - METADATA_EDITION_PENDING - EDITING_METADATA - UPDATING_RETENTION - METADATA_UPGRADE_PENDING - UPGRADING_METADATA - COMPLIANCE_LEVEL_UPDATE_PENDING - UPDATING_COMPLIANCE_LEVEL - COMPLIANCE_LEVEL_UPDATED - REINDEXING - RELOADED - RESUBMITTING - PACKAGE_REPLICATION_PENDING - REPLICATING_PACKAGE - TOMBSTONE_REPLICATION_PENDING - REPLICATING_TOMBSTONE writeOnly: true smartRetention: type: string description: The retention duration in human-readable format of the package. readOnly: true _links: $ref: '#/components/schemas/Links' ChecksumCheck: type: object description: Checksum verification information. properties: checkDate: type: string format: date-time description: The execution date of checksum verification. checkingSucceed: type: boolean description: The execution result of checksum verification. DataFileChecksum: type: object properties: checksum: type: string checksumAlgo: type: string enum: - CRC32 - MD5 - SHA-1 - SHA-256 - SHA-512 checksumOrigin: type: string enum: - DLCM - DLCM_TOMBSTONE - USER - PORTAL checksumType: type: string enum: - COMPLETE - PARTIAL creationTime: type: string format: date-time FileFormat: type: object description: File format informations. properties: contentType: type: string description: The content type of the file. maxLength: 100 minLength: 0 details: type: string description: The result details of the file format identification. format: type: string description: The format description of the file. md5: type: string description: The MD5 checksum of the file. maxLength: 256 minLength: 0 puid: type: string description: The format PRONOM identifier of the file. maxLength: 20 minLength: 0 tool: $ref: '#/components/schemas/Tool' description: The format identification tool used to get the file format. version: type: string description: The format version of the file. maxLength: 50 minLength: 0 Tool: type: object description: Software tool information. properties: description: type: string description: The description of the tool. name: type: string description: The name of the tool. puid: type: string description: The PRONOM identifier of the tool. version: type: string description: The version of the tool. VirusCheck: type: object description: Virus check information. properties: checkDate: type: string format: date-time description: The execution date of the virus check. details: type: string description: The result details of the virus check. tool: $ref: '#/components/schemas/Tool' description: The virus check tool used to verify if the file contains virus. Result: type: object description: 'The result is the result of REST action (HTTP POST) with the status: - EXECUTED => the action was executed successfully - NOT_EXECUTED => the action failed and the message details the reason - NON_APPLICABLE => the action cannot be executed and the message details the reason ' 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' RestCollectionOrder: type: object description: 'The structure of the REST response: - data: the list of objects - page: the pagination information - links: the HATEOAS links - facets: the search information ' properties: _links: $ref: '#/components/schemas/Links' _data: type: array items: $ref: '#/components/schemas/Order' _facets: type: array items: $ref: '#/components/schemas/FacetResult' _page: $ref: '#/components/schemas/RestCollectionPage' ApplicationRole: type: object description: The application role defines the priviledge of the user. properties: name: type: string description: The name of the application role. level: type: integer format: int32 description: The level of the application role. The lowest value has more privileges. resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). ArchiveUserRating: type: object description: Archive ratings are the grade assigned by an user to an archive. properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 archiveId: type: string description: The archive identifier of the archive rating. user: $ref: '#/components/schemas/User' description: The user of the archive rating. ratingType: $ref: '#/components/schemas/RatingType' description: The rating type of the archive rating. grade: type: integer format: int32 description: The grade of the archive rating. _links: $ref: '#/components/schemas/Links' AuthLoginInfo: type: object description: Authentification login information. properties: loginTime: type: string format: date-time description: Date of the user login. loginIpAddress: type: string description: IP address of the user login. AuthUserDto: type: object properties: resId: type: string externalUid: type: string creationWhen: type: string format: date-time lastUpdateWhen: type: string format: date-time creationWho: type: string lastUpdateWho: type: string disabled: type: boolean writeOnly: true email: type: string firstName: type: string homeOrganization: type: string affiliations: type: array items: type: string lastName: type: string applicationRole: $ref: '#/components/schemas/ApplicationRole' firstLogin: $ref: '#/components/schemas/AuthLoginInfo' lastLogin: $ref: '#/components/schemas/LoginInfo' orcid: 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. enabled: type: boolean fullName: type: string LoginInfo: type: object description: Login information properties: loginIpAddress: type: string description: IP address of the user login. loginTime: type: string format: date-time description: Date of the user login. OrcidToken: type: object description: Personal token allowing to interact with ORCID API. properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 scope: type: string name: type: string orcid: type: string expiresIn: type: string format: date-time _links: $ref: '#/components/schemas/Links' Person: type: object 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. properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 searchCriterias: type: array items: $ref: '#/components/schemas/SearchCriteria' firstName: type: string description: The first name of the person. maxLength: 255 minLength: 1 lastName: type: string description: The last name of the person. maxLength: 255 minLength: 1 orcid: type: string description: 'The ORCID of the person (Format: xxxx-xxxx-xxxx-xxxx).' 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' verifiedOrcid: type: boolean description: if the person ORCID is verified with ORCID authentication. orcidToken: $ref: '#/components/schemas/OrcidToken' description: The ORCID token of the person. avatar: $ref: '#/components/schemas/PersonAvatar' description: The avatar of the person. fullName: type: string description: The full name of the person. _links: $ref: '#/components/schemas/Links' PersonAvatar: type: object properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 fileName: type: string description: The file name. maxLength: 2024 minLength: 0 fileSize: type: integer format: int64 description: The file size in bytes. 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' RatingType: type: object description: 'The rating types is the type of grade for a dataset: Quality or Usefulness.' properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 name: type: string description: The name of the rating type. _links: $ref: '#/components/schemas/Links' SearchCriteria: type: object properties: caseInsensitive: type: boolean caseType: type: string key: type: string operation: type: string operationType: type: string enum: - BETWEEN - CONTAINS - ENDS_WITH - EQUALITY - GREATER_EQUAL - GREATER_THAN - LESS_EQUAL - LESS_THAN - NEGATION - ORACLE_CONTAINS - STARTS_WITH value: {} User: type: object description: A user represents a user of the platform. A person and roles are associated to it. properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 searchCriterias: type: array items: $ref: '#/components/schemas/SearchCriteria' lastLoginTime: type: string format: date-time description: The date of the user last login. lastLoginIpAddress: type: string description: The IP address from last login of the user. maxLength: 255 minLength: 0 applicationRole: $ref: '#/components/schemas/ApplicationRole' description: The application role of the user. disabled: type: boolean writeOnly: true email: type: string description: The user email which must be a valid address. maxLength: 255 minLength: 1 externalUid: type: string description: The external unique ID of the user. maxLength: 255 minLength: 1 firstName: type: string description: The first name of the user. maxLength: 255 minLength: 1 lastName: type: string description: The last name of the user. maxLength: 255 minLength: 1 homeOrganization: type: string description: The home organization of the user. maxLength: 512 minLength: 1 person: $ref: '#/components/schemas/Person' description: The linked person of the user. lastSyncFromAuthServerTime: type: string format: date-time description: The last time the user was updated with info coming from the authorization server enabled: type: boolean description: If the user is enable. fullName: type: string description: The full name of the user. applicationRoleAndLastLogin: $ref: '#/components/schemas/AuthUserDto' writeOnly: true _links: $ref: '#/components/schemas/Links' DipDataFile: type: object properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 searchCriterias: type: array items: $ref: '#/components/schemas/SearchCriteria' complianceLevel: type: string description: 'Compliance level to define the preservation quality based on data file format: - NOT_ASSESSED => The format could not be evaluated - NO_COMPLIANCE => The format could not be determined - WEAK_COMPLIANCE => The format was determined: content type detected - AVERAGE_COMPLIANCE => The format was determined: WEAK_COMPLIANCE + PRONOM identifier detected - FULL_COMPLIANCE => The format was determined: AVERAGE_COMPLIANCE + the format is part of golden formats ' enum: - NOT_ASSESSED - NO_COMPLIANCE - WEAK_COMPLIANCE - AVERAGE_COMPLIANCE - FULL_COMPLIANCE dataCategory: type: string enum: - Primary - Observational - Experimental - Simulation - Derived - Reference - Digitalized - Secondary - Publication - DataPaper - Documentation - Software - Code - Binaries - VirtualMachine - Administrative - Document - WebSite - Other - Package - InformationPackage - UpdatePackage - Metadata - CustomMetadata - UpdatedMetadata - Internal - DatasetThumbnail - ArchiveThumbnail - ArchiveReadme - DatafileThumbnail - ArchiveDataUseAgreement dataType: type: string enum: - Primary - Observational - Experimental - Simulation - Derived - Reference - Digitalized - Secondary - Publication - DataPaper - Documentation - Software - Code - Binaries - VirtualMachine - Administrative - Document - WebSite - Other - Package - InformationPackage - UpdatePackage - Metadata - CustomMetadata - UpdatedMetadata - Internal - DatasetThumbnail - ArchiveThumbnail - ArchiveReadme - DatafileThumbnail - ArchiveDataUseAgreement fileFormat: $ref: '#/components/schemas/FileFormat' fileSize: type: integer format: int64 finalData: type: string format: uri fileName: type: string readOnly: true metadataType: $ref: '#/components/schemas/MetadataType' relativeLocation: type: string maxLength: 460 minLength: 0 pattern: (^\/$)|(^\/.*(? The format could not be evaluated - NO_COMPLIANCE => The format could not be determined - WEAK_COMPLIANCE => The format was determined: content type detected - AVERAGE_COMPLIANCE => The format was determined: WEAK_COMPLIANCE + PRONOM identifier detected - FULL_COMPLIANCE => The format was determined: AVERAGE_COMPLIANCE + the format is part of golden formats ' enum: - NOT_ASSESSED - NO_COMPLIANCE - WEAK_COMPLIANCE - AVERAGE_COMPLIANCE - FULL_COMPLIANCE dataCategory: type: string enum: - Primary - Observational - Experimental - Simulation - Derived - Reference - Digitalized - Secondary - Publication - DataPaper - Documentation - Software - Code - Binaries - VirtualMachine - Administrative - Document - WebSite - Other - Package - InformationPackage - UpdatePackage - Metadata - CustomMetadata - UpdatedMetadata - Internal - DatasetThumbnail - ArchiveThumbnail - ArchiveReadme - DatafileThumbnail - ArchiveDataUseAgreement dataType: type: string enum: - Primary - Observational - Experimental - Simulation - Derived - Reference - Digitalized - Secondary - Publication - DataPaper - Documentation - Software - Code - Binaries - VirtualMachine - Administrative - Document - WebSite - Other - Package - InformationPackage - UpdatePackage - Metadata - CustomMetadata - UpdatedMetadata - Internal - DatasetThumbnail - ArchiveThumbnail - ArchiveReadme - DatafileThumbnail - ArchiveDataUseAgreement fileFormat: $ref: '#/components/schemas/FileFormat' fileSize: type: integer format: int64 finalData: type: string format: uri fileName: type: string readOnly: true metadataType: $ref: '#/components/schemas/MetadataType' relativeLocation: type: string maxLength: 460 minLength: 0 pattern: (^\/$)|(^\/.*(? Approved deposit. The SIP preparation is in progress. - CANCEL_EDITING_METADATA => A cancellation of metadata edition is in progress. - CHECKED => Checked deposit. The deposit is ready for SIP preparation. - CHECKING_COMPLIANCE => A compliance check is in progress for completed deposits. - CHECKING_COMPLIANCE_CLEANED => A compliance check is in progress for cleaned deposits. - CLEANED => Cleaned deposit: the data file are purged based on submission policy. - CLEANING => A clean process is in progress. - COMPLETED => Completed deposit. The preparation of SIP is completed. - COMPLIANCE_ERROR => An error occurred during a compliance check. - DELETING => A deletion process is in progress. - EDITING_METADATA_REJECTED => The metadata edition was rejected. - EDITING_METADATA => The deposit is in edition mode for metadata. - IN_ERROR => An error occurred during the SIP preparation. - IN_PROGRESS => The deposit is in progress, ready for adding data files. - IN_VALIDATION => The deposit is waiting for an approval. - REJECTED => The deposit was rejected. - RELOADING => The deposit is a reload process. - SUBMITTED => Submitted deposit. The SIP preparation is in progress. - UPGRADING_METADATA => The deposit is in upgrade mode of metadata version. ' properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 searchCriterias: type: array items: $ref: '#/components/schemas/SearchCriteria' access: type: string description: The access level of the deposit. enum: - PUBLIC - RESTRICTED - CLOSED dataSensitivity: type: string description: The data sensitivity of the deposit. enum: - UNDEFINED - BLUE - GREEN - YELLOW - ORANGE - RED - CRIMSON dataUsePolicy: type: string description: The data use policy of the deposit. enum: - NONE - LICENSE - CLICK_THROUGH_DUA - SIGNED_DUA - EXTERNAL_DUA dataFileNumber: type: integer format: int32 description: The number of deposit data files. readOnly: true complianceLevel: type: string description: The compliance level of the deposit. enum: - NOT_ASSESSED - NO_COMPLIANCE - WEAK_COMPLIANCE - AVERAGE_COMPLIANCE - FULL_COMPLIANCE collectionBegin: type: string format: date-time description: The start date of the deposit for collecting data. collectionEnd: type: string format: date-time description: The end date of the deposit for collecting data. description: type: string description: The description of the deposit. maxLength: 4096 minLength: 1 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' description: The embargo of the deposit. keywords: type: array description: The keyword List of the deposit. items: type: string language: $ref: '#/components/schemas/Language' description: The language object of the deposit. languageId: type: string description: The language identifier of the deposit. maxLength: 50 minLength: 0 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' description: The archive type object of the deposit. metadataVersion: type: string description: The metadata version of the deposit. enum: - '1.0' - '1.1' - '2.0' - '2.1' - '3.0' - '3.1' - '4.0' - '5.0' organizationalUnit: $ref: '#/components/schemas/OrganizationalUnit' description: The organizational unit object of the deposit. organizationalUnitId: type: string description: The organizational unit identifier of the deposit. maxLength: 2147483647 minLength: 1 preparationId: type: string description: The preparation identifier of the deposit. maxLength: 50 minLength: 0 preservationPolicy: $ref: '#/components/schemas/PreservationPolicy' description: The preservation policy object of the deposit. readOnly: true preservationPolicyId: type: string description: The preservation policy identifier of the deposit. maxLength: 50 minLength: 0 publicationDate: type: string format: date description: The publication date of the deposit. sipId: type: string description: The generated SIP identifier of the deposit. maxLength: 50 minLength: 0 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: type: string description: The detailed message related to the deposit status. maxLength: 1024 minLength: 0 submissionPolicy: $ref: '#/components/schemas/SubmissionPolicy' description: The submission policy object of the deposit. readOnly: true submissionPolicyId: type: string description: The submission policy identifier of the deposit. maxLength: 50 minLength: 0 title: type: string description: The title of the deposit. maxLength: 255 minLength: 1 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 which indicates A is used as a source of information by B. items: type: string 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: type: string description: The additional fields form ID used to generate the additional fields values. maxLength: 50 minLength: 0 errorStatusWithMessage: type: string writeOnly: true hasEmbargo: type: boolean collectionSize: type: integer format: int32 description: The number of archives in the deposit. readOnly: true _links: $ref: '#/components/schemas/Links' Institution: type: object description: An institution represents academic institutions, such as UNIGE and HES-SO. properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 description: type: string description: The description of the institution. maxLength: 1024 minLength: 0 emailSuffixes: type: array description: The email suffixes list of the institution. items: type: string name: type: string description: The name of the institution. maxLength: 2147483647 minLength: 1 url: type: string format: uri description: The URL of the institution. rorId: type: string description: The ROR identifier of the institution. logo: $ref: '#/components/schemas/InstitutionLogo' description: The logo of the institution. identifiers: type: object additionalProperties: true description: The other identifiers list of the institution. organizationalUnit: type: array items: $ref: '#/components/schemas/OrganizationalUnit' writeOnly: true _links: $ref: '#/components/schemas/Links' InstitutionLogo: type: object properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 fileName: type: string description: The file name. maxLength: 2024 minLength: 0 fileSize: type: integer format: int64 description: The file size in bytes. 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' Label: type: object properties: language: $ref: '#/components/schemas/LanguageDTO' writeOnly: true text: type: string maxLength: 1024 minLength: 0 Language: type: object description: The language for internationalization (i18n) & localization (L10n) properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 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 format: int32 description: Property allowing to sort languages in lists labels: type: array items: $ref: '#/components/schemas/Label' _links: $ref: '#/components/schemas/Links' License: type: object description: A license represents software licenses (Academic Free License 3.0, Design Science License, MIT License…​). properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 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: The OD conformance status of the license. 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: The ODS conformance status of the license. enum: - approved - '' - not reviewed - rejected status: type: string description: The current status of the license. enum: - active - retired - superseded title: type: string description: The title of the license. url: type: string format: uri description: The source URL of the license. logo: $ref: '#/components/schemas/LicenseLogo' description: The logo of the license. description: type: string description: 'The description of the license. The format is: ().' readOnly: true _links: $ref: '#/components/schemas/Links' LicenseLogo: type: object properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 fileName: type: string description: The file name. maxLength: 2024 minLength: 0 fileSize: type: integer format: int64 description: The file size in bytes. 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' OrganizationalUnit: type: object 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. properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 closingDate: type: string format: date description: The closing date of the organizational unit. defaultLicense: $ref: '#/components/schemas/License' description: The default license of the organizational unit. defaultPreservationPolicy: $ref: '#/components/schemas/PreservationPolicy' description: The default preservation policy of the organizational unit. defaultSubmissionPolicy: $ref: '#/components/schemas/SubmissionPolicy' description: The default submission policy of the organizational unit. description: type: string description: The description of the organizational unit. maxLength: 1024 minLength: 0 institutions: type: array items: $ref: '#/components/schemas/Institution' writeOnly: true 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 name: type: string description: The name of the organizational unit. maxLength: 2147483647 minLength: 1 openingDate: type: string format: date description: The opening date of the organizational unit. url: type: string format: uri description: The URL of the organizational unit. logo: $ref: '#/components/schemas/OrganizationalUnitLogo' description: The logo of the organizational unit. open: type: boolean description: If the organizational unit is currently open. _links: $ref: '#/components/schemas/Links' PreservationPolicy: type: object description: A preservation policy defines whether approval is required for an AIP’s disposition as well as how long it should be kept. properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 dispositionApproval: type: boolean description: If the approval step is mandatory during the AIP disposal process. retention: type: integer format: int32 description: The retention duration in days of the preservation policy. O means forever. mainStorage: type: integer format: int32 description: The main storage indice in configuration of the preservation policy. O means default storage (first one). name: type: string description: The name of the preservation policy. maxLength: 255 minLength: 1 useNumber: type: integer format: int32 description: The number of the preservation policy use in organizational units. readOnly: true smartRetention: type: string description: The retention duration in human-readable format of the package. readOnly: true _links: $ref: '#/components/schemas/Links' SubmissionAgreement: type: object description: A submission agreement defines the conditions of the submissions. properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 title: type: string description: The title of the submission agreement description: type: string description: The description of the submission agreement maxLength: 1024 minLength: 0 version: type: string description: The version of the submission agreement submissionAgreementFile: $ref: '#/components/schemas/SubmissionAgreementFile' description: The submission agreement file _links: $ref: '#/components/schemas/Links' SubmissionAgreementFile: type: object properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 fileName: type: string description: The file name. maxLength: 2024 minLength: 0 fileSize: type: integer format: int64 description: The file size in bytes. 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' SubmissionPolicy: type: object 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. properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 name: type: string description: The name of the submission policy. maxLength: 255 minLength: 1 submissionApproval: type: boolean description: If approval step is mandatory for submitting a deposit. timeToKeep: type: integer format: int32 description: The time in days to keep completed deposit before purge. submissionAgreementType: type: string description: The submission agreement type of the submission policy. enum: - WITHOUT - ON_FIRST_DEPOSIT - FOR_EACH_DEPOSIT submissionAgreement: $ref: '#/components/schemas/SubmissionAgreement' description: The submission agreement of the submission policy. useNumber: type: integer format: int32 description: The number of the submission policy use in organizational units. readOnly: true _links: $ref: '#/components/schemas/Links' SubjectArea: type: object description: 'A subject area delineates a range of academic, administrative, and patrimonial disciplines. Each 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.' properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 searchCriterias: type: array items: $ref: '#/components/schemas/SearchCriteria' code: type: string description: The code of the subject area. maxLength: 50 minLength: 1 labels: type: array description: The name labels for each supported languages of the subject area. items: $ref: '#/components/schemas/Label' name: type: string description: The name of the subject area. maxLength: 1024 minLength: 0 source: type: string description: The source of the subject area. maxLength: 30 minLength: 1 _links: $ref: '#/components/schemas/Links' DepositDataFile: type: object properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 searchCriterias: type: array items: $ref: '#/components/schemas/SearchCriteria' complianceLevel: type: string description: 'Compliance level to define the preservation quality based on data file format: - NOT_ASSESSED => The format could not be evaluated - NO_COMPLIANCE => The format could not be determined - WEAK_COMPLIANCE => The format was determined: content type detected - AVERAGE_COMPLIANCE => The format was determined: WEAK_COMPLIANCE + PRONOM identifier detected - FULL_COMPLIANCE => The format was determined: AVERAGE_COMPLIANCE + the format is part of golden formats ' enum: - NOT_ASSESSED - NO_COMPLIANCE - WEAK_COMPLIANCE - AVERAGE_COMPLIANCE - FULL_COMPLIANCE dataCategory: type: string enum: - Primary - Observational - Experimental - Simulation - Derived - Reference - Digitalized - Secondary - Publication - DataPaper - Documentation - Software - Code - Binaries - VirtualMachine - Administrative - Document - WebSite - Other - Package - InformationPackage - UpdatePackage - Metadata - CustomMetadata - UpdatedMetadata - Internal - DatasetThumbnail - ArchiveThumbnail - ArchiveReadme - DatafileThumbnail - ArchiveDataUseAgreement dataType: type: string enum: - Primary - Observational - Experimental - Simulation - Derived - Reference - Digitalized - Secondary - Publication - DataPaper - Documentation - Software - Code - Binaries - VirtualMachine - Administrative - Document - WebSite - Other - Package - InformationPackage - UpdatePackage - Metadata - CustomMetadata - UpdatedMetadata - Internal - DatasetThumbnail - ArchiveThumbnail - ArchiveReadme - DatafileThumbnail - ArchiveDataUseAgreement fileFormat: $ref: '#/components/schemas/FileFormat' fileSize: type: integer format: int64 finalData: type: string format: uri fileName: type: string readOnly: true metadataType: $ref: '#/components/schemas/MetadataType' relativeLocation: type: string maxLength: 460 minLength: 0 pattern: (^\/$)|(^\/.*(?<!\/)$) sourceData: type: string format: uri status: type: string enum: - CHANGE_RELATIVE_LOCATION - CHANGE_DATA_CATEGORY - CLEANED - CLEANING - EXCLUDED_FILE - CHECK_COMPLIANCE - CHECK_COMPLIANCE_CLEANED - CHECKED_COMPLIANCE - CHECKED_COMPLIANCE_CLEANED - IGNORED_FILE - DOWNLOAD_IN_PROGRESS - FILE_FORMAT_IDENTIFIED - FILE_FORMAT_SKIPPED - FILE_FORMAT_UNKNOWN - IN_ERROR - PROCESSED - READY - RECEIVED - TO_PROCESS - VIRUS_CHECKED - VIRUS_SKIPPED statusMessage: type: string maxLength: 1024 minLength: 0 virusCheck: $ref: '#/components/schemas/VirusCheck' checksums: type: array items: $ref: '#/components/schemas/DataFileChecksum' infoPackage: $ref: '#/components/schemas/Deposit' inProgress: type: boolean fileStatus: type: string enum: - CHANGE_RELATIVE_LOCATION - CHANGE_DATA_CATEGORY - CLEANED - CLEANING - EXCLUDED_FILE - CHECK_COMPLIANCE - CHECK_COMPLIANCE_CLEANED - CHECKED_COMPLIANCE - CHECKED_COMPLIANCE_CLEANED - IGNORED_FILE - DOWNLOAD_IN_PROGRESS - FILE_FORMAT_IDENTIFIED - FILE_FORMAT_SKIPPED - FILE_FORMAT_UNKNOWN - IN_ERROR - PROCESSED - READY - RECEIVED - TO_PROCESS - VIRUS_CHECKED - VIRUS_SKIPPED writeOnly: true smartSize: type: string readOnly: true fullFileName: type: string readOnly: true _links: $ref: '#/components/schemas/Links' RestCollectionDeposit: type: object description: 'The structure of the REST response: - data: the list of objects - page: the pagination information - links: the HATEOAS links - facets: the search information ' 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' SubmissionInfoPackage: type: object description: Submission Information Package (SIP) properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 dispositionApproval: type: boolean description: If the approval step the AIP disposal is mandatory. retention: type: integer format: int32 description: 'The retention duration in days of the AIP: O means forever.' mainStorage: type: integer format: int32 description: The main storage indice in configuration if the SIP. O means default storage (first one). aipId: type: string description: The generated AIP identifier of the SIP. maxLength: 50 minLength: 0 depositId: type: string description: The source deposit identifier of the SIP. maxLength: 50 minLength: 0 info: $ref: '#/components/schemas/RepresentationInfo' description: The OAIS representation information of the SIP. organizationalUnit: $ref: '#/components/schemas/OrganizationalUnit' description: The organizational unit object of the SIP. submissionPolicy: $ref: '#/components/schemas/SubmissionPolicy' description: The submission policy object of the SIP. readOnly: true submissionPolicyId: type: string description: The submission policy identifier of the SIP. maxLength: 50 minLength: 0 publicationDate: type: string format: date description: The publication date of the deposit. organizationalUnitId: type: string description: The organizational unit identifier of the SIP. ready: type: boolean description: If SIP package is ready. readOnly: true dataFileNumber: type: integer format: int32 description: The number of SIP data files. readOnly: true collectionSize: type: integer format: int32 description: The number of AIPs in collection AIP. readOnly: true packageStatus: type: string description: 'OAIS Package Status: - CHECKED => Checked package during archiving process - CHECKING => A package verification is in progress during checking process - CHECK_PENDING => A package verification is pending during checking process - CLEANED => Cleaned package during cleaning process for SIP only - CLEANING => A package clean is in progress during cleaning process for SIP only - COMPLIANCE_LEVEL_UPDATE_PENDING => A package compliance update is pending - COMPLIANCE_LEVEL_UPDATED => The compliance levels of the package have been updated - COMPLETED => Completed package - DISPOSABLE => The Package is candidate for disposal process for AIP only - DISPOSAL_APPROVED_BY_ORGUNIT => Disposal org. unit approval done during disposal process for AIP only - DISPOSAL_APPROVED => Disposal approval done during disposal process for AIP only - DISPOSED => Disposed package for AIP only - DOWNLOADING => A package download is in progress - EDITING_METADATA => A package metadata edition is in progress - FIXING => A package correction is in progress - FIXITY_ERROR => Error when checking checksums - FIX_PENDING => A package correction is pending - INDEXING => A package indexing is in progress - IN_ERROR => Package in error during archiving process - IN_PREPARATION => Package in preparation during archiving process - IN_PROGRESS => A package archiving process is in progress - METADATA_EDITION_PENDING => A metadata edition is pending - METADATA_UPGRADE_PENDING => A metadata version upgrade is pending - PACKAGE_REPLICATION_PENDING => A package replication is pending - PRESERVATION_ERROR => Package in error during checking process - READY => Package Ready - REINDEXING => A package re-indexing is in progress - RELOADED => Reloaded package from storage location - REPLICATING_PACKAGE => A package replication is in progress - REPLICATING_TOMBSTONE => A tombstone package replication is in progress - RESUBMITTING => A package re-submission is in progress - STORED => Package stored on storage location - TOMBSTONE_REPLICATION_PENDING => A tombstone replication is pending - UPDATING_COMPLIANCE_LEVEL => A package compliance update is in progress - UPDATING_RETENTION => A package retention update is in progress during disposal process - UPGRADING_METADATA => A metadata version upgrade is in progress ' enum: - CHECK_PENDING - CHECKING - CHECKED - CLEANING - CLEANED - COMPLETED - DOWNLOADING - IN_PREPARATION - IN_PROGRESS - STORED - INDEXING - READY - RETRIEVING - RETRIEVING_PENDING - IN_ERROR - PRESERVATION_ERROR - FIXITY_ERROR - DISPOSABLE - DISPOSAL_APPROVED_BY_ORGUNIT - DISPOSAL_APPROVED - DISPOSED - FIX_PENDING - FIXING - METADATA_EDITION_PENDING - EDITING_METADATA - UPDATING_RETENTION - METADATA_UPGRADE_PENDING - UPGRADING_METADATA - COMPLIANCE_LEVEL_UPDATE_PENDING - UPDATING_COMPLIANCE_LEVEL - COMPLIANCE_LEVEL_UPDATED - REINDEXING - RELOADED - RESUBMITTING - PACKAGE_REPLICATION_PENDING - REPLICATING_PACKAGE - TOMBSTONE_REPLICATION_PENDING - REPLICATING_TOMBSTONE writeOnly: true smartRetention: type: string description: The retention duration in human-readable format of the package. readOnly: true _links: $ref: '#/components/schemas/Links' SipDataFile: type: object properties: creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' resId: type: string description: The identifier of the resource. The default format is a Universally Unique IDentifier (UUID). maxLength: 50 minLength: 0 searchCriterias: type: array items: $ref: '#/components/schemas/SearchCriteria' complianceLevel: type: string description: 'Compliance level to define the preservation quality based on data file format: - NOT_ASSESSED => The format could not be evaluated - NO_COMPLIANCE => The format could not be determined - WEAK_COMPLIANCE => The format was determined: content type detected - AVERAGE_COMPLIANCE => The format was determined: WEAK_COMPLIANCE + PRONOM identifier detected - FULL_COMPLIANCE => The format was determined: AVERAGE_COMPLIANCE + the format is part of golden formats ' enum: - NOT_ASSESSED - NO_COMPLIANCE - WEAK_COMPLIANCE - AVERAGE_COMPLIANCE - FULL_COMPLIANCE dataCategory: type: string enum: - Primary - Observational - Experimental - Simulation - Derived - Reference - Digitalized - Secondary - Publication - DataPaper - Documentation - Software - Code - Binaries - VirtualMachine - Administrative - Document - WebSite - Other - Package - InformationPackage - UpdatePackage - Metadata - CustomMetadata - UpdatedMetadata - Internal - DatasetThumbnail - ArchiveThumbnail - ArchiveReadme - DatafileThumbnail - ArchiveDataUseAgreement dataType: type: string enum: - Primary - Observational - Experimental - Simulation - Derived - Reference - Digitalized - Secondary - Publication - DataPaper - Documentation - Software - Code - Binaries - VirtualMachine - Administrative - Document - WebSite - Other - Package - InformationPackage - UpdatePackage - Metadata - CustomMetadata - UpdatedMetadata - Internal - DatasetThumbnail - ArchiveThumbnail - ArchiveReadme - DatafileThumbnail - ArchiveDataUseAgreement fileFormat: $ref: '#/components/schemas/FileFormat' fileSize: type: integer format: int64 finalData: type: string format: uri fileName: type: string readOnly: true metadataType: $ref: '#/components/schemas/MetadataType' relativeLocation: type: string maxLength: 460 minLength: 0 pattern: (^\/$)|(^\/.*(?<!\/)$) sourceData: type: string format: uri status: type: string enum: - CHANGE_RELATIVE_LOCATION - CHANGE_DATA_CATEGORY - CLEANED - CLEANING - EXCLUDED_FILE - CHECK_COMPLIANCE - CHECK_COMPLIANCE_CLEANED - CHECKED_COMPLIANCE - CHECKED_COMPLIANCE_CLEANED - IGNORED_FILE - DOWNLOAD_IN_PROGRESS - FILE_FORMAT_IDENTIFIED - FILE_FORMAT_SKIPPED - FILE_FORMAT_UNKNOWN - IN_ERROR - PROCESSED - READY - RECEIVED - TO_PROCESS - VIRUS_CHECKED - VIRUS_SKIPPED statusMessage: type: string maxLength: 1024 minLength: 0 virusCheck: $ref: '#/components/schemas/VirusCheck' checksums: type: array items: $ref: '#/components/schemas/DataFileChecksum' infoPackage: $ref: '#/components/schemas/SubmissionInfoPackage' inProgress: type: boolean fileStatus: type: string enum: - CHANGE_RELATIVE_LOCATION - CHANGE_DATA_CATEGORY - CLEANED - CLEANING - EXCLUDED_FILE - CHECK_COMPLIANCE - CHECK_COMPLIANCE_CLEANED - CHECKED_COMPLIANCE - CHECKED_COMPLIANCE_CLEANED - IGNORED_FILE - DOWNLOAD_IN_PROGRESS - FILE_FORMAT_IDENTIFIED - FILE_FORMAT_SKIPPED - FILE_FORMAT_UNKNOWN - IN_ERROR - PROCESSED - READY - RECEIVED - TO_PROCESS - VIRUS_CHECKED - VIRUS_SKIPPED writeOnly: true smartSize: type: string readOnly: true fullFileName: type: string readOnly: true _links: $ref: '#/components/schemas/Links' RestCollectionSubmissionInfoPackage: type: object description: 'The structure of the REST response: - data: the list of objects - page: the pagination information - links: the HATEOAS links - facets: the search information ' properties: _links: $ref: '#/components/schemas/Links' _data: type: array items: $ref: '#/components/schemas/SubmissionInfoPackage' _facets: type: array items: $ref: '#/components/schemas/FacetResult' _page: $ref: '#/components/schemas/RestCollectionPage' RestCollectionSubmissionAgreement: type: object description: 'The structure of the REST response: - data: the list of objects - page: the pagination information - links: the HATEOAS links - facets: the search information ' 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' RestCollectionSubjectArea: type: object description: 'The structure of the REST response: - data: the list of objects - page: the pagination information - links: the HATEOAS links - facets: the search information ' 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' RestCollectionLicense: type: object description: 'The structure of the REST response: - data: the list of objects - page: the pagination information - links: the HATEOAS links - facets: the search information ' 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' RestCollectionDepositDataFile: type: object description: 'The structure of the REST response: - data: the list of objects - page: the pagination information - links: the HATEOAS links - facets: the search information ' 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' RestCollectionPerson: type: object description: 'The structure of the REST response: - data: the list of objects - page: the pagination information - links: the HATEOAS links - facets: the search information ' 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' FileList: type: object properties: files: type: array items: type: string puids: type: array items: type: string Contributor: type: object description: Contributors are people who are involved in archives. properties: resId: type: string depositNumber: type: integer format: int32 description: The deposit number of the contributor. fullName: type: string creation: $ref: '#/components/schemas/ChangeInfo' lastUpdate: $ref: '#/components/schemas/ChangeInfo' firstName: type: string lastName: type: string orcid: type: string verifiedOrcid: type: boolean avatar: $ref: '#/components/schemas/PersonAvatar' _links: $ref: '#/components/schemas/Links' RestCollectionContributor: type: object description: 'The structure of the REST response: - data: the list of objects - page: the pagination information - links: the HATEOAS links - facets: the search information ' 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' 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: {} RestCollectionSipDataFile: type: object description: 'The structure of the REST response: - data: the list of objects - page: the pagination information - links: the HATEOAS links - facets: the search information ' properties: _links: $ref: '#/components/schemas/Links' _data: type: array items: $ref: '#/components/schemas/SipDataFile' _facets: type: array items: $ref: '#/components/schemas/FacetResult' _page: $ref: '#/components/schemas/RestCollectionPage'