--- openapi: 3.1.0 components: schemas: AuthenticatedUserDisplayInfo: type: object description: "Display profile for an authenticated user, including name, contact,\ \ affiliation, position, and ORCID information." properties: title: type: string emailAddress: type: string affiliation: type: string lastName: type: string pattern: \S firstName: type: string pattern: \S position: type: string orcid: type: string orcidForDisplay: type: string required: - lastName - firstName AuthenticationProviderRow: description: "Persisted authentication provider configuration, including provider\ \ id, display text, factory alias, enabled state, and factory data." type: object properties: id: type: string title: type: string subtitle: type: string factoryAlias: type: string enabled: type: boolean factoryData: type: string BuiltinUser: description: Built-in Dataverse user account payload used for local username and password authentication. type: object properties: id: type: integer format: int64 userName: type: string pattern: "[a-zA-Z0-9\\_\\-\\.]*" minLength: 2 maxLength: 60 passwordEncryptionVersion: type: integer format: int32 passwordResetData: $ref: "#/components/schemas/PasswordResetData" encryptedPassword: type: string email: type: string firstName: type: string lastName: type: string affiliation: type: string position: type: string displayInfoForApiCreation: type: object deprecated: true $ref: "#/components/schemas/AuthenticatedUserDisplayInfo" required: - userName CustomTermsDTO: description: "Custom dataset terms of access payload, including use terms, restrictions,\ \ citation requirements, conditions, and disclaimer text." type: object properties: termsOfUse: type: string confidentialityDeclaration: type: string specialPermissions: type: string restrictions: type: string citationRequirements: type: string depositorRequirements: type: string conditions: type: string disclaimer: type: string DType: description: "Dataverse object type discriminator for dataverses, datasets,\ \ and data files." type: string enum: - Dataverse - Dataset - DataFile ExplicitGroupDTO: description: "Explicit group update payload with display name, description,\ \ and owner-local alias." type: object properties: description: type: string displayName: type: string aliasInOwner: type: string LicenseUpdateRequest: description: Dataset or template license update payload with either a license name or custom terms. type: object properties: name: type: string customTerms: $ref: "#/components/schemas/CustomTermsDTO" PasswordResetData: type: object description: Password reset token data used during built-in user account recovery and password compliance flows. properties: id: type: integer format: int64 token: type: string created: type: object expires: type: object reason: $ref: "#/components/schemas/Reason1" expired: type: boolean Reason: description: Dataset lock reason indicating why dataset editing or publication is blocked. type: string enum: - Ingest - Workflow - InReview - DcmUpload - GlobusUpload - finalizePublication - EditInProgress - FileValidationFailed Reason1: description: Reason a password reset token was created. type: string enum: - FORGOT_PASSWORD - NON_COMPLIANT_PASSWORD - UPGRADE_REQUIRED RoleAssignmentDTO: description: Role assignment payload identifying the assignee and the role alias. type: object properties: assignee: type: string role: type: string RoleDTO: description: "Dataverse role definition payload with alias, display name, description,\ \ owner, and permissions." type: object properties: alias: type: string name: type: string description: type: string ownerId: type: string permissions: type: array items: type: string securitySchemes: DataverseApiKey: type: apiKey in: header name: X-Dataverse-key description: Dataverse API token. tags: - name: Access description: "Download files, bundles, citations, metadata, and access-related file\ \ assets." - name: Admin description: Administrative Dataverse operations. - name: Dataset Fields description: "Dataset field type, controlled vocabulary, and metadata block loading\ \ operations." - name: Datasets description: "Dataset metadata, versions, files, and publishing operations." - name: Dataverse Featured Items description: Manage featured items displayed on dataverse pages. - name: Dataverses description: "Dataverse collection metadata, datasets, roles, groups, links, templates,\ \ storage, and featured content." - name: External Tools description: External tool registration and lookup operations. - name: Files description: "Data file metadata, upload, replacement, and editing operations." - name: Guestbooks description: Guestbook definitions and guestbook response operations. - name: Info description: General information about the Dataverse installation. - name: Licenses description: License lookup and administration operations. - name: Metadata description: Metadata block and metadata export operations. - name: Notifications description: User notification lookup and notification preference operations. - name: Roles description: Role definition and role selection operations. - name: Search description: Search and search service discovery operations. - name: Users description: User-specific data discovery and collection access operations. - name: Workflows description: Workflow administration operations. - name: addFileToDataset description: Uploads a file for a dataset - name: addFilesToDataset description: Uploads a set of files to a dataset - name: addGlobusFilesToDataset description: Uploads a Globus file for a dataset - name: replaceFilesInDataset description: Replace a file to a dataset - name: saveAuxiliaryFileWithVersion description: Save Auxiliary File With Version - name: uploadDatasetLogo description: Uploads a logo for a dataset paths: /access/datafile/bundle/{fileId}: post: summary: Submit guestbook response for a file bundle description: Records the supplied guestbook response and then streams the ZIP bundle for a data file. operationId: Access_datafileBundleWithGuestbookResponse tags: - Access parameters: - description: Data file id or persistent identifier for the bundle. required: true name: fileId in: path schema: type: string - description: File metadata id used to select a specific file metadata record. name: fileMetadataId in: query schema: type: integer format: int64 - description: Whether guestbook records have already been written for this download. name: gbrecs in: query schema: type: boolean - description: Guestbook response id list supplied by the user interface. name: gbrids in: query schema: type: string requestBody: description: Guestbook response JSON for the requested data file. content: '*/*': schema: type: string required: true responses: "200": description: "ZIP archive containing the data file bundle, citation files,\ \ and available metadata." content: application/zip: schema: type: string format: binary security: - DataverseApiKey: [] get: summary: Build a file bundle description: "Streams a ZIP bundle for a data file, including citation exports\ \ and optional tabular metadata when available." operationId: Access_datafileBundle tags: - Access parameters: - description: Data file id or persistent identifier for the bundle. required: true name: fileId in: path schema: type: string - description: File metadata id used to select a specific file metadata record. name: fileMetadataId in: query schema: type: integer format: int64 - description: Whether guestbook records have already been written for this download. name: gbrecs in: query schema: type: boolean - description: Guestbook response id list supplied by the user interface. name: gbrids in: query schema: type: string responses: "200": description: "ZIP archive containing the data file bundle, citation files,\ \ and available metadata." content: application/zip: schema: type: string format: binary security: - DataverseApiKey: [] /access/datafile/{fileId}: post: summary: Submit guestbook response for a data file description: Records the supplied guestbook response and returns access details for a data file download. operationId: Access_datafileWithGuestbookResponse tags: - Access parameters: - description: "Data file id, persistent identifier, or path-style file reference." required: true name: fileId in: path schema: type: string pattern: .+ - description: Whether guestbook records have already been written for this download. name: gbrecs in: query schema: type: boolean requestBody: description: Guestbook response JSON for the requested data file. content: '*/*': schema: type: string required: true responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] get: summary: Downloads a data file description: Streams the requested data file after validating access and guestbook requirements. operationId: Access_datafile tags: - Access parameters: - description: "Data file id, persistent identifier, or path-style file reference." required: true name: fileId in: path schema: type: string pattern: .+ - description: Whether guestbook records have already been written for this download. name: gbrecs in: query schema: type: boolean - description: Guestbook response id list supplied by the user interface. name: gbrids in: query schema: type: string responses: "200": description: OK content: application/xml: {} '*/*': {} security: - DataverseApiKey: [] /access/datafile/{fileId}/auxiliary: get: summary: Lists auxiliary files description: Lists auxiliary files associated with the requested data file. operationId: Access_listDatafileMetadataAux tags: - Access parameters: - description: Data file id or persistent identifier. required: true name: fileId in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /access/datafile/{fileId}/auxiliary/{formatTag}/{formatVersion}: post: summary: Save auxiliary file with version description: Saves an auxiliary file operationId: Access_saveAuxiliaryFileWithVersion tags: - saveAuxiliaryFileWithVersion parameters: - description: Data file id for the auxiliary file. required: true name: fileId in: path schema: type: integer format: int64 - description: Auxiliary file format tag. required: true name: formatTag in: path schema: type: string - description: Auxiliary file format version. required: true name: formatVersion in: path schema: type: string requestBody: description: Multipart auxiliary file content and metadata to store for the data file format version. content: multipart/form-data: schema: type: string required: true responses: "200": description: File saved response content: application/json: schema: {} "403": description: User not authorized to edit the dataset. "400": description: File not found based on id. security: - DataverseApiKey: [] get: summary: Downloads an auxiliary file description: Streams the requested auxiliary file format version after validating file access. operationId: Access_downloadAuxiliaryFile tags: - Access parameters: - description: Data file id or persistent identifier. required: true name: fileId in: path schema: type: string - description: Auxiliary file format tag. required: true name: formatTag in: path schema: type: string - description: Auxiliary file format version. required: true name: formatVersion in: path schema: type: string responses: "200": description: Auxiliary file bytes for the requested data file format. content: application/octet-stream: schema: type: string format: binary security: - DataverseApiKey: [] delete: summary: Deletes an auxiliary file description: Deletes the requested auxiliary file format version after validating edit permissions. operationId: Access_deleteAuxiliaryFileWithVersion tags: - Access parameters: - description: Data file id for the auxiliary file. required: true name: fileId in: path schema: type: integer format: int64 - description: Auxiliary file format tag. required: true name: formatTag in: path schema: type: string - description: Auxiliary file format version. required: true name: formatVersion in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /access/datafile/{fileId}/auxiliary/{origin}: get: summary: Lists auxiliary files by origin description: Lists auxiliary files associated with the requested data file and origin. operationId: Access_listDatafileMetadataAuxByOrigin tags: - Access parameters: - description: Data file id or persistent identifier. required: true name: fileId in: path schema: type: string - description: Auxiliary file origin to match. required: true name: origin in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /access/datafile/{fileId}/citation/{format}: get: summary: Returns a data file citation description: Formats the requested data file citation in the selected citation format after validating access. operationId: Access_datafileCitation tags: - Access parameters: - description: Data file id or persistent identifier. required: true name: fileId in: path schema: type: string - description: Citation format to return. name: format in: path required: true schema: type: string - description: "Dataset version, such as 1.0, :draft, :latest, or :latest-published.\ \ If omitted, uses :latest." required: false name: version in: query schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /access/datafile/{fileId}/metadata: get: summary: Export tabular file metadata description: Streams tabular data file metadata in the default DDI XML format. operationId: Access_tabularDatafileMetadata tags: - Access parameters: - description: Data file id or persistent identifier for the tabular file. required: true name: fileId in: path schema: type: string - description: Comma-separated metadata sections to exclude from the export. name: exclude in: query schema: type: string - description: File metadata id used to select a specific file metadata record. name: fileMetadataId in: query schema: type: integer format: int64 - description: Comma-separated metadata sections to include in the export. name: include in: query schema: type: string responses: "200": description: OK content: text/xml: schema: type: string security: - DataverseApiKey: [] /access/datafile/{fileId}/metadata/ddi: get: summary: Export tabular file metadata as DDI description: Streams DDI XML metadata for a tabular data file. operationId: Access_tabularDatafileMetadataDDI tags: - Access parameters: - description: Data file id or persistent identifier for the tabular file. required: true name: fileId in: path schema: type: string - description: Comma-separated metadata sections to exclude from the export. name: exclude in: query schema: type: string - description: File metadata id used to select a specific file metadata record. name: fileMetadataId in: query schema: type: integer format: int64 - description: Comma-separated metadata sections to include in the export. name: include in: query schema: type: string responses: "200": description: OK content: text/xml: schema: type: string security: - DataverseApiKey: [] /access/datafile/{id}/grantAccess/{identifier}: put: summary: Grants access to a data file description: Assigns the file downloader role to the requested assignee for a restricted data file. operationId: Access_grantFileAccess tags: - Access parameters: - description: Restricted data file id or persistent identifier. required: true name: id in: path schema: type: string - description: User or group identifier receiving file access. required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /access/datafile/{id}/listRequests: get: summary: Lists data file access requests description: Lists active or historical access requests for a restricted data file. operationId: Access_listFileAccessRequests tags: - Access parameters: - description: Restricted data file id or persistent identifier. required: true name: id in: path schema: type: string - description: Includes historical access requests when true. name: includeHistory in: query schema: type: boolean - description: Number of historical access requests to include per page. name: per_page in: query schema: type: integer format: int32 - description: Pagination offset for historical access requests. name: start in: query schema: type: integer format: int32 responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /access/datafile/{id}/rejectAccess/{identifier}: put: summary: Rejects a data file access request description: Rejects the requested assignee's access request for a restricted data file. operationId: Access_rejectFileAccess tags: - Access parameters: - description: Restricted data file id or persistent identifier. required: true name: id in: path schema: type: string - description: User or group identifier whose access request is rejected. required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /access/datafile/{id}/requestAccess: put: summary: Requests access to a restricted data file description: Creates a file access request for the authenticated user when requests are accepted and access has not already been granted. operationId: Access_requestFileAccess tags: - Access parameters: - description: Restricted data file id or persistent identifier. required: true name: id in: path schema: type: string requestBody: description: Optional guestbook response JSON submitted with the access request. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /access/datafile/{id}/revokeAccess/{identifier}: delete: summary: Revokes access to a restricted data file description: Removes the file downloader role from the requested assignee for a restricted data file. operationId: Access_revokeFileAccess tags: - Access parameters: - description: Restricted data file id or persistent identifier. required: true name: id in: path schema: type: string - description: User or group identifier losing file access. required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /access/datafile/{id}/userFileAccessRequested: get: summary: Checks whether file access was requested description: Returns whether the authenticated user has an access request recorded for the restricted data file. operationId: Access_getUserFileAccessRequested tags: - Access parameters: - description: Restricted data file id or persistent identifier. required: true name: id in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /access/datafile/{id}/userPermissions: get: summary: Returns current user file permissions description: "Returns booleans indicating whether the current user may download\ \ the file, manage file permissions, or edit the owner dataset." operationId: Access_getUserPermissionsOnFile tags: - Access parameters: - description: Data file id or persistent identifier. required: true name: id in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /access/datafiles: post: summary: Stream a ZIP for selected files description: Accepts a text list of data file ids and streams the selected files as a ZIP archive. operationId: Access_postDownloadDatafiles tags: - Access parameters: - description: Whether guestbook records have already been written for this download. name: gbrecs in: query schema: type: boolean - description: Guestbook response id list supplied by the user interface. name: gbrids in: query schema: type: string requestBody: description: Text list of data file ids to include in the ZIP archive. content: text/plain: schema: type: string required: true responses: "200": description: OK content: application/zip: {} security: - DataverseApiKey: [] /access/datafiles/{fileIds}: post: summary: Submit guestbook response for selected data files description: Records a guestbook response and prepares a ZIP download for the selected data files. operationId: Access_datafilesWithGuestbookResponse tags: - Access parameters: - description: Comma-separated data file ids to include in the ZIP archive. required: true name: fileIds in: path schema: type: string - description: Whether guestbook records have already been written for this download. name: gbrecs in: query schema: type: boolean requestBody: description: Guestbook response JSON for the selected data file download. content: '*/*': schema: type: string required: true responses: "200": description: Signed URL details for downloading the selected data files. content: application/json: {} security: - DataverseApiKey: [] get: summary: Downloads selected data files description: Streams a ZIP archive containing the selected data files after validating access and guestbook requirements. operationId: Access_datafiles tags: - Access parameters: - description: Comma-separated data file ids to include in the ZIP archive. required: true name: fileIds in: path schema: type: string - description: Whether guestbook records have already been written for this download. name: gbrecs in: query schema: type: boolean - description: Guestbook response id list supplied by the user interface. name: gbrids in: query schema: type: string responses: "200": description: ZIP archive containing the selected data files. content: application/zip: schema: format: binary type: string security: - DataverseApiKey: [] /access/dataset/{id}: post: summary: Submit guestbook response for latest dataset files description: Records a guestbook response and prepares a ZIP download for files in the latest accessible dataset version. operationId: Access_downloadAllFromLatestWithGuestbookResponse tags: - Access parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string - description: Whether guestbook records have already been written for this download. name: gbrecs in: query schema: type: boolean requestBody: description: Guestbook response JSON for the dataset file download. content: '*/*': schema: type: string required: true responses: "200": description: OK content: application/zip: {} security: - DataverseApiKey: [] get: summary: Downloads files from the latest dataset version description: "Streams a ZIP archive containing files from the draft version\ \ when the requester may view it, otherwise from the latest released version." operationId: Access_downloadAllFromLatest tags: - Access parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string - description: Whether guestbook records have already been written for this download. name: gbrecs in: query schema: type: boolean - description: Guestbook response id list supplied by the user interface. name: gbrids in: query schema: type: string responses: "200": description: ZIP archive containing files from the latest accessible dataset version. content: application/zip: schema: format: binary type: string security: - DataverseApiKey: [] /access/dataset/{id}/versions/{versionId}: post: summary: Submit guestbook response for dataset version files description: Records a guestbook response and prepares a ZIP download for files in the requested dataset version. operationId: Access_downloadAllFromVersionWithGuestbookResponse tags: - Access parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string - description: "Dataset version selector, such as draft, latest, latest-published,\ \ or a version number." required: true name: versionId in: path schema: type: string - description: Whether guestbook records have already been written for this download. name: gbrecs in: query schema: type: boolean - description: Legacy API token query value. name: key in: query schema: type: string requestBody: description: Guestbook response JSON for the dataset version file download. content: '*/*': schema: type: string required: true responses: "200": description: Signed URL details for downloading the requested dataset version files. content: application/json: {} security: - DataverseApiKey: [] get: summary: Downloads files from a dataset version description: Streams a ZIP archive containing files from the requested dataset version after resolving version aliases such as draft or latest-published. operationId: Access_downloadAllFromVersion tags: - Access parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string - description: "Dataset version selector, such as draft, latest, latest-published,\ \ or a version number." required: true name: versionId in: path schema: type: string - description: Whether guestbook records have already been written for this download. name: gbrecs in: query schema: type: boolean - description: Guestbook response id list supplied by the user interface. name: gbrids in: query schema: type: string - description: Legacy API token query value. name: key in: query schema: type: string - description: Whether the request URL was signed. name: signed in: query schema: type: boolean responses: "200": description: ZIP archive containing files from the requested dataset version. content: application/zip: schema: format: binary type: string security: - DataverseApiKey: [] /access/dataverseFeaturedItemImage/{itemId}: get: summary: Returns a featured item image description: Returns the image file associated with a dataverse featured item when the requester may view the item. operationId: Access_getDataverseFeatureItemImage tags: - Access parameters: - description: Dataverse featured item id. required: true name: itemId in: path schema: type: integer format: int64 responses: "200": description: PNG image associated with the dataverse featured item. content: image/png: schema: format: binary type: string security: - DataverseApiKey: [] /access/dvCardImage/{dataverseId}: get: summary: Returns a dataverse card image description: Returns a thumbnail image generated from the dataverse logo when one is configured. operationId: Access_dvCardImage tags: - Access parameters: - description: Dataverse id used to locate the card image. required: true name: dataverseId in: path schema: type: integer format: int64 responses: "200": description: PNG thumbnail image for the dataverse. content: image/png: schema: format: binary type: string security: - DataverseApiKey: [] /access/fileCardImage/{fileId}: get: summary: Returns a data file card image description: Returns a generated thumbnail image for a data file when the file type supports thumbnail generation. operationId: Access_fileCardImage tags: - Access parameters: - description: Data file id used to locate the card image. required: true name: fileId in: path schema: type: integer format: int64 responses: "200": description: PNG thumbnail image for the data file. content: image/png: schema: format: binary type: string security: - DataverseApiKey: [] /access/{id}/allowAccessRequest: put: summary: Updates dataset file access request settings description: Enables or disables file access requests for the dataset terms in the editable dataset version. operationId: Access_allowAccessRequest tags: - Access parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string requestBody: description: Boolean value indicating whether file access requests are allowed. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /admin/archiveAllUnarchivedDatasetVersions: post: summary: Archive unarchived dataset versions description: Lists or starts archival submission for published dataset versions that do not yet have archival copies. operationId: Admin_archiveAllUnarchivedDatasetVersions tags: - Admin parameters: - description: "When true, include only each dataset's latest version for archival\ \ submission." name: latestonly in: query schema: type: boolean - description: Maximum number of dataset versions to list or submit. name: limit in: query schema: type: integer format: int32 - description: "When true, list matching dataset versions without submitting\ \ them." name: listonly in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /admin/assignee/{idtf}: get: summary: Read a role assignee description: Returns display information for a role assignee identifier. operationId: Admin_findRoleAssignee tags: - Admin parameters: - description: Role assignee identifier. required: true name: idtf in: path schema: type: string responses: "200": description: OK content: '*/*': {} /admin/assignments/assignees/{raIdtf}: get: summary: Enumerate assignments for a role assignee description: Lists role assignments held by the supplied role assignee identifier. operationId: Admin_getAssignmentsFor tags: - Admin parameters: - description: Role assignee identifier. required: true name: raIdtf in: path schema: type: string pattern: .* responses: "200": description: OK content: '*/*': {} /admin/authenticatedUsers: get: summary: Enumerate authenticated users description: Lists all authenticated users for a superuser. deprecated: true operationId: Admin_listAuthenticatedUsers tags: - Admin responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] post: summary: Create an authenticated user description: "Creates an authenticated user account from provider id, persistent\ \ id, identifier, name, and email fields." operationId: Admin_createAuthenicatedUser tags: - Admin requestBody: description: "User creation JSON containing authenticationProviderId, persistentUserId,\ \ identifier, firstName, lastName, and email." content: '*/*': schema: type: object required: true responses: "200": description: OK content: '*/*': {} /admin/authenticatedUsers/convert/builtin2oauth: put: summary: Convert a built-in user to a remote account description: Converts a built-in authenticated user to a remote account using colon-separated conversion data. operationId: Admin_builtin2oauth tags: - Admin requestBody: description: "Colon-separated email, password, replacement email, provider\ \ id, and persistent user id values." content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /admin/authenticatedUsers/convert/builtin2shib: put: summary: Convert a built-in user to a Shibboleth account description: Converts a built-in authenticated user to a Shibboleth account using colon-separated conversion data. operationId: Admin_builtin2shib tags: - Admin requestBody: description: "Colon-separated email, password, and replacement email values\ \ for the conversion." content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /admin/authenticatedUsers/id/{id}: delete: summary: Remove an authenticated user by id description: Deletes an authenticated user by database id after checking that the account can be safely removed. operationId: Admin_deleteAuthenticatedUserById tags: - Admin parameters: - description: Authenticated user database id. required: true name: id in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} /admin/authenticatedUsers/id/{id}/convertRemoteToBuiltIn: put: summary: Convert a remote user to a built-in account description: Converts a remote authenticated user to a built-in account using a new email address. operationId: Admin_convertOAuthUserToBuiltin tags: - Admin parameters: - description: Authenticated user database id. required: true name: id in: path schema: type: integer format: int64 requestBody: description: Email address for the converted built-in account. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /admin/authenticatedUsers/id/{id}/convertShibToBuiltIn: put: summary: Convert a Shibboleth user to a built-in account description: Converts a remote Shibboleth authenticated user to a built-in account using a new email address. deprecated: true operationId: Admin_convertShibUserToBuiltin tags: - Admin parameters: - description: Authenticated user database id. required: true name: id in: path schema: type: integer format: int64 requestBody: description: Email address for the converted built-in account. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /admin/authenticatedUsers/id/{id}/deactivate: post: summary: Deactivate an authenticated user by id description: Disables an authenticated user account by database id. operationId: Admin_deactivateAuthenticatedUserById tags: - Admin parameters: - description: Authenticated user database id. required: true name: id in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} /admin/authenticatedUsers/{identifier}: get: summary: Read an authenticated user description: Returns account details for an authenticated user identifier. operationId: Admin_getAuthenticatedUserByIdentifier tags: - Admin parameters: - description: Authenticated user identifier. required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} delete: summary: Remove an authenticated user description: Deletes an authenticated user after checking that the account can be safely removed. operationId: Admin_deleteAuthenticatedUser tags: - Admin parameters: - description: Authenticated user identifier. required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} /admin/authenticatedUsers/{identifier}/deactivate: post: summary: Deactivate an authenticated user description: Disables an authenticated user account by identifier. operationId: Admin_deactivateAuthenticatedUser tags: - Admin parameters: - description: Authenticated user identifier. required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} /admin/authenticationProviderFactories: get: summary: Enumerate authentication provider factories description: Lists authentication provider factory aliases and provider information. operationId: Admin_listAuthProviderFactories tags: - Admin responses: "200": description: OK content: '*/*': {} /admin/authenticationProviders: get: summary: Enumerate authentication providers description: Lists registered authentication provider rows. operationId: Admin_listAuthProviders tags: - Admin responses: "200": description: OK content: '*/*': {} post: summary: Register an authentication provider description: Creates or updates an authentication provider row and registers the provider when it is enabled. operationId: Admin_addProvider tags: - Admin requestBody: description: "Authentication provider row, including id, factory alias, enabled\ \ state, and factory configuration." content: '*/*': schema: $ref: "#/components/schemas/AuthenticationProviderRow" required: true responses: "200": description: OK content: '*/*': {} /admin/authenticationProviders/{id}: get: summary: Read an authentication provider description: Returns the registered authentication provider row for the supplied provider id. operationId: Admin_showProvider tags: - Admin parameters: - description: Authentication provider id. required: true name: id in: path schema: type: string responses: "200": description: OK content: '*/*': {} delete: summary: Remove an authentication provider description: Deletes an authentication provider row and deregisters the provider. operationId: Admin_deleteAuthenticationProvider tags: - Admin parameters: - description: Authentication provider id. required: true name: id in: path schema: type: string responses: "200": description: OK content: '*/*': {} /admin/authenticationProviders/{id}/:enabled: post: summary: Set authentication provider enabled state through the deprecated route description: Enables or disables an authentication provider using the legacy route. operationId: Admin_enableAuthenticationProvider_deprecated tags: - Admin parameters: - description: Authentication provider id. required: true name: id in: path schema: type: string requestBody: description: Boolean value indicating whether the provider should be enabled. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} /admin/authenticationProviders/{id}/enabled: put: summary: Switch authentication provider enabled state description: Enables or disables a registered authentication provider. operationId: Admin_enableAuthenticationProvider tags: - Admin parameters: - description: Authentication provider id. required: true name: id in: path schema: type: string requestBody: description: Boolean value indicating whether the provider should be enabled. content: '*/*': schema: type: string required: true responses: "200": description: OK content: application/json: schema: {} get: summary: Check authentication provider enabled state description: Returns whether a registered authentication provider is enabled. operationId: Admin_checkAuthenticationProviderEnabled tags: - Admin parameters: - description: Authentication provider id. required: true name: id in: path schema: type: string responses: "200": description: OK content: '*/*': {} /admin/bannerMessage: get: summary: Enumerate banner messages description: Lists banner message ids and display values. operationId: Admin_getBannerMessages tags: - Admin responses: "200": description: OK content: '*/*': {} post: summary: Publish a banner message description: Creates an active banner message with localized message text. operationId: Admin_addBannerMessage tags: - Admin requestBody: description: Banner message JSON containing dismissibleByUser and messageTexts entries. content: '*/*': schema: type: object required: true responses: "200": description: OK content: '*/*': {} /admin/bannerMessage/{id}: delete: summary: Remove a banner message description: Deletes a banner message by database id. operationId: Admin_deleteBannerMessage tags: - Admin parameters: - description: Banner message database id. required: true name: id in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} /admin/bannerMessage/{id}/deactivate: put: summary: Deactivate a banner message description: Marks a banner message inactive by database id. operationId: Admin_deactivateBannerMessage tags: - Admin parameters: - description: Banner message database id. required: true name: id in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} /admin/batch/jobs: get: summary: Lists batch jobs description: Returns JSON containing the execution records for all known batch job instances. operationId: BatchJobResource_listBatchJobs tags: - Admin responses: "200": description: OK content: application/json: schema: {} /admin/batch/jobs/name/{jobName}: get: summary: Lists batch jobs by name description: Returns JSON containing execution records for batch job instances with the specified job name. operationId: BatchJobResource_listBatchJobsByName tags: - Admin parameters: - description: Batch job name used to select job instances. required: true name: jobName in: path schema: type: string responses: "200": description: OK content: application/json: schema: {} /admin/batch/jobs/{jobId}: get: summary: Returns a batch job execution description: Returns the execution record for the specified batch job execution id as JSON. operationId: BatchJobResource_listBatchJobById tags: - Admin parameters: - description: Numeric batch job execution id. required: true name: jobId in: path schema: type: string responses: "200": description: OK content: application/json: schema: {} /admin/clearMetricsCache: delete: summary: Clear all metrics cache entries description: Deletes every cached metric row. operationId: Admin_clearMetricsCache tags: - Admin responses: "200": description: OK content: '*/*': {} /admin/clearMetricsCache/{name}: delete: summary: Clear metrics cache entries by name description: Deletes cached metric rows with the supplied metric name. operationId: Admin_clearMetricsCacheByName tags: - Admin parameters: - description: Metric cache name to clear. required: true name: name in: path schema: type: string responses: "200": description: OK content: '*/*': {} /admin/clearThumbnailFailureFlag: delete: summary: Clear all thumbnail failure flags description: Resets thumbnail preview failure flags for all dataverse objects. operationId: Admin_clearThumbnailFailureFlag tags: - Admin responses: "200": description: OK content: '*/*': {} /admin/clearThumbnailFailureFlag/{id}: delete: summary: Clear a data file thumbnail failure flag description: Resets the thumbnail preview failure flag for one data file. operationId: Admin_clearThumbnailFailureFlagByDatafile tags: - Admin parameters: - description: Data file id or persistent identifier. required: true name: id in: path schema: type: string responses: "200": description: OK content: '*/*': {} /admin/computeDataFileHashValue/{fileId}/algorithm/{alg}: post: summary: Compute a data file hash value description: Calculates a new checksum for one non-harvested data file using the requested algorithm and saves it on the file. operationId: Admin_computeDataFileHashValue tags: - Admin parameters: - description: Checksum algorithm to calculate. required: true name: alg in: path schema: type: string - description: Data file id or persistent identifier. required: true name: fileId in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /admin/confirmEmail/{userId}: post: summary: Start confirm-email processing description: Creates confirm-email data for an authenticated user and returns token metadata. operationId: Admin_startConfirmEmailProcess tags: - Admin parameters: - description: Authenticated user database id. required: true name: userId in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} get: summary: Read a confirm-email token description: Returns the active confirm-email token for an authenticated user. operationId: Admin_getConfirmEmailToken tags: - Admin parameters: - description: Authenticated user database id. required: true name: userId in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} /admin/convertUserFromBcryptToSha1: post: summary: Convert a test built-in password hash description: Rewrites a built-in user's password hash to the legacy SHA-1 test value. operationId: Admin_convertUserFromBcryptToSha1 tags: - Admin requestBody: description: JSON object containing builtinUserId. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} /admin/datafiles/auditFiles: get: summary: Audit dataset file storage description: Checks selected datasets for missing physical files and missing file metadata. operationId: Admin_getAuditFiles tags: - Admin parameters: - description: Comma-separated dataset persistent identifiers to audit instead of an id range. name: datasetIdentifierList in: query schema: type: string - description: Lowest dataset database id to audit. name: firstId in: query schema: type: integer format: int64 - description: Highest dataset database id to audit. name: lastId in: query schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /admin/datafiles/integrity/fixmissingoriginalsizes: get: summary: Repair missing original file sizes description: Starts a background repair for tabular files missing original file size metadata. operationId: Admin_fixMissingOriginalSizes tags: - Admin parameters: - description: Maximum number of affected files to repair. name: limit in: query schema: type: integer format: int32 responses: "200": description: OK content: '*/*': {} /admin/datafiles/integrity/fixmissingoriginaltypes: get: summary: Repair missing original file types description: Starts a background repair for tabular files missing original file type metadata. operationId: Admin_fixMissingOriginalTypes tags: - Admin responses: "200": description: OK content: '*/*': {} /admin/datasetfield: get: summary: Lists dataset field groupings description: "Returns dataset field type names grouped by parent relationship,\ \ multiplicity, and required status." operationId: DatasetFieldServiceApi_getAll tags: - Dataset Fields responses: "200": description: OK content: '*/*': {} /admin/datasetfield/controlledVocabulary/subject: get: summary: Lists subject vocabulary values description: Returns the configured controlled vocabulary display values for the subject dataset field. operationId: DatasetFieldServiceApi_showControlledVocabularyForSubject tags: - Dataset Fields responses: "200": description: OK content: '*/*': {} /admin/datasetfield/load: post: summary: Loads dataset field definitions description: "Reads tab-separated metadata block, dataset field, and controlled\ \ vocabulary definitions from the uploaded file path and creates or updates\ \ those definitions." operationId: DatasetFieldServiceApi_loadDatasetFields tags: - Dataset Fields requestBody: description: "Tab-separated definitions for metadata blocks, dataset fields,\ \ and controlled vocabulary values." content: text/tab-separated-values: schema: type: string format: binary required: true responses: "200": description: OK content: '*/*': {} /admin/datasetfield/loadNAControlledVocabularyValue: get: summary: Creates the N/A controlled vocabulary value description: Creates the global N/A controlled vocabulary value when it is missing and reports whether it was created or already existed. operationId: DatasetFieldServiceApi_loadNAControlledVocabularyValue tags: - Dataset Fields responses: "200": description: OK content: '*/*': {} /admin/datasetfield/loadpropertyfiles: post: summary: Loads language property files description: Extracts uploaded language property files into the configured Dataverse language directory while rejecting ZIP entries outside that directory. operationId: DatasetFieldServiceApi_loadLanguagePropertyFile tags: - Dataset Fields requestBody: description: ZIP archive containing language property files to extract. content: application/zip: schema: type: string format: binary required: true responses: "200": description: OK content: '*/*': {} /admin/datasetfield/setDisplayOnCreate: post: summary: Sets dataset field create-page display description: Updates whether the specified dataset field type is displayed on the dataset creation page. operationId: DatasetFieldServiceApi_setDisplayOnCreate tags: - Dataset Fields parameters: - description: Dataset field type name to update. required: true name: datasetFieldType in: query schema: type: string - description: New display-on-create setting for the dataset field type. required: true name: setDisplayOnCreate in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} /admin/datasetfield/{name}: get: summary: Returns a dataset field type description: "Returns a dataset field type with metadata block, Solr field names,\ \ parent relationship, multiplicity, required state, URI, and controlled vocabulary\ \ values." operationId: DatasetFieldServiceApi_getByName tags: - Dataset Fields parameters: - description: Dataset field type name to return. required: true name: name in: path schema: type: string responses: "200": description: OK content: '*/*': {} /admin/datasets/integrity/{datasetVersionId}/fixmissingunf: post: summary: Repair missing UNF values description: Recalculates missing UNF values for a dataset version. operationId: Admin_fixUnf tags: - Admin parameters: - description: Dataset version database id. required: true name: datasetVersionId in: path schema: type: string - description: "When true, recalculate UNF values even when existing values\ \ are present." name: forceRecalculate in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} /admin/datasets/thumbnailMetadata/{id}: get: summary: Read dataset thumbnail metadata description: Returns thumbnail selection metadata and optional thumbnail image data for a dataset. operationId: Admin_getDatasetThumbnailMetadata tags: - Admin parameters: - description: Dataset database id. required: true name: id in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} /admin/dataverse/curationLabelSets: get: summary: Enumerate curation label sets description: Lists configured curation label sets and their labels. operationId: Admin_listCurationLabelSets tags: - Admin responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /admin/dataverse/{alias}/addRoleAssignmentsToChildren: get: summary: Propagate dataverse role assignments to children description: Copies configured inherited role assignments from a dataverse to its child dataverses and datasets. operationId: Admin_addRoleAssignementsToChildren tags: - Admin parameters: - description: Dataverse alias whose child objects receive role assignments. required: true name: alias in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /admin/dataverse/{alias}/curationLabelSet: put: summary: Assign a dataverse curation label set description: Assigns a configured curation label set name to a dataverse. operationId: Admin_setCurationLabelSet tags: - Admin parameters: - description: Dataverse alias. required: true name: alias in: path schema: type: string - description: Configured curation label set name. name: name in: query schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Reset a dataverse curation label set description: Restores a dataverse to the default curation label set setting. operationId: Admin_resetCurationLabelSet tags: - Admin parameters: - description: Dataverse alias. required: true name: alias in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] get: summary: Returns a dataverse curation label set description: Returns the curation label set configured on a dataverse when the requester is a superuser. operationId: Admin_getCurationLabelSet tags: - Admin parameters: - description: Dataverse alias. name: alias in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /admin/downloadTmpFile: get: summary: Download a temporary file description: Streams a file from the local /tmp directory for superuser testing. operationId: Admin_downloadTmpFile tags: - Admin parameters: - description: Absolute path under /tmp to stream. name: fullyQualifiedPathToFile in: query schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /admin/externalTools: get: summary: Lists external tools description: Returns all registered external tools as JSON. operationId: ExternalTools_getExternalTools tags: - External Tools responses: "200": description: OK content: '*/*': {} post: summary: Registers an external tool description: "Parses an external tool manifest, saves the tool definition, and\ \ returns the saved tool as JSON." operationId: ExternalTools_addExternalTool tags: - External Tools requestBody: description: External tool manifest JSON to parse and register. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} /admin/externalTools/{id}: get: summary: Returns an external tool description: Returns the registered external tool with the specified numeric id. operationId: ExternalTools_getExternalTool tags: - External Tools parameters: - description: Numeric id of the external tool to return. required: true name: id in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} delete: summary: Deletes an external tool description: Deletes the registered external tool with the specified numeric id. operationId: ExternalTools_deleteExternalTool tags: - External Tools parameters: - description: Numeric id of the external tool to delete. required: true name: id in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} /admin/featureFlags: get: summary: Enumerate feature flags description: Lists feature flag names with enabled or disabled status. operationId: Admin_getFeatureFlags tags: - Admin responses: "200": description: OK content: '*/*': {} /admin/featureFlags/{flag}: get: summary: Read a feature flag description: Returns enabled status for one feature flag. operationId: Admin_getFeatureFlag tags: - Admin parameters: - description: Feature flag enum name. required: true name: flag in: path schema: type: string responses: "200": description: OK content: '*/*': {} /admin/feedback: post: summary: Submits administrative feedback description: Sends a feedback email to contacts for a target object or to the support address when no target is supplied. operationId: FeedbackApi_submitFeedback tags: - Admin requestBody: description: "Feedback JSON with subject, body, sender email, and an optional\ \ target object id." content: '*/*': schema: type: object required: true responses: "200": description: OK content: '*/*': {} /admin/groups/domain: get: summary: Lists mail-domain groups description: Returns all global mail-domain groups as JSON. operationId: Groups_listMailDomainGroups tags: - Admin responses: "200": description: OK content: '*/*': {} post: summary: Creates a mail-domain group description: Creates a global mail-domain group from the supplied JSON and refreshes mail-domain group membership. operationId: Groups_createMailDomainGroup tags: - Admin requestBody: description: Mail-domain group definition with alias and domain matching rules. content: '*/*': schema: type: object required: true responses: "200": description: OK content: '*/*': {} /admin/groups/domain/{groupAlias}: put: summary: Creates or replaces a mail-domain group description: Creates or replaces a global mail-domain group with the specified alias and refreshes mail-domain group membership. operationId: Groups_updateMailDomainGroups tags: - Admin parameters: - description: Mail-domain group alias to create or replace. required: true name: groupAlias in: path schema: type: string requestBody: description: Mail-domain group definition with domain matching rules. content: '*/*': schema: type: object required: true responses: "200": description: OK content: '*/*': {} get: summary: Returns a mail-domain group description: Returns the global mail-domain group with the specified alias. operationId: Groups_getMailDomainGroup tags: - Admin parameters: - description: Mail-domain group alias to return. required: true name: groupAlias in: path schema: type: string responses: "200": description: OK content: '*/*': {} delete: summary: Deletes a mail-domain group description: Deletes the global mail-domain group with the specified alias and refreshes mail-domain group membership. operationId: Groups_deleteMailDomainGroup tags: - Admin parameters: - description: Mail-domain group alias to delete. required: true name: groupAlias in: path schema: type: string responses: "200": description: OK content: '*/*': {} /admin/groups/ip: post: summary: Creates an IP group description: Creates a global IP group from the supplied JSON and assigns an available persisted group alias. operationId: Groups_postIpGroup tags: - Admin requestBody: description: IP group definition with alias and IP address ranges. content: '*/*': schema: type: object required: true responses: "200": description: OK content: '*/*': {} get: summary: Lists IP groups description: Returns all global IP groups as JSON. operationId: Groups_listIpGroups tags: - Admin responses: "200": description: OK content: '*/*': {} /admin/groups/ip/{group}: put: summary: Creates or replaces an IP group description: Creates or replaces a global IP group with the specified group alias. operationId: Groups_putIpGroups tags: - Admin parameters: - description: IP group alias to create or replace. required: true name: group in: path schema: type: string requestBody: description: IP group definition with IP address ranges. content: '*/*': schema: type: object required: true responses: "200": description: OK content: '*/*': {} get: summary: Returns an IP group description: Returns a global IP group identified by numeric id or alias. operationId: Groups_getIpGroup tags: - Admin parameters: - description: IP group numeric id or alias. required: true name: group in: path schema: type: string responses: "200": description: OK content: '*/*': {} delete: summary: Deletes an IP group description: Deletes a global IP group identified by numeric id or alias. operationId: Groups_deleteIpGroup tags: - Admin parameters: - description: IP group numeric id or alias. required: true name: group in: path schema: type: string responses: "200": description: OK content: '*/*': {} /admin/groups/shib: get: summary: Lists Shibboleth groups description: Returns all global Shibboleth groups as JSON. operationId: Groups_listShibGroups tags: - Admin responses: "200": description: OK content: '*/*': {} post: summary: Creates a Shibboleth group description: "Creates a Shibboleth group from name, attribute, and pattern values\ \ in the supplied JSON." operationId: Groups_createShibGroup tags: - Admin requestBody: description: "Shibboleth group JSON containing name, attribute, and pattern." content: '*/*': schema: type: object required: true responses: "200": description: OK content: '*/*': {} /admin/groups/shib/{primaryKey}: delete: summary: Deletes a Shibboleth group description: Deletes the Shibboleth group with the specified primary key. operationId: Groups_deleteShibGroup tags: - Admin parameters: - description: Primary key of the Shibboleth group to delete. required: true name: primaryKey in: path schema: type: string responses: "200": description: OK content: '*/*': {} /admin/index: get: summary: Starts indexing all content description: "Starts indexing all dataverses and datasets or one selected partition,\ \ with an option to preview the selected workload." operationId: Index_indexAllOrSubset tags: - Admin parameters: - description: Number of index partitions to divide the workload into. name: numPartitions in: query schema: type: integer format: int64 - description: Partition id to process when the workload is divided into partitions. name: partitionIdToProcess in: query schema: type: integer format: int64 - description: Preview the selected indexing workload without starting indexing. name: previewOnly in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} /admin/index/clear: get: summary: Clears the Solr index description: Clears all Solr documents and resets stored index timestamps. operationId: Index_clearSolrIndex tags: - Admin responses: "200": description: OK content: '*/*': {} /admin/index/clear-orphans: get: summary: Clears orphaned index documents description: Removes Solr documents that no longer correspond to database records. operationId: Index_clearOrphans tags: - Admin parameters: - description: Whether to run the indexing task synchronously. name: sync in: query schema: type: string responses: "200": description: OK content: '*/*': {} /admin/index/continue: get: summary: Continues indexing unindexed content description: "Starts indexing one selected partition while skipping content\ \ that has already been indexed, with an option to preview the selected workload." operationId: Index_indexAllOrSubsetContinue tags: - Admin parameters: - description: Number of index partitions to divide the workload into. name: numPartitions in: query schema: type: integer format: int64 - description: Partition id to process when the workload is divided into partitions. name: partitionIdToProcess in: query schema: type: integer format: int64 - description: Preview the selected indexing workload without starting indexing. name: previewOnly in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} /admin/index/dataset: get: summary: Starts indexing a dataset by PID description: "Looks up a dataset by persistent identifier, starts dataset indexing,\ \ and returns version identifiers for the dataset." operationId: Index_indexDatasetByPersistentId tags: - Admin parameters: - description: Persistent identifier of the dataset to index. required: true name: persistentId in: query schema: type: string responses: "200": description: OK content: '*/*': {} /admin/index/datasets/{id}: delete: summary: Clears a dataset from the Solr index description: "Removes the Solr document for the specified dataset id, even when\ \ the dataset no longer exists in the database." operationId: Index_clearDatasetFromIndex tags: - Admin parameters: - description: Numeric id of the dataset to remove from Solr. required: true name: id in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} /admin/index/filemetadata/{dataset_id}: get: summary: Lists file metadata by dataset version description: Returns file metadata rows for a dataset version with optional result limit and sorting. operationId: Index_getFileMetadataByDatasetId tags: - Admin parameters: - description: Dataset id. name: dataset_id in: path required: true schema: type: integer format: int64 - description: Maximum number of results to return. name: maxResults in: query schema: type: integer format: int32 - description: Sort order. name: order in: query schema: type: string - description: Sort field. name: sort in: query schema: type: string responses: "200": description: OK content: '*/*': {} /admin/index/filesearch: get: summary: Searches files in a dataset description: "Searches files within a dataset and returns file search results,\ \ facets, filters, and dataset version context." operationId: Index_filesearch tags: - Admin parameters: - description: Persistent identifier. name: persistentId in: query schema: type: string - description: Search query string. name: q in: query schema: type: string - description: Semantic version filter. name: semanticVersion in: query schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /admin/index/mod: get: summary: Tests index partition assignment description: Returns the object ids assigned to an indexing partition for a requested partition count and partition number. operationId: Index_indexMod tags: - Admin parameters: - description: Number of indexing partitions. name: partitions in: query schema: type: integer format: int64 - description: Indexing partition to process. name: which in: query schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} /admin/index/perms: post: summary: Indexes all permissions description: Rebuilds Solr permission documents for all indexed dataverse objects. operationId: Index_indexAllPermissions tags: - Admin responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /admin/index/perms/{id}: post: summary: Indexes permissions for an object description: Rebuilds Solr permission documents for one dataverse object. operationId: Index_indexPermissions tags: - Admin parameters: - description: Resource id name: id in: path required: true schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /admin/index/permsDebug: get: summary: Returns permission index debug data description: "Returns Solr permission document, timestamp, and role assignment\ \ data for one dataverse object." operationId: Index_searchPermsDebug tags: - Admin parameters: - description: Resource id or persistent identifier. name: id in: query schema: type: integer format: int64 - description: Legacy API token query value. name: key in: query schema: type: string responses: "200": description: OK content: '*/*': {} /admin/index/solr/schema: get: summary: Returns the Solr schema description: Generates the Solr schema definition from configured dataset field types. operationId: Index_getSolrSchema tags: - Admin responses: "200": description: OK content: '*/*': schema: type: string /admin/index/status: get: summary: Checks index status description: Checks consistency between the database and Solr index and returns status by content type. operationId: Index_indexStatus tags: - Admin parameters: - description: Whether to run the indexing task synchronously. name: sync in: query schema: type: string responses: "200": description: OK content: '*/*': {} /admin/index/test: get: summary: Runs a search debug query description: Runs a search debug query for integration testing and returns matching result labels. operationId: Index_searchDebug tags: - Admin parameters: - description: Filter query. name: fq in: query schema: type: array items: type: string - description: Legacy API token query value. name: key in: query schema: type: string - description: Search query string. name: q in: query schema: type: string responses: "200": description: OK content: '*/*': {} /admin/index/timestamps: delete: summary: Clears all index timestamps description: Clears index timestamp fields for all dataverse objects. operationId: Index_deleteAllTimestamps tags: - Admin responses: "200": description: OK content: '*/*': {} /admin/index/timestamps/{dvObjectId}: delete: summary: Clears an index timestamp description: Clears index timestamp fields for one dataverse object. operationId: Index_deleteTimestamp tags: - Admin parameters: - description: Dataverse object id. name: dvObjectId in: path required: true schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} /admin/index/{type}/{id}: get: summary: Starts indexing one object description: "Starts reindexing a dataverse, dataset, or file by numeric id,\ \ or removes a stale Solr document when the object is missing." operationId: Index_indexTypeById tags: - Admin parameters: - description: Numeric id of the object to index. required: true name: id in: path schema: type: integer format: int64 - description: "Object type to index: dataverses, datasets, or files." required: true name: type in: path schema: type: string responses: "200": description: OK content: '*/*': {} /admin/isOrcid: get: summary: Check ORCID authentication support description: Returns whether ORCID authentication is enabled. operationId: Admin_isOrcidEnabled tags: - Admin responses: "200": description: OK content: '*/*': {} /admin/list-users: get: summary: Search authenticated users description: Searches authenticated users for the dashboard user list and returns paged JSON results. operationId: Admin_filterAuthenticatedUsers tags: - Admin parameters: - description: Number of users to include on each page. name: itemsPerPage in: query schema: type: integer format: int32 - description: Search text matched against authenticated users. name: searchTerm in: query schema: type: string - description: One-based result page to return. name: selectedPage in: query schema: type: integer format: int32 - description: Sort field used for the user list. name: sortKey in: query schema: type: string responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /admin/makeDataCount/addUsageMetricsFromSushiReport: post: summary: Adds usage metrics from a SUSHI report for all datasets description: "Parses a SUSHI report from disk, saves usage metrics for all datasets\ \ represented in the report, and reports completion." operationId: MakeDataCountApi_addUsageMetricsFromSushiReportAll tags: - Admin parameters: - description: Server-side path to the SUSHI report JSON file. required: true name: reportOnDisk in: query schema: type: string responses: "200": description: OK content: '*/*': {} /admin/makeDataCount/sendToHub: post: summary: Reports Make Data Count hub submission description: Returns a confirmation message for Make Data Count hub submission. operationId: MakeDataCountApi_sendDataToHub tags: - Admin responses: "200": description: OK content: '*/*': {} /admin/makeDataCount/{id}/addUsageMetricsFromSushiReport: post: summary: Adds usage metrics from a SUSHI report description: "Parses a SUSHI report from disk, saves usage metrics for the specified\ \ dataset, and reports completion." operationId: MakeDataCountApi_addUsageMetricsFromSushiReport tags: - Admin parameters: - description: Dataset id or persistent identifier that receives the usage metrics. required: true name: id in: path schema: type: string - description: Server-side path to the SUSHI report JSON file. required: true name: reportOnDisk in: query schema: type: string responses: "200": description: OK content: '*/*': {} /admin/makeDataCount/{id}/updateCitationsForDataset: post: summary: Queues citation updates for a dataset description: Validates that the dataset uses a DataCite DOI provider and queues a background citation update from DataCite EventData. operationId: MakeDataCountApi_updateCitationsForDataset tags: - Admin parameters: - description: Dataset id or persistent identifier whose citation metrics are updated. required: true name: id in: path schema: type: string responses: "200": description: OK content: '*/*': {} /admin/makeDataCount/{yearMonth}/processingState: post: summary: Sets Make Data Count processing state description: Creates or updates the processing state for the specified year and month. operationId: MakeDataCountApi_updateProcessingState tags: - Admin parameters: - description: "Year and month for the processing state, formatted as YYYY-MM." required: true name: yearMonth in: path schema: type: string - description: Server name associated with the processing state. name: server in: query schema: type: string - description: Processing state value to store. required: true name: state in: query schema: type: string responses: "200": description: OK content: '*/*': {} get: summary: Returns Make Data Count processing state description: "Returns the processing state, state-change timestamp, and server\ \ for the specified year and month." operationId: MakeDataCountApi_getProcessingState tags: - Admin parameters: - description: "Year and month for the processing state, formatted as YYYY-MM." required: true name: yearMonth in: path schema: type: string responses: "200": description: OK content: '*/*': {} delete: summary: Deletes Make Data Count processing state description: Deletes the processing state for the specified year and month. operationId: MakeDataCountApi_deleteProcessingState tags: - Admin parameters: - description: "Year and month for the processing state, formatted as YYYY-MM." required: true name: yearMonth in: path schema: type: string responses: "200": description: OK content: '*/*': {} /admin/metadata/clearExportTimestamps: get: summary: Clears metadata export timestamps description: Clears stored metadata export timestamps for all datasets without deleting cached metadata export files. operationId: Metadata_clearExportTimestamps tags: - Admin responses: "200": description: OK content: '*/*': {} /admin/metadata/exportAll: get: summary: Starts metadata export jobs description: Starts background exports for published local datasets that have not been exported since their last publication. operationId: Metadata_exportAll tags: - Admin responses: "200": description: OK content: application/json: schema: {} /admin/metadata/exportOAI/{specname}: put: summary: Starts an OAI set export description: Marks the specified OAI set as updating and starts its metadata export in the background. operationId: Metadata_exportOaiSet tags: - Admin parameters: - description: OAI set specification name to export. required: true name: specname in: path schema: type: string responses: "200": description: OK content: '*/*': {} /admin/metadata/reExportAll: get: summary: Starts metadata re-export jobs description: "Starts background re-export jobs for published local datasets,\ \ optionally limited to datasets older than a supplied date." operationId: Metadata_reExportAll tags: - Admin parameters: - name: formats in: query schema: type: string - description: Optional cutoff date in YYYY-MM-DD format for selecting datasets to re-export. name: olderThan in: query schema: type: string responses: "200": description: OK content: application/json: schema: {} /admin/metadata/{id}/reExportDataset: get: summary: Starts a dataset metadata re-export description: Starts a background metadata re-export for the specified dataset. operationId: Metadata_exportDatasetByPersistentId tags: - Admin parameters: - description: Dataset id or persistent identifier to re-export. required: true name: id in: path schema: type: string - name: formats in: query schema: type: string responses: "200": description: OK content: '*/*': {} /admin/permissions/{dvo}: get: summary: Inspect permissions on a Dataverse object description: Returns the requesting user's permissions on the selected dataverse object. operationId: Admin_findPermissonsOn tags: - Admin parameters: - description: Dataverse object id or persistent identifier. required: true name: dvo in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /admin/publishDataverseAsCreator/{id}: post: summary: Publish a dataverse as its creator description: Publishes a dataverse using the dataverse creator as the request user. operationId: Admin_publishDataverseAsCreator tags: - Admin parameters: - description: Dataverse database id. required: true name: id in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} /admin/rateLimitStats: get: summary: Download rate-limit statistics description: Streams cached rate-limit statistics as CSV for a superuser. operationId: Admin_rateLimitStats tags: - Admin parameters: - description: Limit statistics to entries within this many minutes. name: deltaMinutesFilter in: query schema: type: integer format: int64 responses: "200": description: OK content: text/csv: {} security: - DataverseApiKey: [] /admin/registerDataFileAll: get: summary: Process PID assignment for all eligible data files description: "Scans all data files and assigns persistent identifiers to released,\ \ unregistered files in collections where file PIDs are enabled." operationId: Admin_registerDataFileAll tags: - Admin responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /admin/registerDataFiles/{alias}: get: summary: Process PID assignment for collection data files description: "Assigns persistent identifiers to released, unregistered files\ \ directly owned by a collection." operationId: Admin_registerDataFilesInCollection tags: - Admin parameters: - description: Dataverse alias for the collection whose files are processed. required: true name: alias in: path schema: type: string - description: Seconds to wait between file registration attempts. name: sleep in: query schema: type: integer format: int32 responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /admin/requestSignedUrl: post: summary: Sign a URL description: Creates a signed URL for a supplied URL and optional user token context. operationId: Admin_getSignedUrl tags: - Admin requestBody: description: "JSON object containing url, optional user identifier, timeout,\ \ HTTP method, and optional credential key." content: application/json: schema: type: object required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /admin/roles: get: summary: Enumerate built-in roles description: Lists built-in Dataverse roles. operationId: Admin_listBuiltinRoles tags: - Admin responses: "200": description: OK content: '*/*': {} post: summary: Create a built-in role description: Creates a built-in Dataverse role from the supplied role definition. operationId: Admin_createNewBuiltinRole tags: - Admin requestBody: description: "Role definition containing alias, name, description, and permissions." content: '*/*': schema: $ref: "#/components/schemas/RoleDTO" required: true responses: "200": description: OK content: '*/*': {} /admin/roles/{id}: put: summary: Revise a built-in role description: Updates an existing built-in Dataverse role from the supplied role definition. operationId: Admin_updateBuiltinRole tags: - Admin parameters: - description: Role database id. required: true name: id in: path schema: type: integer format: int64 requestBody: description: "Updated role definition containing alias, name, description,\ \ and permissions." content: '*/*': schema: $ref: "#/components/schemas/RoleDTO" required: true responses: "200": description: OK content: '*/*': {} delete: summary: Remove a built-in role description: Deletes a Dataverse role by id or alias. operationId: Admin_deleteRole tags: - Admin parameters: - description: Role id or alias. required: true name: id in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /admin/savedsearches: get: summary: Lists saved-search endpoints description: Returns a simple list of supported saved-search administration endpoint patterns. operationId: SavedSearches_meta tags: - Admin responses: "200": description: OK content: '*/*': {} post: summary: Creates a saved search description: "Creates a saved search from query, creator id, definition point\ \ id, and optional filter queries." operationId: SavedSearches_add tags: - Admin requestBody: description: "Saved-search JSON containing creatorId, query, definitionPointId,\ \ and optional filterQueries." content: '*/*': schema: type: object required: true responses: "200": description: OK content: '*/*': {} /admin/savedsearches/list: get: summary: Lists saved searches description: "Returns all saved searches with query, filter queries, id, definition\ \ point, and creator id." operationId: SavedSearches_list tags: - Admin responses: "200": description: OK content: '*/*': {} /admin/savedsearches/makelinks/all: put: summary: Creates links for all saved searches description: Processes all saved searches and creates links for matching results. operationId: SavedSearches_makeLinksForAllSavedSearches tags: - Admin parameters: - description: Include debug information in the link creation response. name: debug in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} /admin/savedsearches/makelinks/{id}: put: summary: Creates links for a saved search description: Processes one saved search and creates links for matching results. operationId: SavedSearches_makeLinksForSingleSavedSearch tags: - Admin parameters: - description: Numeric id of the saved search to process. required: true name: id in: path schema: type: integer format: int64 - description: Include debug information in the link creation response. name: debug in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} /admin/savedsearches/{id}: get: summary: Returns a saved search description: "Returns one saved search with query, filter queries, id, definition\ \ point, and creator id." operationId: SavedSearches_show tags: - Admin parameters: - description: Numeric id of the saved search to return. required: true name: id in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} delete: summary: Deletes a saved search description: Deletes the specified saved search and optionally unlinks generated links. operationId: SavedSearches_delete tags: - Admin parameters: - description: Numeric id of the saved search to delete. required: true name: id in: path schema: type: integer format: int64 - description: Remove links created from the saved search. name: unlink in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} /admin/settings: put: summary: Replace database settings description: Creates or replaces multiple Dataverse database settings from a JSON object. operationId: Admin_putAllSettings tags: - Admin requestBody: description: JSON object whose keys are setting names and whose values are setting values. content: application/json: schema: type: object required: true responses: "200": description: All database options successfully updated content: '*/*': {} get: summary: Enumerate database settings description: Lists all Dataverse database settings as a JSON object. operationId: Admin_listAllSettings tags: - Admin responses: "200": description: All database options successfully queried content: {} /admin/settings/{name}: put: summary: Store a database setting description: Creates or replaces a Dataverse database setting value. operationId: Admin_putSetting tags: - Admin parameters: - description: Database setting name. required: true name: name in: path schema: type: string requestBody: description: Setting value to store. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} get: summary: Read a database setting description: Returns the value for a Dataverse database setting. operationId: Admin_getSettingByName tags: - Admin parameters: - description: Database setting name. required: true name: name in: path schema: type: string responses: "200": description: OK content: '*/*': {} delete: summary: Remove a database setting description: Deletes a Dataverse database setting by name. operationId: Admin_deleteSetting tags: - Admin parameters: - description: Database setting name. required: true name: name in: path schema: type: string responses: "200": description: OK content: '*/*': {} /admin/settings/{name}/lang/{lang}: put: summary: Store a localized database setting description: Creates or replaces a language-specific Dataverse database setting value. operationId: Admin_putSettingLang tags: - Admin parameters: - description: Language code for the localized value. required: true name: lang in: path schema: type: string - description: Database setting name. required: true name: name in: path schema: type: string requestBody: description: Localized setting value to store. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} get: summary: Read a localized database setting description: Returns the language-specific value for a Dataverse database setting. operationId: Admin_getLocalizedSetting tags: - Admin parameters: - description: Language code for the localized value. required: true name: lang in: path schema: type: string - description: Database setting name. required: true name: name in: path schema: type: string responses: "200": description: OK content: '*/*': {} delete: summary: Remove a localized database setting description: Deletes a language-specific Dataverse database setting value. operationId: Admin_deleteSettingLang tags: - Admin parameters: - description: Language code for the localized value. required: true name: lang in: path schema: type: string - description: Database setting name. required: true name: name in: path schema: type: string responses: "200": description: OK content: '*/*': {} /admin/sitemap: post: summary: Starts a sitemap update description: Starts regeneration of the site map for all dataverses and datasets when no staged sitemap file is present. operationId: SiteMap_updateSiteMap tags: - Admin responses: "200": description: OK content: application/json: schema: {} /admin/storageSites: get: summary: Lists storage sites description: Returns all configured storage sites as JSON. operationId: StorageSites_listAll tags: - Admin responses: "200": description: OK content: '*/*': {} post: summary: Creates a storage site description: Parses and persists a storage site definition after validating that only one site is primary. operationId: StorageSites_addSite tags: - Admin requestBody: description: Storage site definition to parse and persist. content: '*/*': schema: type: object required: true responses: "200": description: OK content: '*/*': {} /admin/storageSites/{id}: get: summary: Returns a storage site description: Returns the configured storage site with the specified numeric id. operationId: StorageSites_get tags: - Admin parameters: - description: Numeric id of the storage site to return. required: true name: id in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} delete: summary: Deletes a storage site description: Deletes the configured storage site with the specified numeric id. operationId: StorageSites_delete tags: - Admin parameters: - description: Numeric id of the storage site to delete. required: true name: id in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} /admin/storageSites/{id}/primaryStorage: put: summary: Sets primary storage for a site description: Updates the primary-storage flag for the specified storage site after validating the primary-site constraint. operationId: StorageSites_setPrimary tags: - Admin parameters: - description: Numeric id of the storage site to update. required: true name: id in: path schema: type: integer format: int64 requestBody: description: Boolean text indicating whether the storage site is primary. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} /admin/submitDatasetVersionToArchive/{id}/{version}: post: summary: Submit a dataset version to an archive description: Starts archival submission for a dataset version that has not already been archived. operationId: Admin_submitDatasetVersionToArchive tags: - Admin parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string - description: Dataset version number. required: true name: version in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /admin/superuser/{identifier}: post: summary: Toggle superuser status description: Switches an authenticated user between superuser and non-superuser status. deprecated: true operationId: Admin_toggleSuperuser tags: - Admin parameters: - description: Authenticated user identifier. required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} put: summary: Assign superuser status description: Sets whether an authenticated user has superuser privileges. operationId: Admin_setSuperuserStatus tags: - Admin parameters: - description: Authenticated user identifier. required: true name: identifier in: path schema: type: string requestBody: description: Boolean text indicating whether the user should be a superuser. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} /admin/template/{id}: delete: summary: Remove a metadata template description: Deletes a metadata template and clears default-template references that point to it. operationId: Admin_deleteTemplate tags: - Admin parameters: - description: Template database id. required: true name: id in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} /admin/templates: get: summary: Enumerate metadata templates description: "Lists metadata templates with template id, name, and owner information." operationId: Admin_findAllTemplates tags: - Admin responses: "200": description: OK content: '*/*': {} /admin/templates/{alias}: get: summary: Enumerate metadata templates for a dataverse description: Lists metadata templates owned by the dataverse with the supplied alias. operationId: Admin_findTemplates tags: - Admin parameters: - description: Dataverse alias whose templates are listed. required: true name: alias in: path schema: type: string responses: "200": description: OK content: '*/*': {} /admin/updateHashValues/{alg}: get: summary: Updates file hash values description: Recalculates file hash values with the requested algorithm for eligible files when the requester is authorized. operationId: Admin_updateHashValues tags: - Admin parameters: - description: Checksum algorithm. name: alg in: path required: true schema: type: string - description: Maximum number of objects to update. name: num in: query schema: type: integer format: int32 responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /admin/validate/dataset/files/{id}: get: summary: Validate files in one dataset description: Streams checksum validation results for all data files in a dataset. operationId: Admin_validateDatasetDatafiles tags: - Admin parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string responses: "200": description: OK content: application/json: schema: {} /admin/validate/dataset/{id}: get: summary: Validate one dataset description: Validates a dataset and returns either valid status or the first constraint violation. operationId: Admin_validateDataset tags: - Admin parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string - description: Whether to include variable-level validation details. name: variables in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} /admin/validate/datasets: get: summary: Validate all datasets description: Streams validation results for every local dataset. operationId: Admin_validateAllDatasets tags: - Admin parameters: - description: Whether to include variable-level validation details. name: variables in: query schema: type: boolean responses: "200": description: OK content: application/json: schema: {} /admin/validateDataFileHashValue/{fileId}: post: summary: Validate a data file hash value description: Recalculates a data file checksum and compares it with the stored checksum. operationId: Admin_validateDataFileHashValue tags: - Admin parameters: - description: Data file id or persistent identifier. required: true name: fileId in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /admin/validatePassword: post: summary: Validate a password description: Checks a password against the configured password policy and returns validation errors. operationId: Admin_validatePassword tags: - Admin requestBody: description: Password text to validate. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} /admin/workflows: get: summary: Lists workflows description: Returns brief JSON entries for all configured workflows. operationId: WorkflowsAdmin_listWorkflows tags: - Workflows responses: "200": description: OK content: '*/*': {} post: summary: Creates a workflow description: "Parses a workflow definition, saves it, and returns the created\ \ workflow." operationId: WorkflowsAdmin_addWorkflow tags: - Workflows requestBody: description: Workflow definition to parse and persist. content: '*/*': schema: type: object required: true responses: "200": description: OK content: '*/*': {} /admin/workflows/default: get: summary: Lists default workflows description: Returns each workflow trigger type with its configured default workflow or null when no default is set. operationId: WorkflowsAdmin_listDefaults tags: - Workflows responses: "200": description: OK content: '*/*': {} /admin/workflows/default/{triggerType}: put: summary: Sets a default workflow description: Sets the workflow id used by default for the specified workflow trigger type. operationId: WorkflowsAdmin_setDefault tags: - Workflows parameters: - description: Workflow trigger type that receives the default workflow. required: true name: triggerType in: path schema: type: string requestBody: description: Numeric workflow id to use as the default for the trigger type. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} get: summary: Returns a default workflow description: Returns the default workflow configured for the specified trigger type. operationId: WorkflowsAdmin_getDefault tags: - Workflows parameters: - description: Workflow trigger type whose default workflow is requested. required: true name: triggerType in: path schema: type: string responses: "200": description: OK content: '*/*': {} delete: summary: Clears a default workflow description: Removes the default workflow assignment for the specified trigger type. operationId: WorkflowsAdmin_deleteDefault tags: - Workflows parameters: - description: Workflow trigger type whose default assignment is removed. required: true name: triggerType in: path schema: type: string responses: "200": description: OK content: '*/*': {} /admin/workflows/ip-whitelist: put: summary: Sets the workflow IP allowlist description: Validates and stores the semicolon-separated IP addresses allowed to resume external workflow steps. operationId: WorkflowsAdmin_setIpWhitelist tags: - Workflows requestBody: description: Semicolon-separated IP addresses allowed to resume external workflow steps. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} get: summary: Returns the workflow IP allowlist description: Returns the semicolon-separated IP addresses allowed to resume external workflow steps. operationId: WorkflowsAdmin_getIpWhitelist tags: - Workflows responses: "200": description: OK content: '*/*': {} delete: summary: Resets the workflow IP allowlist description: Deletes the configured workflow IP allowlist so the default localhost allowlist is used. operationId: WorkflowsAdmin_deleteIpWhitelist tags: - Workflows responses: "200": description: OK content: '*/*': {} /admin/workflows/{id}: get: summary: Returns a workflow description: Returns the workflow with the specified numeric id. operationId: WorkflowsAdmin_getWorkflow tags: - Workflows parameters: - description: Numeric id of the workflow to return. required: true name: id in: path schema: type: string responses: "200": description: OK content: '*/*': {} delete: summary: Deletes a workflow description: Deletes the workflow with the specified numeric id unless it is configured as a default workflow. operationId: WorkflowsAdmin_deleteWorkflow tags: - Workflows parameters: - description: Numeric id of the workflow to delete. required: true name: id in: path schema: type: string responses: "200": description: OK content: '*/*': {} /admin/{id}/registerDataFile: get: summary: Process PID assignment for a data file description: Attempts persistent identifier assignment for one published data file when file PIDs are enabled. operationId: Admin_registerDataFile tags: - Admin parameters: - description: Data file id or persistent identifier. required: true name: id in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /admin/{id}/reregisterHDLToPID: post: summary: Migrate a dataset handle registration to DOI description: Registers a dataset PID again when migrating a released handle-based dataset to DOI. operationId: Admin_reregisterHdlToPID tags: - Admin parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /batch/harvest: get: summary: Starts a harvest batch import description: Starts a background harvest import from a server-side file or directory into the specified dataverse. operationId: BatchImport_harvest tags: - Admin parameters: - description: Create the target dataverse when it does not exist. name: createDV in: query schema: type: boolean - description: Target dataverse id or alias; defaults to root when omitted. name: dv in: query schema: type: string - description: Server-side file or directory path to import. required: true name: path in: query schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /batch/import: post: summary: Imports a dataset from DDI XML description: Imports a new dataset into the specified dataverse from DDI XML supplied in the request body. operationId: BatchImport_postImport tags: - Admin parameters: - description: Target dataverse id or alias; defaults to root when omitted. name: dv in: query schema: type: string requestBody: description: DDI XML dataset metadata to import as a new dataset. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] get: summary: Starts a dataset batch import description: Starts a background import of one or more datasets from a server-side file or directory into the specified dataverse. operationId: BatchImport_getImport tags: - Admin parameters: - description: Create the target dataverse when it does not exist. name: createDV in: query schema: type: boolean - description: Target dataverse id or alias; defaults to root when omitted. name: dv in: query schema: type: string - description: Server-side file or directory path to import. required: true name: path in: query schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /batch/jobs/import/datasets/files/{identifier}: post: summary: Starts a file-system import job description: Starts a background job that imports files from a server-side upload folder into the specified dataset and returns the job execution id. operationId: FileRecordJobResource_getFilesystemImport tags: - Admin parameters: - description: Dataset id or persistent identifier that receives the imported files. required: true name: identifier in: path schema: type: string - description: Import mode requested for the file-system import job. name: mode in: query schema: type: string default: MERGE - description: Total size in bytes expected for the imported files. name: totalSize in: query schema: type: integer format: int64 - description: Server-side upload folder containing files to import. name: uploadFolder in: query schema: type: string responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /builtin-users: post: summary: Creates a builtin user description: "Creates a builtin user, matching authenticated user, and API token\ \ when the builtin-users management key is valid." operationId: BuiltinUsers_save tags: - Users parameters: - description: Builtin-users management key required to create the account. name: key in: query schema: type: string - description: Password assigned to the builtin user. name: password in: query schema: type: string - description: Send a create-account email notification to the new user. name: sendEmailNotification in: query schema: type: boolean requestBody: description: Builtin user account data used to create the builtin and authenticated user records. content: '*/*': schema: $ref: "#/components/schemas/BuiltinUser" required: true responses: "200": description: OK content: '*/*': {} /builtin-users/{password}/{key}: post: summary: Creates a builtin user with path credentials description: "Creates a builtin user, matching authenticated user, and API token\ \ using password and management key path values." operationId: BuiltinUsers_create tags: - Users parameters: - description: Builtin-users management key required to create the account. required: true name: key in: path schema: type: string - description: Password assigned to the builtin user. required: true name: password in: path schema: type: string requestBody: description: Builtin user account data used to create the builtin and authenticated user records. content: '*/*': schema: $ref: "#/components/schemas/BuiltinUser" required: true responses: "200": description: OK content: '*/*': {} /builtin-users/{password}/{key}/{sendEmailNotification}: post: summary: Creates a builtin user with notification control description: "Creates a builtin user, matching authenticated user, and API token\ \ while controlling whether a create-account notification is sent." operationId: BuiltinUsers_createWithNotification tags: - Users parameters: - description: Builtin-users management key required to create the account. required: true name: key in: path schema: type: string - description: Password assigned to the builtin user. required: true name: password in: path schema: type: string - description: Send a create-account email notification to the new user. required: true name: sendEmailNotification in: path schema: type: boolean requestBody: description: Builtin user account data used to create the builtin and authenticated user records. content: '*/*': schema: $ref: "#/components/schemas/BuiltinUser" required: true responses: "200": description: OK content: '*/*': {} /builtin-users/{username}/api-token: get: summary: Returns a builtin user's API token description: Returns the API token for a builtin user when token lookup is enabled and the supplied password is valid. operationId: BuiltinUsers_getApiToken tags: - Users parameters: - description: Builtin username whose API token is requested. required: true name: username in: path schema: type: string - description: Builtin account password used to verify token lookup. name: password in: query schema: type: string responses: "200": description: OK content: '*/*': {} /datasetfields/facetables: get: summary: Lists facetable dataset fields description: Lists all facetable dataset fields defined in the installation. operationId: DatasetFields_listAllFacetableDatasetFields tags: - Dataset Fields responses: "200": description: OK content: application/json: schema: {} /datasets/datasetTypes: get: summary: Present configured dataset types description: Provides all dataset types configured for datasets. operationId: Datasets_listDatasetTypes tags: - Datasets parameters: - description: Language preference for localized dataset type labels. name: Accept-Language in: header schema: type: string responses: "200": description: OK content: '*/*': {} post: summary: Creates a dataset type description: "Creates a dataset type from its name, display name, description,\ \ linked metadata blocks, and available licenses." operationId: Datasets_addDatasetType tags: - Datasets requestBody: description: "Dataset type definition with name, displayName, optional description,\ \ linkedMetadataBlocks, and availableLicenses." content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/datasetTypes/{idOrName}: put: summary: Link metadata blocks to a dataset type description: Replaces the metadata blocks linked to a dataset type. operationId: Datasets_updateDatasetTypeLinksWithMetadataBlocks tags: - Datasets parameters: - description: Dataset type id or name. required: true name: idOrName in: path schema: type: string requestBody: description: JSON array of metadata block names to link to the dataset type. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] get: summary: Present a dataset type description: Provides one dataset type by numeric id or name. operationId: Datasets_getDatasetType tags: - Datasets parameters: - description: Dataset type numeric id or name. required: true name: idOrName in: path schema: type: string - description: Language preference for localized dataset type labels. name: Accept-Language in: header schema: type: string responses: "200": description: OK content: '*/*': {} /datasets/datasetTypes/{idOrName}/licenses: put: summary: Configure licenses for a dataset type description: Replaces the licenses available for a dataset type. operationId: Datasets_updateDatasetTypeWithLicenses tags: - Datasets parameters: - description: Dataset type id or name. required: true name: idOrName in: path schema: type: string requestBody: description: JSON array of license names or URIs available for the dataset type. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/datasetTypes/{id}: delete: summary: Remove a dataset type description: Deletes a non-default dataset type by database id. operationId: Datasets_deleteDatasetType tags: - Datasets parameters: - description: Dataset type database id. required: true name: id in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/export: get: summary: Export dataset metadata description: Exports dataset metadata by persistent id using the requested version and exporter. operationId: Datasets_exportDataset tags: - Datasets parameters: - description: Exporter option. name: exporter in: query schema: type: string - description: Persistent identifier. name: persistentId in: query schema: type: string - description: Dataset version selector. name: version in: query schema: type: string responses: "200": description: OK content: application/xml: {} application/json: schema: {} application/html: {} application/ld+json: {} '*/*': {} security: - DataverseApiKey: [] /datasets/listCurationStates: get: summary: Lists dataset curation states description: Returns a CSV report of draft dataset curation statuses and users who can publish datasets. operationId: Datasets_getCurationStates tags: - Datasets parameters: - description: Whether historical records are included. name: includeHistory in: query schema: type: boolean default: false responses: "200": description: OK content: text/csv: {} security: - DataverseApiKey: [] /datasets/locks: get: summary: Lists dataset locks description: "Lists dataset locks visible to a superuser, optionally filtered\ \ by lock type and user identifier." operationId: Datasets_listLocks tags: - Datasets parameters: - description: Resource type filter. name: type in: query schema: type: string - description: User identifier filter. name: userIdentifier in: query schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/modifyRegistrationAll: post: summary: Refresh registration target URLs for all datasets description: Updates persistent identifier target URLs for every dataset. operationId: Datasets_updateDatasetTargetURLAll tags: - Datasets responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/modifyRegistrationPIDMetadataAll: post: summary: Refresh persistent identifier metadata for all datasets description: Updates provider metadata for persistent identifiers associated with all released datasets. operationId: Datasets_updateDatasetPIDMetadataAll tags: - Datasets responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/mpupload: put: summary: Completes a multipart upload description: Finalizes an active multipart upload from the supplied part ETags after checking that the requester may update the dataset. operationId: Datasets_completeMPUpload tags: - Datasets parameters: - description: Dataset persistent identifier. name: globalid in: query schema: type: string - description: Storage identifier. name: storageidentifier in: query schema: type: string - description: Multipart upload id. name: uploadid in: query schema: type: string requestBody: description: JSON object mapping uploaded part numbers to ETag values. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Aborts a multipart upload description: Cancels an active multipart upload after checking that the requester may update the dataset. operationId: Datasets_abortMPUpload tags: - Datasets parameters: - description: Dataset persistent identifier. name: globalid in: query schema: type: string - description: Storage identifier. name: storageidentifier in: query schema: type: string - description: Multipart upload id. name: uploadid in: query schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/previewUrlDatasetVersion/{previewUrlToken}: get: summary: Returns a preview URL dataset version description: "Returns draft dataset version metadata for a preview URL token,\ \ applying anonymized access rules when configured." operationId: Datasets_getPreviewUrlDatasetVersion tags: - Datasets parameters: - description: Preview URL token. name: previewUrlToken in: path required: true schema: type: string - description: Whether owner information is included in the response. name: returnOwners in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} /datasets/previewUrlDatasetVersion/{previewUrlToken}/citation: get: summary: Returns a preview URL citation description: Returns the internal draft dataset citation available through a preview URL token. operationId: Datasets_getPreviewUrlDatasetVersionCitation tags: - Datasets parameters: - description: Preview URL token. name: previewUrlToken in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} /datasets/privateUrlDatasetVersion/{privateUrlToken}: get: summary: Returns a private URL dataset version description: "Returns draft dataset version metadata for a private URL token,\ \ applying anonymized access rules when configured." operationId: Datasets_getPrivateUrlDatasetVersion tags: - Datasets parameters: - description: Private URL token. name: privateUrlToken in: path required: true schema: type: string - description: Whether owner information is included in the response. name: returnOwners in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} /datasets/privateUrlDatasetVersion/{privateUrlToken}/citation: get: summary: Returns a private URL citation description: Returns the draft dataset citation available through a private URL token. operationId: Datasets_getPrivateUrlDatasetVersionCitation tags: - Datasets parameters: - description: Private URL token. name: privateUrlToken in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} /datasets/summaryFieldNames: get: summary: Lists dataset summary fields description: Returns the dataset field names configured for dataset summary display. operationId: Datasets_getDatasetSummaryFieldNames tags: - Datasets responses: "200": description: OK content: '*/*': {} /datasets/{datasetId}/deleteLink/{linkedDataverseId}: delete: summary: Deletes a dataset link description: Removes a link from a dataverse to a dataset and reindexes the dataset. operationId: Datasets_deleteDatasetLinkingDataverse tags: - Datasets parameters: - description: Dataset id. name: datasetId in: path required: true schema: type: string - description: Dataverse id containing the dataset link. name: linkedDataverseId in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{identifier}/allowedCurationLabels: get: summary: Lists allowed curation labels description: Lists the curation labels allowed for a dataset when the requester may publish the dataset. operationId: Datasets_getAllowedCurationLabels tags: - Datasets parameters: - description: Dataset id or persistent identifier. name: identifier in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{identifier}/assignments: get: summary: Lists dataset role assignments description: Lists role assignments directly applied to a dataset. operationId: Datasets_getAssignments tags: - Datasets parameters: - description: Dataset id or persistent identifier. name: identifier in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] post: summary: Creates a dataset role assignment description: Assigns a role to a user or group on a dataset. operationId: Datasets_createAssignment tags: - Datasets parameters: - description: Dataset id or persistent identifier. name: identifier in: path required: true schema: type: string - description: Legacy API token query value. name: key in: query schema: type: string requestBody: description: Role assignment payload with assignee identifier and role alias. content: '*/*': schema: $ref: "#/components/schemas/RoleAssignmentDTO" required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{identifier}/assignments/history: get: summary: Read dataset role assignment history description: Returns dataset role assignment history as JSON or CSV. operationId: Datasets_getRoleAssignmentHistory tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: identifier in: path schema: type: string responses: "200": description: OK content: application/json: schema: {} text/csv: {} security: - DataverseApiKey: [] /datasets/{identifier}/assignments/{id}: delete: summary: Deletes a dataset role assignment description: Revokes a role assignment from a dataset. operationId: Datasets_deleteAssignment tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: integer format: int64 - description: Dataset id or persistent identifier. name: identifier in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{identifier}/curationLabelSet: put: summary: Sets the dataset curation label set description: Sets the curation label set for a dataset when the requester is a superuser. operationId: Datasets_setCurationLabelSet tags: - Datasets parameters: - description: Dataset id or persistent identifier. name: identifier in: path required: true schema: type: string - description: Curation label set name. name: name in: query schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Resets the dataset curation label set description: Clears the dataset-specific curation label set so the dataset uses the effective default. operationId: Datasets_resetCurationLabelSet tags: - Datasets parameters: - description: Dataset id or persistent identifier. name: identifier in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] get: summary: Returns the dataset curation label set description: Returns the effective curation label set name for a dataset when the requester is a superuser. operationId: Datasets_getCurationLabelSet tags: - Datasets parameters: - description: Dataset id or persistent identifier. name: identifier in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{identifier}/dataCaptureModule/checksumValidation: post: summary: Receives checksum validation results description: Processes Data Capture Module checksum validation results and creates a package file when validation succeeds. operationId: Datasets_receiveChecksumValidationResults tags: - Datasets parameters: - description: Dataset id or persistent identifier. name: identifier in: path required: true schema: type: string requestBody: description: JSON checksum validation result from the Data Capture Module. content: '*/*': schema: type: object required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{identifier}/dataCaptureModule/rsync: get: summary: Returns an rsync upload script description: Returns an rsync upload script for a dataset and locks the dataset for Data Capture Module upload. deprecated: true operationId: Datasets_getRsync tags: - Datasets parameters: - description: Dataset id or persistent identifier. name: identifier in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{identifier}/files/assignments/history: get: summary: Read file role assignment history description: Returns file-level role assignment history for a dataset as JSON or CSV. operationId: Datasets_getFilesRoleAssignmentHistory tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: identifier in: path schema: type: string responses: "200": description: OK content: application/json: schema: {} text/csv: {} security: - DataverseApiKey: [] /datasets/{identifier}/guestbook: put: summary: Assign a guestbook to a dataset description: Sets the guestbook used by the selected dataset. operationId: Datasets_updateDatasetGuestbook tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: identifier in: path schema: type: string requestBody: description: Guestbook database id to assign to the dataset. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Clear a dataset guestbook description: Removes the guestbook assignment from the selected dataset. operationId: Datasets_deleteDatasetGuestbook tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{identifier}/guestbookEntryAtRequest: put: summary: Sets the dataset guestbook-entry policy description: Sets whether a dataset requires guestbook entry at request time when the requester is a superuser. operationId: Datasets_setguestbookEntryAtRequest tags: - Datasets parameters: - description: Dataset id or persistent identifier. name: identifier in: path required: true schema: type: string requestBody: description: Boolean guestbook-entry-at-request value to store for the dataset. content: '*/*': schema: type: boolean required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Resets the dataset guestbook-entry policy description: Clears the dataset-specific guestbook-entry-at-request value so the dataset uses the effective default. operationId: Datasets_resetGuestbookEntryAtRequest tags: - Datasets parameters: - description: Dataset id or persistent identifier. name: identifier in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] get: summary: Returns the dataset guestbook-entry policy description: Returns whether a dataset requires guestbook entry at request time or falls back to the effective default. operationId: Datasets_getGuestbookEntryOption tags: - Datasets parameters: - description: Dataset id or persistent identifier. name: identifier in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{identifier}/lock/{type}: post: summary: Locks a dataset description: Adds a lock of the selected type to a dataset and reindexes the dataset. operationId: Datasets_lockDataset tags: - Datasets parameters: - description: Dataset id or persistent identifier. name: identifier in: path required: true schema: type: string - description: Resource type filter. name: type in: path required: true schema: $ref: "#/components/schemas/Reason" responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{identifier}/locks: get: summary: Lists locks for a dataset description: "Lists current locks on a dataset, optionally filtered by lock\ \ type." operationId: Datasets_getLocksForDataset tags: - Datasets parameters: - description: Dataset id or persistent identifier. name: identifier in: path required: true schema: type: string - description: Resource type filter. name: type in: query schema: $ref: "#/components/schemas/Reason" responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Deletes dataset locks description: Removes all locks or a selected lock type from a dataset and reindexes the dataset when locks change. operationId: Datasets_deleteLocks tags: - Datasets parameters: - description: Dataset id or persistent identifier. name: identifier in: path required: true schema: type: string - description: Resource type filter. name: type in: query schema: $ref: "#/components/schemas/Reason" responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{identifier}/pidGenerator: put: summary: Sets the dataset PID generator description: Sets a managed PID generator for a dataset when the requester is a superuser. operationId: Datasets_setPidGenerator tags: - Datasets parameters: - description: Dataset id or persistent identifier. name: identifier in: path required: true schema: type: string requestBody: description: Managed PID generator id to assign to the dataset. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Resets the dataset PID generator description: Clears the dataset-specific PID generator so the dataset uses the effective default. operationId: Datasets_resetPidGenerator tags: - Datasets parameters: - description: Dataset id or persistent identifier. name: identifier in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] get: summary: Returns the dataset PID generator description: Returns the effective PID generator id for a dataset. operationId: Datasets_getPidGenerator tags: - Datasets parameters: - description: Dataset id or persistent identifier. name: identifier in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{identifier}/pidReconcile: put: summary: Reconciles a dataset persistent identifier description: Reconciles a dataset persistent identifier with its effective PID provider when the requester is a superuser. operationId: Datasets_reconcilePid tags: - Datasets parameters: - description: Dataset id or persistent identifier. name: identifier in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{identifier}/reviews: get: summary: Returns dataset reviews description: Returns review metadata stored for a dataset. operationId: Datasets_getReviews tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: identifier in: path schema: type: string responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /datasets/{identifier}/storage/quota: put: summary: Assign dataset storage quota description: Sets the dataset storage quota in bytes. operationId: Datasets_setDatasetQuota tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: identifier in: path schema: type: string requestBody: description: Quota value in bytes. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] get: summary: Read dataset storage quota description: "Returns the storage quota for a dataset, optionally including\ \ inherited quota values." operationId: Datasets_getDatasetQuota tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: identifier in: path schema: type: string - description: Whether to include inherited quota settings in the response. name: showInherited in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Clear dataset storage quota description: Deletes the explicit storage quota for a dataset. operationId: Datasets_deleteDatasetQuota tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{identifier}/storage/use: get: summary: Read dataset storage use description: Returns the recorded storage use for a dataset. operationId: Datasets_getDatasetStorageUse tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{identifier}/storageDriver: put: summary: Sets the dataset storage driver description: Sets a dataset-specific storage driver by label when the requester is a superuser. operationId: Datasets_setFileStore tags: - Datasets parameters: - description: Dataset id or persistent identifier. name: identifier in: path required: true schema: type: string requestBody: description: Storage driver label to assign to the dataset. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Resets the dataset storage driver description: Removes a dataset-specific storage driver so the dataset uses the default storage configuration. operationId: Datasets_resetFileStore tags: - Datasets parameters: - description: Dataset id or persistent identifier. name: identifier in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] get: summary: Returns the dataset storage driver description: Returns the effective storage driver configured for a dataset. operationId: Datasets_getFileStore tags: - Datasets parameters: - description: Dataset id or persistent identifier. name: identifier in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{identifier}/storagesize: get: summary: Returns dataset storage size description: "Returns the storage size for files in a dataset, optionally including\ \ cached values." operationId: Datasets_getStorageSize tags: - Datasets parameters: - description: Dataset id or persistent identifier. name: identifier in: path required: true schema: type: string - description: Whether cached values may be included. name: includeCached in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{identifier}/timestamps: get: summary: Returns dataset timestamps description: "Returns creation, publication, export, index, and update timestamps\ \ visible to the requester for a dataset." operationId: Datasets_getTimestamps tags: - Datasets parameters: - description: Dataset id or persistent identifier. name: identifier in: path required: true schema: type: string responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /datasets/{identifier}/uploadlimits: get: summary: Read dataset upload limits description: Returns upload size limits that apply to the selected dataset. operationId: Datasets_getUploadLimits tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{identifier}/versions/{versionId}/downloadsize: get: summary: Returns dataset version download size description: Returns the calculated download size for files in a dataset version with optional file filters and calculation mode. operationId: Datasets_getDownloadSize tags: - Datasets parameters: - description: Dataset id or persistent identifier. name: identifier in: path required: true schema: type: string - description: Dataset version selector. name: versionId in: path required: true schema: type: string - description: File access status filter. name: accessStatus in: query schema: type: string - description: File category name filter. name: categoryName in: query schema: type: string - description: File content type filter. name: contentType in: query schema: type: string - description: Whether deaccessioned dataset versions are included. name: includeDeaccessioned in: query schema: type: boolean - description: Download size calculation mode. name: mode in: query schema: type: string - description: File search text filter. name: searchText in: query schema: type: string - description: Tabular data tag filter. name: tabularTagName in: query schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}: get: summary: Read dataset details description: "Returns dataset metadata and the latest accessible version, and\ \ records metrics for released dataset access." operationId: Datasets_getDataset tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string - description: Whether to include owner information in the response. name: returnOwners in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Deletes a dataset description: Deletes the latest draft version or destroys an unpublished single-version dataset after checking delete permissions. operationId: Datasets_deleteDataset tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/access: put: summary: Edit dataset terms of access description: Updates terms of use and access settings on the dataset draft. operationId: Datasets_editVersionTermsOfAccess tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string - description: Source last-update timestamp used by external integrations. name: sourceLastUpdateTime in: query schema: type: string requestBody: description: JSON terms-of-access payload for the dataset draft. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/actions/:publish: post: summary: Publishes a dataset description: "Publishes a dataset version as a major, minor, or current-version\ \ update and optionally waits for indexing." operationId: Datasets_publishDataset tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string - description: "When true, require the dataset to be indexed before publication\ \ completes." name: assureIsIndexed in: query schema: type: boolean - description: "Publication type: major, minor, or updatecurrent." required: true name: type in: query schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] get: summary: Publish a dataset through the deprecated GET route description: Publishes a dataset version using the legacy GET endpoint retained for compatibility. deprecated: true operationId: Datasets_publishDataseUsingGetDeprecated tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string - description: "Publication type: major, minor, or updatecurrent." required: true name: type in: query schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/actions/:releasemigrated: post: summary: Publishes a migrated dataset description: Publishes a migrated dataset using supplied JSON-LD publication metadata when the requester is a superuser. operationId: Datasets_publishMigratedDataset tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Whether PID provider metadata should be updated. name: updatepidatprovider in: query schema: type: boolean default: false requestBody: description: JSON-LD metadata containing the migrated dataset publication date. content: application/ld+json: schema: type: string application/json-ld: schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/add: post: summary: Uploads a file for a dataset description: Uploads a file for a dataset operationId: Datasets_addFileToDataset tags: - addFileToDataset parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string requestBody: description: Multipart request containing one uploaded file and JSON metadata for the dataset. content: multipart/form-data: schema: type: string required: true responses: "200": description: File uploaded successfully to dataset content: application/json: schema: {} security: - DataverseApiKey: [] /datasets/{id}/addFiles: post: summary: Uploads a set of files to a dataset description: Uploads a set of files to a dataset operationId: Datasets_addFilesToDataset tags: - addFilesToDataset parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string requestBody: description: Multipart request containing file content and JSON metadata for files to add. content: multipart/form-data: schema: type: string required: true responses: "200": description: Files uploaded successfully to dataset content: application/json: schema: {} security: - DataverseApiKey: [] /datasets/{id}/addGlobusFiles: post: summary: Uploads a Globus file for a dataset description: Uploads a Globus file for a dataset operationId: Datasets_addGlobusFilesToDataset tags: - addGlobusFilesToDataset parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string requestBody: description: Multipart request containing Globus file metadata and transfer task information. content: multipart/form-data: schema: type: string required: true responses: "200": description: Globus file uploaded successfully to dataset content: application/json: schema: {} security: - DataverseApiKey: [] /datasets/{id}/availableFileCategories: get: summary: Lists available file categories description: Lists file category names already used by files in a dataset. operationId: Datasets_getAvailableFileCategories tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/citationdate: delete: summary: Restores the default citation date description: Restores the dataset citation date to use the default publication date. operationId: Datasets_useDefaultCitationDate tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] put: summary: Sets the dataset citation date field description: Sets the dataset field type used as the dataset citation date. operationId: Datasets_setCitationDate tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string requestBody: description: "Dataset field type name to use as the citation date, or :publicationDate\ \ for the default publication date." content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/cleanStorage: get: summary: Cleans dataset storage description: Finds and optionally deletes storage objects that are no longer referenced by files in a dataset. operationId: Datasets_cleanStorage tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Whether to validate the request without applying changes. name: dryrun in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/curationStatus: put: summary: Sets dataset curation status description: Sets the curation status label for a dataset when the requester may publish the dataset. operationId: Datasets_setCurationStatus tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Curation status label. name: label in: query schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] get: summary: Returns dataset curation status description: Returns the current or historical curation status for a dataset when the requester may view it. operationId: Datasets_getCurationStatus tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Whether historical records are included. name: includeHistory in: query schema: type: boolean responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] delete: summary: Deletes dataset curation status description: Deletes the current curation status from a dataset when the requester may publish the dataset. operationId: Datasets_deleteCurationStatus tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/deleteFiles: put: summary: Remove files from a dataset draft description: Deletes selected files from the dataset draft and removes physical files that have never been released. operationId: Datasets_deleteDatasetFiles tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string requestBody: description: JSON array of data file ids to delete from the dataset draft. content: application/json: schema: type: array required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/deleteMetadata: put: summary: Remove metadata fields from a dataset draft description: Deletes metadata fields or field values from the dataset draft using the supplied JSON payload. operationId: Datasets_deleteVersionMetadata tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string requestBody: description: JSON metadata fields or values to remove from the dataset draft. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/destroy: delete: summary: Destroys a dataset description: Permanently destroys a dataset and finalizes physical file deletion when the requester is authorized. operationId: Datasets_destroyDataset tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/dirindex: get: summary: Returns a dataset folder listing description: "Returns an HTML folder listing for files in a dataset version,\ \ optionally scoped to a folder and original filenames." operationId: Datasets_getFileAccessFolderView tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Folder path filter. name: folder in: query schema: type: string - description: Whether original file names are returned. name: original in: query schema: type: boolean - description: Dataset version selector. name: version in: query schema: type: string responses: "200": description: OK content: text/html: {} security: - DataverseApiKey: [] /datasets/{id}/download/count: get: summary: Returns dataset download count description: "Returns the download count for a dataset, with optional inclusion\ \ of Make Data Count values." operationId: Datasets_getDownloadCountByDatasetId tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Whether Make Data Count values are included. name: includeMDC in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/editMetadata: put: summary: Edit dataset draft metadata description: "Adds, merges, or replaces dataset metadata fields on the draft\ \ version." operationId: Datasets_editVersionMetadata tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string - description: "When true, replace matching field values instead of merging." name: replace in: query schema: type: boolean - description: Source last-update timestamp used by external integrations. name: sourceLastUpdateTime in: query schema: type: string requestBody: description: "JSON metadata fields to add, merge, or replace." content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/externalTool/{tid}/toolUrl: post: summary: Creates a dataset external tool URL description: Returns launch URL details for a dataset-scoped external tool after checking tool configuration and dataset permissions. operationId: Datasets_getDatasetExternalToolUrl tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: External tool id. name: tid in: path required: true schema: type: integer format: int64 requestBody: description: External tool launch options such as preview mode and locale. content: application/json: schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/files/actions/:set-embargo: post: summary: Embargoes dataset files description: Applies embargo settings to the specified dataset files after checking dataset edit permissions. operationId: Datasets_createFileEmbargo tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string requestBody: description: JSON payload identifying dataset files and embargo settings to apply. content: application/json: schema: type: string required: true responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /datasets/{id}/files/actions/:set-retention: post: summary: Sets retention on dataset files description: Sets retention information on selected files in a dataset. operationId: Datasets_createFileRetention tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string requestBody: description: JSON retention payload identifying files and retention settings. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/files/actions/:unset-embargo: post: summary: Removes file embargoes description: Removes embargoes from the specified dataset files after checking dataset edit permissions. operationId: Datasets_removeFileEmbargo tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string requestBody: description: JSON payload identifying the dataset files whose embargoes should be removed. content: application/json: schema: type: string required: true responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /datasets/{id}/files/actions/:unset-retention: post: summary: Removes file retention periods description: Removes retention periods from the specified dataset files after checking dataset edit permissions. operationId: Datasets_removeFileRetention tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string requestBody: description: JSON payload identifying the dataset files whose retention periods should be removed. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/files/metadata: post: summary: Updates metadata for multiple files description: Updates file metadata entries in a dataset after checking dataset edit permissions. operationId: Datasets_updateMultipleFileMetadata tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string requestBody: description: JSON metadata updates for one or more files in the dataset. content: application/json: schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/files/uploadlimit: delete: summary: Clears dataset file upload limit description: Removes the file count upload limit from a dataset when the requester is a superuser. operationId: Datasets_deleteDatasetFilesLimits tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/files/uploadlimit/{limit}: post: summary: Sets dataset file upload limit description: Sets the file count upload limit for a dataset when the requester is a superuser. operationId: Datasets_updateDatasetFilesLimits tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Maximum number of results or configured limit value. name: limit in: path required: true schema: type: integer format: int32 responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/globusDownloadParameters: get: summary: Returns Globus download parameters description: Returns signed parameters and allowed callback URLs for a Globus download workflow for a dataset. operationId: Datasets_getGlobusDownloadParams tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Globus download request id. name: downloadId in: query schema: type: string - description: Locale for localized Globus metadata. name: locale in: query schema: type: string responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /datasets/{id}/globusUploadParameters: get: summary: Returns Globus upload parameters description: Returns signed parameters and allowed callback URLs for a Globus upload or reference workflow for a dataset. operationId: Datasets_getGlobusUploadParams tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Locale for localized Globus metadata. name: locale in: query schema: type: string responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /datasets/{id}/license: put: summary: Change a dataset license description: "Updates the dataset license by name or URI, or applies custom\ \ terms." operationId: Datasets_updateLicense tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string requestBody: description: "License update request containing a license name, URI, or custom\ \ terms." content: '*/*': schema: $ref: "#/components/schemas/LicenseUpdateRequest" required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/links: get: summary: Lists dataset links description: Lists dataverses that link to the dataset and are visible to the requester. operationId: Datasets_getLinks tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/logo: get: summary: Returns a dataset logo description: Returns the dataset logo image when one is available. operationId: Datasets_getDatasetLogo tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string responses: "200": description: OK content: image/png: {} security: - DataverseApiKey: [] /datasets/{id}/makeDataCount/citations: get: summary: Lists dataset external citations description: Lists external citation URLs recorded for a dataset. operationId: Datasets_getMakeDataCountCitations tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/makeDataCount/{metric}: get: summary: Returns a current Make Data Count metric description: "Returns one Make Data Count metric for a dataset for the current\ \ reporting period, optionally filtered by country." operationId: Datasets_getMakeDataCountMetricCurrentMonth tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Make Data Count metric name. name: metric in: path required: true schema: type: string - description: Country filter for metric results. name: country in: query schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/makeDataCount/{metric}/{yyyymm}: get: summary: Returns a monthly Make Data Count metric description: "Returns one Make Data Count metric for a dataset in a selected\ \ month, optionally filtered by country." operationId: Datasets_getMakeDataCountMetric tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Make Data Count metric name. name: metric in: path required: true schema: type: string - description: Metric month in YYYYMM format. name: yyyymm in: path required: true schema: type: string - description: Country filter for metric results. name: country in: query schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/metadata: put: summary: Apply JSON-LD metadata to a dataset description: Updates or creates a draft dataset version from JSON-LD metadata. operationId: Datasets_updateVersionMetadata tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string - description: "When true, replace existing terms instead of merging supplied\ \ values." name: replace in: query schema: type: boolean default: false requestBody: description: JSON-LD metadata to apply to the dataset draft. content: application/ld+json: schema: type: string application/json-ld: schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] get: summary: Read latest JSON-LD metadata description: Exports JSON-LD metadata for the latest accessible dataset version. operationId: Datasets_getJsonLDMetadata tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string responses: "200": description: OK content: application/ld+json: {} application/json-ld: {} security: - DataverseApiKey: [] /datasets/{id}/metadata/delete: put: summary: Remove JSON-LD metadata from a dataset description: Deletes dataset metadata values described by the supplied JSON-LD payload. operationId: Datasets_deleteMetadata tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string requestBody: description: JSON-LD metadata values to remove from the dataset draft. content: application/ld+json: schema: type: string application/json-ld: schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/modifyRegistration: post: summary: Refresh a dataset registration target URL description: Updates the target URL stored with the persistent identifier provider for one dataset. operationId: Datasets_updateDatasetTargetURL tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/modifyRegistrationMetadata: post: summary: Refresh persistent identifier metadata for a dataset description: Updates provider metadata for the persistent identifier associated with one released dataset. operationId: Datasets_updateDatasetPIDMetadata tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/monitorGlobusDownload: post: summary: Monitors a Globus download description: Starts monitoring a Globus transfer task and removes temporary permissions when the transfer completes. operationId: Datasets_monitorGlobusDownload tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string requestBody: description: Globus transfer monitor request containing the task identifier. content: application/json: schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/move/{targetDataverseAlias}: post: summary: Moves a dataset description: Moves a dataset to another dataverse and reports warnings unless the move is forced. operationId: Datasets_moveDataset tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Alias of the destination dataverse. name: targetDataverseAlias in: path required: true schema: type: string - description: Whether to force moving the dataset when warnings exist. name: forceMove in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/previewUrl: get: summary: Returns preview URL data description: Returns preview URL data for a dataset. operationId: Datasets_getPreviewUrlData tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Deletes a preview URL description: Deletes the preview URL for a dataset when one exists. operationId: Datasets_deletePreviewUrl tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] post: summary: Creates a preview URL description: "Creates a preview URL for a dataset draft, optionally with anonymized\ \ access when configured." operationId: Datasets_createPreviewUrl tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Whether the generated URL hides requester identity details. name: anonymizedAccess in: query schema: type: boolean default: false responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/privateUrl: get: summary: Returns private URL data description: Returns private URL data for a dataset through the deprecated private URL route. deprecated: true operationId: Datasets_getPrivateUrlData tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Deletes a private URL description: Deletes the private URL for a dataset through the deprecated private URL route. deprecated: true operationId: Datasets_deletePrivateUrl tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] post: summary: Creates a private URL description: Creates a private URL for a dataset through the deprecated private URL route. deprecated: true operationId: Datasets_createPrivateUrl tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Whether the generated URL hides requester identity details. name: anonymizedAccess in: query schema: type: boolean default: false responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/replaceFiles: post: summary: Replace a set of files to a dataset description: Replace a set of files to a dataset operationId: Datasets_replaceFilesInDataset tags: - replaceFilesInDataset parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string requestBody: description: Multipart request containing replacement file content and JSON metadata. content: multipart/form-data: schema: type: string required: true responses: "200": description: Files replaced successfully to dataset content: application/json: schema: {} security: - DataverseApiKey: [] /datasets/{id}/requestGlobusDownload: post: summary: Requests a Globus download description: Creates temporary Globus download permissions and returns endpoint path information for dataset files. operationId: Datasets_requestGlobusDownload tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Globus download request id. name: downloadId in: query schema: type: string requestBody: description: Globus download request with transfer principal and optional file id list. content: application/json: schema: type: string required: true responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /datasets/{id}/requestGlobusUploadPaths: post: summary: Requests Globus upload paths description: Creates upload path assignments and permissions for a Globus user to upload files to a dataset. operationId: Datasets_requestGlobusUpload tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string requestBody: description: Globus upload request with the transfer principal and number of files. content: application/json: schema: type: string required: true responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /datasets/{id}/returnToAuthor: post: summary: Returns a dataset to authors description: Returns a dataset under review to its authors with a supplied reason. operationId: Datasets_returnToAuthor tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string requestBody: description: JSON payload containing the reason for returning the dataset to authors. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/submitForReview: post: summary: Submits a dataset for review description: Submits a dataset for review and returns the resulting review state. operationId: Datasets_submitForReview tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/thumbnail: post: summary: Uploads a logo for a dataset description: Uploads a logo for a dataset operationId: Datasets_uploadDatasetLogo tags: - uploadDatasetLogo parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string requestBody: description: Multipart dataset logo upload containing the image file. content: multipart/form-data: schema: type: string format: binary required: true responses: "200": description: Dataset logo uploaded successfully content: application/json: schema: {} security: - DataverseApiKey: [] delete: summary: Removes a dataset thumbnail description: Removes the custom thumbnail or logo assigned to a dataset. operationId: Datasets_removeDatasetLogo tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] get: summary: Returns a dataset thumbnail description: Returns the dataset thumbnail image when one is available. operationId: Datasets_getDatasetThumbnail tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string responses: "200": description: OK content: image/png: {} security: - DataverseApiKey: [] /datasets/{id}/thumbnail/candidates: get: summary: Lists dataset thumbnail candidates description: Lists images that can be selected as the dataset thumbnail when the requester may update the thumbnail. operationId: Datasets_getDatasetThumbnailCandidates tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/thumbnail/{dataFileId}: post: summary: Sets a dataset thumbnail from a file description: Uses an existing data file image as the dataset thumbnail. operationId: Datasets_setDataFileAsThumbnail tags: - Datasets parameters: - description: Data file id. name: dataFileId in: path required: true schema: type: integer format: int64 - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/uploadurls: get: summary: Returns multipart upload URLs description: "Returns temporary direct-upload URLs for adding a file to a dataset\ \ after checking upload permissions, limits, and quotas." operationId: Datasets_getMPUploadUrls tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Requested file size in bytes. name: size in: query schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/userPermissions: get: summary: Returns user permissions on a dataset description: Returns selected dataset permissions for the requesting user. operationId: Datasets_getUserPermissionsOnDataset tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/versions: get: summary: Lists dataset versions description: "Lists versions for a dataset with optional file, metadata block,\ \ limit, and offset controls." operationId: Datasets_listVersions tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Whether files are excluded from the returned dataset version metadata. name: excludeFiles in: query schema: type: boolean - description: Whether metadata blocks are excluded from the returned dataset version metadata. name: excludeMetadataBlocks in: query schema: type: boolean - description: Maximum number of results to return. name: limit in: query schema: type: integer format: int32 - description: Result offset. name: offset in: query schema: type: integer format: int32 responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/versions/compareSummary: get: summary: Lists dataset version comparison summaries description: Lists comparison summaries for dataset versions with optional limit and offset controls. operationId: Datasets_getCompareVersionsSummary tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Maximum number of results or configured limit value. name: limit in: query schema: type: integer format: int32 - description: Result offset. name: offset in: query schema: type: integer format: int32 responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/versions/{versionId1}/compare/{versionId2}: get: summary: Compares dataset versions description: Compares two dataset versions and returns the metadata and file differences between them. operationId: Datasets_getCompareVersions tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: First dataset version selector to compare. name: versionId1 in: path required: true schema: type: string - description: Second dataset version selector to compare. name: versionId2 in: path required: true schema: type: string - description: Whether deaccessioned dataset versions are included. name: includeDeaccessioned in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/versions/{versionId}: put: summary: Replace draft version metadata description: Updates the draft dataset version from the supplied JSON dataset-version payload. operationId: Datasets_updateDraftVersion tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string - description: Dataset version id; only :draft is accepted. required: true name: versionId in: path schema: type: string requestBody: description: Dataset version JSON used to replace draft metadata. content: application/json: schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] get: summary: Returns a dataset version description: "Returns metadata for a selected dataset version with optional\ \ file, metadata block, owner, and deaccession controls." operationId: Datasets_getVersion tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Dataset version selector. name: versionId in: path required: true schema: type: string - description: Whether files are excluded from the returned dataset version metadata. name: excludeFiles in: query schema: type: boolean - description: Whether metadata blocks are excluded from the returned dataset version metadata. name: excludeMetadataBlocks in: query schema: type: boolean - description: Whether the configured email-exclusion setting is ignored for the export. name: ignoreSettingExcludeEmailFromExport in: query schema: type: boolean - description: Whether deaccessioned dataset versions are included. name: includeDeaccessioned in: query schema: type: boolean - description: Whether owner information is included in the response. name: returnOwners in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Deletes a draft dataset version description: Deletes the draft version of a dataset and finalizes physical file deletion for removed files. operationId: Datasets_deleteDraftVersion tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Dataset version selector. name: versionId in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/versions/{versionId}/canDownloadAtLeastOneFile: get: summary: Checks whether any file can be downloaded description: Returns whether the requester can download at least one file from a selected dataset version. operationId: Datasets_getCanDownloadAtLeastOneFile tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Dataset version selector. name: versionId in: path required: true schema: type: string - description: Whether deaccessioned dataset versions are included. name: includeDeaccessioned in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/versions/{versionId}/citation: get: summary: Returns an internal dataset version citation description: Returns the internal citation text for a selected dataset version. operationId: Datasets_getDatasetVersionInternalCitation tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Dataset version selector. name: versionId in: path required: true schema: type: string - description: Whether deaccessioned dataset versions are included. name: includeDeaccessioned in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/versions/{versionId}/citation/{format}: get: summary: Returns a formatted dataset version citation description: Returns citation text for a selected dataset version in the requested citation format. operationId: Datasets_getDatasetVersionCitation tags: - Datasets parameters: - description: Citation format to return. name: format in: path required: true schema: type: string - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Dataset version selector. name: versionId in: path required: true schema: type: string - description: Whether deaccessioned dataset versions are included. name: includeDeaccessioned in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/versions/{versionId}/customlicense: get: summary: Redirects to custom license terms description: Redirects to the dataset page terms tab for a dataset version that uses custom license terms. operationId: Datasets_getCustomTermsTab tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Dataset version selector. name: versionId in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} /datasets/{id}/versions/{versionId}/deaccession: post: summary: Deaccessions a dataset version description: Deaccessions a published dataset version using the supplied reason and optional forwarding URL. operationId: Datasets_deaccessionDataset tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Dataset version selector. name: versionId in: path required: true schema: type: string requestBody: description: JSON deaccession payload containing deaccessionReason and optional deaccessionForwardURL. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/versions/{versionId}/files: get: summary: Lists files in a dataset version description: "Lists file metadata for a dataset version with pagination, text\ \ search, category, tag, content type, access status, and ordering filters." operationId: Datasets_getVersionFiles tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Dataset version selector. name: versionId in: path required: true schema: type: string - description: File access status filter. name: accessStatus in: query schema: type: string - description: File category name filter. name: categoryName in: query schema: type: string - description: File content type filter. name: contentType in: query schema: type: string - description: Whether deaccessioned dataset versions are included. name: includeDeaccessioned in: query schema: type: boolean - description: Maximum number of results to return. name: limit in: query schema: type: integer format: int32 - description: Result offset. name: offset in: query schema: type: integer format: int32 - description: File ordering criteria. name: orderCriteria in: query schema: type: string - description: File search text filter. name: searchText in: query schema: type: string - description: Tabular data tag filter. name: tabularTagName in: query schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/versions/{versionId}/files/counts: get: summary: Counts files in a dataset version description: "Returns total file counts for a dataset version and count breakdowns\ \ by content type, category, tabular tag, and access status." operationId: Datasets_getVersionFileCounts tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Dataset version selector. name: versionId in: path required: true schema: type: string - description: File access status filter. name: accessStatus in: query schema: type: string - description: File category name filter. name: categoryName in: query schema: type: string - description: File content type filter. name: contentType in: query schema: type: string - description: Whether deaccessioned dataset versions are included. name: includeDeaccessioned in: query schema: type: boolean - description: File search text filter. name: searchText in: query schema: type: string - description: Tabular data tag filter. name: tabularTagName in: query schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/versions/{versionId}/linkset: get: summary: Build a dataset version linkset description: Generates signposting linkset JSON for a released dataset version. operationId: Datasets_getLinkset tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string - description: Dataset version id or version label. required: true name: versionId in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/versions/{versionId}/metadata: get: summary: Read JSON-LD metadata for a dataset version description: Exports JSON-LD metadata for the requested dataset version. operationId: Datasets_getVersionJsonLDMetadata tags: - Datasets parameters: - description: Dataset id or persistent identifier. name: id in: path required: true schema: type: string - description: Dataset version id or version label. name: versionId in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} application/ld+json: {} application/json-ld: {} security: - DataverseApiKey: [] /datasets/{id}/versions/{versionId}/versionNote: get: summary: Read a dataset version note description: Returns the note stored on the requested dataset version. operationId: Datasets_getVersionCreationNote tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string - description: Dataset version id or version label. required: true name: versionId in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Clear a dataset version note description: Deletes the note from a draft or superuser-selected published dataset version. operationId: Datasets_deleteVersionNote tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string - description: Dataset version id or version label. required: true name: versionId in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] put: summary: Store a dataset version note description: Adds or replaces the note on a draft or superuser-selected published dataset version. operationId: Datasets_addVersionNote tags: - Datasets parameters: - description: Dataset id or persistent identifier. required: true name: id in: path schema: type: string - description: Dataset version id or version label. required: true name: versionId in: path schema: type: string requestBody: description: Plain text note to store on the dataset version. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/versions/{versionNumber}/metadata/{block}: get: summary: Returns a metadata block for a dataset version description: Returns metadata fields from one named metadata block in a selected dataset version. operationId: Datasets_getVersionMetadataBlock tags: - Datasets parameters: - description: Metadata block name. name: block in: path required: true schema: type: string - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Dataset version selector. name: versionNumber in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/versions/{version}/toolparams/{tid}: get: summary: Returns dataset external tool parameters description: Returns dataset-version parameters and allowed API calls for a dataset-scoped external tool. operationId: Datasets_getExternalToolDVParams tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: External tool id. name: tid in: path required: true schema: type: integer format: int64 - description: Dataset version selector. name: version in: path required: true schema: type: string - description: Locale for localized Globus metadata. name: locale in: query schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datasets/{id}/{version}/archivalStatus: put: summary: Sets dataset version archival status description: Sets the archival status payload for a dataset version when the requester is a superuser. operationId: Datasets_setDatasetVersionArchivalStatus tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Dataset version selector. name: version in: path required: true schema: type: string requestBody: description: JSON archival status payload to store for the dataset version. content: application/json: schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] get: summary: Returns archival status for a dataset version description: Returns stored archival status information for a dataset version when the requester is a superuser. operationId: Datasets_getDatasetVersionArchivalStatus tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Dataset version selector. name: version in: path required: true schema: type: string responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] delete: summary: Deletes archival status for a dataset version description: Removes stored archival status information from a dataset version when the requester is a superuser. operationId: Datasets_deleteDatasetVersionArchivalStatus tags: - Datasets parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Dataset version selector. name: version in: path required: true schema: type: string responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /datasets/{linkedDatasetId}/link/{linkingDataverseAlias}: put: summary: Links a dataset to a dataverse description: Creates a link from a dataverse to an existing dataset. operationId: Datasets_linkDataset tags: - Datasets parameters: - description: Dataset id to link. name: linkedDatasetId in: path required: true schema: type: string - description: Alias of the dataverse that links to the dataset. name: linkingDataverseAlias in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /datatags/receiveTags/{uniqueCacheId}: post: summary: Receives DataTags results description: Stores returned DataTags JSON in the callback cache and returns the Dataverse redirect URL. operationId: DataTagsAPI_receiveTags tags: - Datasets parameters: - description: Callback cache identifier associated with the DataTags interview. required: true name: uniqueCacheId in: path schema: type: string requestBody: description: DataTags result JSON returned by the external tagging interview. content: '*/*': schema: type: object required: true responses: "200": description: OK content: '*/*': {} /dataverseFeaturedItems/{id}: put: summary: Revise a dataverse featured item description: "Updates text, linked object, display order, and optional image\ \ content for a featured item." operationId: DataverseFeaturedItems_updateFeaturedItem tags: - Dataverse Featured Items parameters: - description: Database id of the featured item to update. required: true name: id in: path schema: type: integer format: int64 requestBody: description: "Multipart featured item update with text, ordering, optional\ \ linked object, and optional replacement image." content: multipart/form-data: schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Remove a dataverse featured item description: Deletes the featured item with the supplied database id. operationId: DataverseFeaturedItems_deleteFeaturedItem tags: - Dataverse Featured Items parameters: - description: Database id of the featured item to delete. required: true name: id in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses: post: summary: Create the root dataverse description: Creates the root dataverse from a Dataverse JSON payload. operationId: Dataverses_addRoot tags: - Dataverses requestBody: description: Dataverse JSON for the root collection. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{dataverseId}/featuredItems: put: summary: Replace dataverse featured items description: "Creates, updates, reorders, and removes featured items for a dataverse\ \ from multipart form lists." operationId: Dataverses_updateFeaturedItems tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: dataverseId in: path schema: type: string requestBody: description: "Multipart featured item list update with ids, text, ordering,\ \ linked objects, keep-image flags, and uploaded images." content: multipart/form-data: schema: type: array items: type: integer format: int64 required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}: put: summary: Revise a dataverse description: "Updates dataverse metadata and optional metadata block, input\ \ level, and facet settings." operationId: Dataverses_updateDataverse tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string requestBody: description: Dataverse update JSON with metadata and optional configuration sections. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] get: summary: Read a dataverse description: Returns dataverse metadata with optional owner and child-count information. operationId: Dataverses_getDataverse tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string - description: Whether to include email fields when the caller has permission to ignore the email-exclusion setting. name: ignoreSettingExcludeEmailFromExport in: query schema: type: boolean - description: Whether to include the number of child objects. name: returnChildCount in: query schema: type: boolean - description: Whether to include owner information. name: returnOwners in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Remove a dataverse description: Deletes the selected dataverse collection. operationId: Dataverses_deleteDataverse tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] post: summary: Create a child dataverse description: Creates a dataverse under the selected parent and returns the created collection metadata. operationId: Dataverses_addDataverse tags: - Dataverses parameters: - description: "Parent dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string requestBody: description: "Dataverse JSON including alias, name, contact, metadata block,\ \ input level, and facet settings." content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/actions/:publish: post: summary: Publish a dataverse description: Publishes the selected dataverse collection. operationId: Dataverses_publishDataverse tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/allowedMetadataLanguages: get: summary: Read allowed metadata language description: Returns the metadata language configured for a dataverse. operationId: Dataverses_getMetadataLanguage tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/allowedMetadataLanguages/{metadataLanguage}: put: summary: Assign allowed metadata language description: Sets the metadata language configured for a dataverse. operationId: Dataverses_setMetadataLanguage tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string - description: Metadata language code to assign. required: true name: metadataLanguage in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/allowedStorageDrivers: get: summary: Read allowed storage drivers description: Returns storage drivers available for the selected dataverse. operationId: Dataverses_listStorageDrivers tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/assignments: get: summary: Read dataverse role assignments description: Lists role assignments defined on a dataverse. operationId: Dataverses_listAssignments tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] post: summary: Grant a dataverse role assignment description: Assigns a role to a role assignee on a dataverse. operationId: Dataverses_createAssignment tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string requestBody: description: Role assignment containing assignee identifier and role alias. content: '*/*': schema: $ref: "#/components/schemas/RoleAssignmentDTO" required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/assignments/history: get: summary: Read dataverse role assignment history description: Returns dataverse role assignment history as JSON or CSV. operationId: Dataverses_getRoleAssignmentHistory tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: application/json: schema: {} text/csv: {} security: - DataverseApiKey: [] /dataverses/{identifier}/assignments/{id}: delete: summary: Remove a dataverse role assignment description: Revokes a role assignment from the selected dataverse. operationId: Dataverses_deleteAssignment tags: - Dataverses parameters: - description: Role assignment database id. required: true name: id in: path schema: type: integer format: int64 - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/attribute/{attribute}: put: summary: Change a dataverse attribute description: Updates one supported dataverse attribute value. operationId: Dataverses_updateAttribute tags: - Dataverses parameters: - description: Dataverse attribute name to change. required: true name: attribute in: path schema: type: string - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string - description: New attribute value. name: value in: query schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/contents: get: summary: Read dataverse contents description: Lists direct child dataverses and datasets for a dataverse. operationId: Dataverses_listContent tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/datasetSchema: get: summary: Read dataset schema for a dataverse description: Returns the dataset JSON schema generated for the selected dataverse. operationId: Dataverses_getDatasetSchema tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /dataverses/{identifier}/datasets: post: summary: Create a dataset from JSON description: Creates a draft dataset in the selected dataverse and returns its id and persistent identifier. operationId: Dataverses_createDataset tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier for the dataset\ \ owner." required: true name: identifier in: path schema: type: string - description: "When true and incomplete metadata is allowed, skip full metadata\ \ validation." name: doNotValidate in: query schema: type: string requestBody: description: Dataset JSON containing at least one dataset version. content: application/ld+json: schema: type: string application/json-ld: schema: type: string application/json: schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/datasets/:import: post: summary: Import a dataset from JSON description: "Imports a dataset into the selected dataverse, optionally assigning\ \ a supplied PID and release state." operationId: Dataverses_importDataset tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier for the dataset\ \ owner." required: true name: identifier in: path schema: type: string - description: Persistent identifier to assign to the imported dataset. name: pid in: query schema: type: string - description: "When true, import the dataset as released." name: release in: query schema: type: string requestBody: description: Dataset JSON to import. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/datasets/:importddi: post: summary: Import a dataset from DDI XML description: Converts DDI XML to dataset metadata and imports it into the selected dataverse. operationId: Dataverses_importDatasetDdi tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier for the dataset\ \ owner." required: true name: identifier in: path schema: type: string - description: Persistent identifier to assign to the imported dataset. name: pid in: query schema: type: string - description: "When true, import the dataset as released." name: release in: query schema: type: string requestBody: description: DDI XML document to import. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/datasets/:startmigration: post: summary: Start migrated dataset recreation description: Creates a draft dataset from published JSON-LD metadata for a migration workflow. operationId: Dataverses_recreateDataset tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier for the dataset\ \ owner." required: true name: identifier in: path schema: type: string requestBody: description: Published dataset JSON-LD metadata to recreate as a draft. content: application/ld+json: schema: type: string application/json-ld: schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/defaultContributorRole: get: summary: Read the default contributor role description: Returns the default contributor role configured for a dataverse. operationId: Dataverses_getDefaultContributorRole tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/defaultContributorRole/{roleAlias}: put: summary: Assign a default contributor role description: Sets the default contributor role used for datasets created in a dataverse. operationId: Dataverses_updateDefaultContributorRole tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string - description: "Role alias to use as the default contributor role, or none." required: true name: roleAlias in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/facets: post: summary: Assign dataverse facets description: Replaces the dataset field facets configured directly on a dataverse. operationId: Dataverses_setFacets tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string requestBody: description: JSON array of dataset field type names to use as facets. content: '*/*': schema: type: string required: true responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] get: summary: Read dataverse facets description: "Lists dataset field facets configured for a dataverse, optionally\ \ including detailed facet metadata." operationId: Dataverses_listFacets tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string - description: Whether to include detailed facet metadata. name: returnDetails in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/featured: post: summary: Assign featured dataverses description: Adds eligible child or linked dataverses to the featured list for a dataverse. operationId: Dataverses_setFeaturedDataverses tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string requestBody: description: JSON array of dataverse aliases to feature. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] get: summary: Read featured dataverses description: Lists aliases for dataverses featured by the selected dataverse. operationId: Dataverses_getFeaturedDataverses tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string requestBody: description: Unused request body accepted by the endpoint. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Clear featured dataverses description: Removes all featured dataverses from the selected dataverse. operationId: Dataverses_deleteFeaturedCollections tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/featuredItems: get: summary: Read dataverse featured items description: Lists featured items configured on a dataverse. operationId: Dataverses_listFeaturedItems tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Clear dataverse featured items description: Removes all featured items from a dataverse. operationId: Dataverses_deleteFeaturedItems tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] post: summary: Create a dataverse featured item description: "Creates a featured item with text, optional linked object, display\ \ order, and optional image." operationId: Dataverses_createFeaturedItem tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string requestBody: description: "Multipart featured item creation request with text, ordering,\ \ optional linked object, and optional image." content: multipart/form-data: schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/groups: get: summary: Read explicit groups description: Lists explicit groups owned by a dataverse. operationId: Dataverses_listGroups tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] post: summary: Create an explicit group description: Creates an explicit group owned by a dataverse. operationId: Dataverses_createExplicitGroup tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string requestBody: description: Explicit group definition. content: '*/*': schema: $ref: "#/components/schemas/ExplicitGroupDTO" required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/groups/{aliasInOwner}: put: summary: Revise an explicit group description: Updates an explicit group owned by a dataverse. operationId: Dataverses_updateGroup tags: - Dataverses parameters: - description: Group alias within the dataverse. required: true name: aliasInOwner in: path schema: type: string - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string requestBody: description: Explicit group definition to apply. content: '*/*': schema: $ref: "#/components/schemas/ExplicitGroupDTO" required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] get: summary: Read an explicit group description: Returns one explicit group owned by a dataverse. operationId: Dataverses_getGroupByOwnerAndAliasInOwner tags: - Dataverses parameters: - description: Group alias within the dataverse. required: true name: aliasInOwner in: path schema: type: string - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Remove an explicit group description: Deletes an explicit group owned by a dataverse. operationId: Dataverses_deleteGroup tags: - Dataverses parameters: - description: Group alias within the dataverse. required: true name: aliasInOwner in: path schema: type: string - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/groups/{aliasInOwner}/roleAssignees: post: summary: Append role assignees to an explicit group description: Adds multiple role assignee identifiers to an explicit group. operationId: Dataverses_addRoleAssingees tags: - Dataverses parameters: - description: Group alias within the dataverse. required: true name: aliasInOwner in: path schema: type: string - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string requestBody: description: JSON array of role assignee identifiers to add. content: application/json: schema: type: array items: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/groups/{aliasInOwner}/roleAssignees/{roleAssigneeIdentifier}: delete: summary: Remove one role assignee from an explicit group description: Removes one role assignee identifier from an explicit group. operationId: Dataverses_deleteRoleAssingee tags: - Dataverses parameters: - description: Group alias within the dataverse. required: true name: aliasInOwner in: path schema: type: string - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string - description: Role assignee identifier to remove from the group. required: true name: roleAssigneeIdentifier in: path schema: type: string pattern: .* responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] put: summary: Append one role assignee to an explicit group description: Adds one role assignee identifier to an explicit group. operationId: Dataverses_addRoleAssingee tags: - Dataverses parameters: - description: Group alias within the dataverse. required: true name: aliasInOwner in: path schema: type: string - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string - description: Role assignee identifier to add to the group. required: true name: roleAssigneeIdentifier in: path schema: type: string pattern: .* responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/guestbookResponses: get: summary: Export guestbook responses for a dataverse description: Streams guestbook response data for datasets in a dataverse as CSV. operationId: Dataverses_getGuestbookResponsesByDataverse tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string - description: Guestbook database id used to filter responses. name: guestbookId in: query schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/inputLevels: put: summary: Assign dataverse input levels description: Replaces dataset field input-level settings for a dataverse. operationId: Dataverses_updateInputLevels tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string requestBody: description: JSON array of input-level settings for dataset fields. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] get: summary: Read dataverse input levels description: Returns dataset field input-level settings for a dataverse. operationId: Dataverses_getInputLevels tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/links: get: summary: Read dataverse links description: Returns dataverses and datasets linked from a dataverse and dataverses linking to it. operationId: Dataverses_listLinks tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/locallyFairRoleAssignees: put: summary: Replaces locally FAIR role assignees description: Replaces the full locally FAIR role assignee identifier set for a dataverse and reindexes the dataverse. operationId: Dataverses_setLocallyFairRoleAssignees tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string requestBody: description: JSON array of role assignee identifiers to configure for locally FAIR metadata access. content: application/json: schema: type: array items: type: string required: true responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] get: summary: Lists locally FAIR role assignees description: Lists role assignee identifiers configured for locally FAIR metadata access in a dataverse. operationId: Dataverses_listLocallyFairRoleAssignees tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /dataverses/{identifier}/locallyFairRoleAssignees/{roleAssigneeIdentifier}: delete: summary: Removes a locally FAIR role assignee description: Removes one role assignee identifier from the locally FAIR metadata access set for a dataverse and reindexes the dataverse. operationId: Dataverses_deleteLocallyFairRoleAssignee tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string - description: Role assignee identifier to remove from locally FAIR metadata access. required: true name: roleAssigneeIdentifier in: path schema: type: string pattern: .* responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] put: summary: Adds a locally FAIR role assignee description: Adds one role assignee identifier to the locally FAIR metadata access set for a dataverse and reindexes the dataverse. operationId: Dataverses_addLocallyFairRoleAssignee tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string - description: "Role assignee identifier to add, such as a user or group identifier." required: true name: roleAssigneeIdentifier in: path schema: type: string pattern: .* responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /dataverses/{identifier}/metadatablockfacets: post: summary: Assign metadata block facets description: Replaces metadata block facets on a dataverse that is a metadata-block-facet root. operationId: Dataverses_setMetadataBlockFacets tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string requestBody: description: JSON array of metadata block names to use as facets. content: application/json: schema: type: array items: type: string required: true responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] get: summary: Read metadata block facets description: Returns metadata block facet settings for a dataverse. operationId: Dataverses_listMetadataBlockFacets tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /dataverses/{identifier}/metadatablockfacets/isRoot: post: summary: Assign metadata block facet root status description: Changes whether a dataverse is a metadata-block-facet root. operationId: Dataverses_updateMetadataBlockFacetsRoot tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string requestBody: description: Boolean text indicating whether the dataverse is a metadata-block-facet root. content: application/json: schema: type: string required: true responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /dataverses/{identifier}/metadatablocks: post: summary: Assign metadata blocks to a dataverse description: Replaces the metadata blocks configured directly on a dataverse. operationId: Dataverses_setMetadataBlocks tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string requestBody: description: JSON array of metadata block ids or names. content: '*/*': schema: type: string required: true responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] get: summary: Read dataverse metadata blocks description: "Lists metadata blocks configured for a dataverse, optionally including\ \ dataset field types." operationId: Dataverses_listMetadataBlocks tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string - description: Dataset type name used to filter metadata blocks. name: datasetType in: query schema: type: string - description: "When true, include only metadata blocks displayed on dataset\ \ creation." name: onlyDisplayedOnCreate in: query schema: type: boolean - description: Whether to include dataset field type definitions. name: returnDatasetFieldTypes in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/metadatablocks/:isRoot: post: summary: Set metadata-block root status through legacy route description: Changes whether a dataverse is a metadata-block root using the legacy route. operationId: Dataverses_setMetadataRoot_legacy tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string requestBody: description: Boolean text indicating whether the dataverse is a metadata-block root. content: '*/*': schema: type: string required: true responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] get: summary: Read metadata-block root status through legacy route description: Returns whether a dataverse is a metadata-block root using the legacy route. operationId: Dataverses_getMetadataRoot_legacy tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/metadatablocks/isRoot: put: summary: Assign metadata-block root status description: Changes whether a dataverse is a metadata-block root. operationId: Dataverses_setMetadataRoot tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string requestBody: description: Boolean text indicating whether the dataverse is a metadata-block root. content: '*/*': schema: type: string required: true responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] get: summary: Read metadata-block root status description: Returns whether a dataverse is a metadata-block root. operationId: Dataverses_getMetadataRoot tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /dataverses/{identifier}/roles: get: summary: Read dataverse roles description: Lists roles available on a dataverse. operationId: Dataverses_listRoles tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] post: summary: Create a dataverse role description: Creates a role scoped to the selected dataverse. operationId: Dataverses_createRole tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string requestBody: description: "Role definition containing alias, name, description, and permissions." content: '*/*': schema: $ref: "#/components/schemas/RoleDTO" required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/storage/quota: put: summary: Assign dataverse storage quota description: Sets the dataverse storage quota in bytes. operationId: Dataverses_setCollectionQuota tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string requestBody: description: Quota value in bytes. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] get: summary: Read dataverse storage quota description: "Returns the storage quota for a dataverse, optionally including\ \ inherited quota values." operationId: Dataverses_getCollectionQuota tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string - description: Whether to include inherited quota settings in the response. name: showInherited in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Clear dataverse storage quota description: Deletes the explicit storage quota for a dataverse. operationId: Dataverses_deleteCollectionQuota tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/storage/use: get: summary: Read dataverse storage use description: Returns the recorded storage use for a dataverse. operationId: Dataverses_getCollectionStorageUse tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/storageDriver: put: summary: Assign dataverse storage driver description: Sets the storage driver for a dataverse by driver label. operationId: Dataverses_setStorageDriver tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string requestBody: description: Storage driver label to assign. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Reset dataverse storage driver description: Clears the explicit storage driver setting so the dataverse uses the default driver. operationId: Dataverses_resetStorageDriver tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] get: summary: Read dataverse storage driver description: "Returns the storage driver configured for a dataverse, optionally\ \ resolving the effective inherited driver." operationId: Dataverses_getStorageDriver tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string - description: Whether to resolve the effective inherited storage driver. name: getEffective in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/storagesize: get: summary: Read dataverse storage size description: "Returns the storage size for a dataverse, optionally including\ \ cached size data." operationId: Dataverses_getStorageSize tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string - description: Whether to include cached storage size values. name: includeCached in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/template/default: delete: summary: Clear the default metadata template description: Removes the default metadata template setting from a dataverse. operationId: Dataverses_removeDefaultTemplate tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/template/default/{templateId}: post: summary: Assign the default metadata template description: Sets the default metadata template for a dataverse. operationId: Dataverses_setDefaultTemplate tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string - description: Template database id. required: true name: templateId in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/templates: get: summary: Read dataverse templates description: Lists metadata templates available in a dataverse. operationId: Dataverses_getTemplates tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] post: summary: Create a metadata template description: Creates a metadata template owned by a dataverse. operationId: Dataverses_createTemplate tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string requestBody: description: Template JSON containing template metadata fields and settings. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/userPermissions: get: summary: Read user permissions on a dataverse description: Returns booleans for the requesting user's key dataverse permissions. operationId: Dataverses_getUserPermissionsOnDataverse tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/validateDatasetJson: post: summary: Validate dataset JSON description: Validates a dataset JSON payload against the selected dataverse. operationId: Dataverses_validateDatasetJson tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier." required: true name: identifier in: path schema: type: string requestBody: description: Dataset JSON to validate. content: application/json: schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{identifier}/{type}/linkingDataverses: get: summary: Search dataverses for linking description: "Lists dataverses that can be linked to the selected dataverse\ \ object, optionally filtered by search text and existing link status." operationId: Dataverses_getLinkingDataverseList tags: - Dataverses parameters: - description: Dataverse object id or persistent identifier. required: true name: identifier in: path schema: type: string - description: Dataverse object type used to resolve the identifier. required: true name: type in: path schema: type: string - description: Whether to return dataverses already linking to the object. name: alreadyLinking in: query schema: type: boolean - description: Search text used to filter dataverses. name: searchTerm in: query schema: type: string responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /dataverses/{id}/move/{targetDataverseAlias}: post: summary: Move a dataverse description: Moves a dataverse collection to a different parent dataverse. operationId: Dataverses_moveDataverse tags: - Dataverses parameters: - description: "Dataverse alias, id, or persistent identifier to move." required: true name: id in: path schema: type: string - description: Alias of the target parent dataverse. required: true name: targetDataverseAlias in: path schema: type: string - description: Whether to force the move when warnings would otherwise block it. name: forceMove in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{id}/template: get: summary: Read a metadata template description: Returns one metadata template by database id. operationId: Dataverses_getTemplate tags: - Dataverses parameters: - description: Template database id. required: true name: id in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Remove a metadata template description: Deletes a metadata template and clears default-template references that point to it. operationId: Dataverses_deleteTemplate tags: - Dataverses parameters: - description: Template database id. required: true name: id in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{linkedDataverseAlias}/link/{linkingDataverseAlias}: put: summary: Link one dataverse from another description: Creates a link from one dataverse to another dataverse. operationId: Dataverses_linkDataverse tags: - Dataverses parameters: - description: Alias of the dataverse being linked. required: true name: linkedDataverseAlias in: path schema: type: string - description: Alias of the dataverse that will contain the link. required: true name: linkingDataverseAlias in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{linkingDataverseId}/deleteLink/{linkedDataverseId}: delete: summary: Remove a dataverse link description: Deletes a link from one dataverse to another linked dataverse. operationId: Dataverses_deleteDataverseLinkingDataverse tags: - Dataverses parameters: - description: Alias or id of the linked dataverse to remove. required: true name: linkedDataverseId in: path schema: type: string - description: Alias or id of the dataverse containing the link. required: true name: linkingDataverseId in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{templateId}/access: put: summary: Revise metadata template terms of access description: Updates terms of use and access settings on a metadata template. operationId: Dataverses_updateTemplateTermsOfAccess tags: - Dataverses parameters: - description: Template database id. required: true name: templateId in: path schema: type: integer format: int64 requestBody: description: JSON terms-of-access payload for the metadata template. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{templateId}/licenseTerms: put: summary: Revise metadata template license terms description: Updates the license or custom terms configured on a metadata template. operationId: Dataverses_updateTemplateLicenseTerms tags: - Dataverses parameters: - description: Template database id. required: true name: templateId in: path schema: type: integer format: int64 - description: Unused replace flag accepted by the endpoint. name: replace in: query schema: type: boolean requestBody: description: "License update request containing a license name, URI, or custom\ \ terms." content: '*/*': schema: $ref: "#/components/schemas/LicenseUpdateRequest" required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /dataverses/{templateId}/metadata: put: summary: Revise metadata template fields description: "Updates a template name, field values, and field instructions." operationId: Dataverses_updateTemplateMetadata tags: - Dataverses parameters: - description: Template database id. required: true name: templateId in: path schema: type: integer format: int64 - description: "When true, replace matching field values instead of merging." name: replace in: query schema: type: boolean requestBody: description: "Template metadata JSON containing name, fields, and optional\ \ instructions." content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /edit/{fileId}: put: summary: Updates tabular file variable metadata description: "Parses DDI XML for a tabular data file and updates variable metadata\ \ on the draft dataset version, creating a draft when needed." operationId: EditDDI_edit tags: - Files parameters: - description: Data file id whose variable metadata is updated. required: true name: fileId in: path schema: type: string requestBody: description: DDI XML containing variable metadata and variable group updates for the tabular file. content: application/xml: schema: type: string format: binary required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /externalTools: get: summary: Lists external tools description: Returns all registered external tools. operationId: ExternalToolsApi_getExternalTools tags: - External Tools responses: "200": description: OK content: '*/*': {} post: summary: Registers an external tool description: Registers an external tool from its manifest when the authenticated user is a superuser. operationId: ExternalToolsApi_addExternalTool tags: - External Tools requestBody: description: External tool manifest JSON to register. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /externalTools/{id}: get: summary: Returns an external tool description: Returns the registered external tool with the specified numeric id. operationId: ExternalToolsApi_getExternalTool tags: - External Tools parameters: - description: Numeric id of the external tool to return. required: true name: id in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} delete: summary: Deletes an external tool description: Deletes the registered external tool with the specified numeric id when the authenticated user is a superuser. operationId: ExternalToolsApi_deleteExternalTool tags: - External Tools parameters: - description: Numeric id of the external tool to delete. required: true name: id in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /files/fixityAlgorithm: get: summary: Show the configured file fixity algorithm description: Reports the checksum algorithm configured for file fixity checks. operationId: Files_getFixityAlgorithm tags: - Files responses: "200": description: OK content: '*/*': {} /files/{id}: get: summary: Returns file metadata description: "Returns file metadata for the latest accessible dataset version,\ \ optionally including dataset version and owner details." operationId: Files_getFileData tags: - Files parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Whether deaccessioned dataset versions are included. name: includeDeaccessioned in: query schema: type: boolean - description: Whether dataset version information is included in the response. name: returnDatasetVersion in: query schema: type: boolean - description: Whether owner information is included in the response. name: returnOwners in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Remove a file from its dataset description: Removes a data file from the dataset draft and deletes the physical file when the file has never been released. operationId: Files_deleteFileInDataset tags: - Files parameters: - description: Data file id or persistent identifier. required: true name: id in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /files/{id}/dataTables: get: summary: Show tabular data tables description: Reports data table metadata associated with a tabular data file after checking file access when needed. operationId: Files_getFileDataTables tags: - Files parameters: - description: Data file id or persistent identifier. required: true name: id in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /files/{id}/downloadCount: get: summary: Show file download count description: Reports the recorded download count for a data file. operationId: Files_getFileDownloadCount tags: - Files parameters: - description: Data file id or persistent identifier. required: true name: id in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /files/{id}/externalTool/{tid}/toolUrl: post: summary: Creates a file external tool URL description: Returns launch URL details for a file-scoped external tool after checking tool configuration and file permissions. operationId: Files_getExternalToolUrl tags: - Files parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: External tool id. name: tid in: path required: true schema: type: integer format: int64 requestBody: description: External tool launch options such as preview mode and locale. content: application/json: schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /files/{id}/extractNcml: post: summary: Extracts NcML metadata description: Extracts NcML metadata from a data file when the requester is a superuser. operationId: Files_extractNcml tags: - Files parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /files/{id}/hasBeenDeleted: get: summary: Check whether a file was deleted description: Reports whether the selected data file has a deletion record. operationId: Files_getHasBeenDeleted tags: - Files parameters: - description: Data file id or persistent identifier. required: true name: id in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /files/{id}/metadata: post: summary: Revise file metadata description: Updates metadata for an existing data file using multipart JSON metadata. operationId: Files_updateFileMetadata tags: - Files parameters: - description: Data file id or persistent identifier. required: true name: id in: path schema: type: string - description: Source last-update timestamp used by external integrations. name: sourceLastUpdateTime in: query schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] get: summary: Returns published file metadata description: Returns the latest published metadata for a data file as JSON text. operationId: Files_getFileMetadata tags: - Files parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /files/{id}/metadata/categories: post: summary: Apply category labels to file metadata description: Adds or replaces category labels on the selected file metadata record. operationId: Files_setFileCategories tags: - Files parameters: - description: Data file id or persistent identifier. required: true name: id in: path schema: type: string - description: "When true, replace existing categories before adding the supplied\ \ values." name: replace in: query schema: type: boolean requestBody: description: JSON object containing a categories array. content: '*/*': schema: type: string required: true responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /files/{id}/metadata/draft: get: summary: Returns draft file metadata description: Returns draft metadata for a data file when the requester may access the draft. operationId: Files_getFileMetadataDraft tags: - Files parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /files/{id}/metadata/tabularTags: post: summary: Apply tabular tags to a file description: Adds or replaces tabular data tags on a tabular data file. operationId: Files_setFileTabularTags tags: - Files parameters: - description: Data file id or persistent identifier. required: true name: id in: path schema: type: string - description: "When true, replace existing tabular tags before adding the supplied\ \ values." name: replace in: query schema: type: boolean requestBody: description: JSON object containing a tabularTags array. content: '*/*': schema: type: string required: true responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /files/{id}/metadata/{fmid}/toolparams/{tid}: get: summary: Resolve external tool parameters for file metadata description: Reports the parameter payload and allowed API calls for an external tool working with a specific file metadata record. operationId: Files_getExternalToolFMParams tags: - Files parameters: - description: File metadata database id. required: true name: fmid in: path schema: type: integer format: int64 - description: Data file id or persistent identifier. required: true name: id in: path schema: type: string - description: External tool database id. required: true name: tid in: path schema: type: integer format: int64 - description: Locale used when creating the external tool parameter payload. name: locale in: query schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /files/{id}/prov-freeform: get: summary: Returns free-form provenance for a data file description: Returns stored free-form provenance text for the specified data file. operationId: Prov_getProvFreeForm tags: - Files parameters: - description: Data file id or persistent identifier whose free-form provenance is returned. required: true name: id in: path schema: type: string requestBody: description: Unused request body accepted by the endpoint. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] post: summary: Adds free-form provenance to a data file description: Stores free-form provenance text for a data file from the text field of the supplied JSON and updates the dataset draft version. operationId: Prov_addProvFreeForm tags: - Files parameters: - description: Data file id or persistent identifier whose free-form provenance is updated. required: true name: id in: path schema: type: string requestBody: description: JSON object containing a text field with free-form provenance. content: application/json: schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /files/{id}/prov-json: get: summary: Returns PROV JSON for a data file description: Returns stored PROV JSON for the specified data file. operationId: Prov_getProvJson tags: - Files parameters: - description: Data file id or persistent identifier whose PROV JSON is returned. required: true name: id in: path schema: type: string requestBody: description: Unused request body accepted by the endpoint. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Deletes PROV JSON from a data file description: Deletes stored PROV JSON from an unreleased data file. operationId: Prov_deleteProvJson tags: - Files parameters: - description: Data file id or persistent identifier whose PROV JSON is deleted. required: true name: id in: path schema: type: string requestBody: description: Unused request body accepted by the endpoint. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] post: summary: Adds PROV JSON to a data file description: Validates and stores PROV JSON for a data file after checking that the requested entity name exists in the provenance graph. operationId: Prov_addProvJson tags: - Files parameters: - description: Data file id or persistent identifier whose provenance is updated. required: true name: id in: path schema: type: string - description: Entity name in the PROV JSON graph that represents the data file. required: true name: entityName in: query schema: type: string requestBody: description: PROV JSON document to validate and store for the data file. content: application/json: schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /files/{id}/redetect: post: summary: Re-evaluate file content type description: Runs content-type detection for a non-tabular data file and optionally reports the result without saving it. operationId: Files_redetectDatafile tags: - Files parameters: - description: Data file id or persistent identifier. required: true name: id in: path schema: type: string - description: "When true, report the detected type without saving the change." name: dryRun in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /files/{id}/reingest: post: summary: Reingests a data file description: Starts ingest processing for a data file when the requester is a superuser. operationId: Files_reingest tags: - Files parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /files/{id}/replace: post: summary: Replace a file on a dataset description: Replace a file to a dataset operationId: Files_replaceFileInDataset tags: - replaceFilesInDataset parameters: - description: Data file id or persistent identifier for the file being replaced. required: true name: id in: path schema: type: string requestBody: description: Multipart request containing replacement file content and JSON replacement metadata. content: multipart/form-data: schema: type: string required: true responses: "200": description: File replaced successfully on the dataset content: application/json: schema: {} security: - DataverseApiKey: [] /files/{id}/restrict: put: summary: Change file restriction status description: "Applies restricted or unrestricted status to a data file, with\ \ optional access-request and terms-of-access settings." operationId: Files_restrictFileInDataset tags: - Files parameters: - description: Data file id or persistent identifier. required: true name: id in: path schema: type: string requestBody: description: "Boolean value or JSON object containing restrict, enableAccessRequest,\ \ and termsOfAccess fields." content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /files/{id}/uningest: post: summary: Uningests a data file description: Converts an ingested tabular data file back to a regular file when the requester is a superuser. operationId: Files_uningestDatafile tags: - Files parameters: - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /files/{id}/versionDifferences: get: summary: Compare file versions description: Reports metadata differences across versions for a data file. operationId: Files_getFileVersionsList tags: - Files parameters: - description: Data file id or persistent identifier. required: true name: id in: path schema: type: string - description: Maximum number of version-difference records to return. name: limit in: query schema: type: integer format: int32 - description: Number of version-difference records to skip before returning results. name: offset in: query schema: type: integer format: int32 responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /files/{id}/versions/{datasetVersionId}: get: summary: Returns file metadata for a version description: "Returns file metadata for the requested dataset version, optionally\ \ including dataset version and owner details." operationId: Files_getFileDataForVersion tags: - Files parameters: - description: Dataset version selector. name: datasetVersionId in: path required: true schema: type: string - description: Resource id or persistent identifier. name: id in: path required: true schema: type: string - description: Whether deaccessioned dataset versions are included. name: includeDeaccessioned in: query schema: type: boolean - description: Whether dataset version information is included in the response. name: returnDatasetVersion in: query schema: type: boolean - description: Whether owner information is included in the response. name: returnOwners in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /files/{id}/versions/{dsVersionString}/citation: get: summary: Format a citation for a file version description: Reports the citation text for a data file in the requested dataset version. operationId: Files_getFileCitationByVersion tags: - Files parameters: - description: "Dataset version label, such as 1.0, :draft, or :latest-published." required: true name: dsVersionString in: path schema: type: string - description: Data file id or persistent identifier. required: true name: id in: path schema: type: string - description: Whether deaccessioned dataset versions may be used. name: includeDeaccessioned in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /guestbooks/{identifier}: post: summary: Creates a guestbook description: Creates a guestbook in the specified dataverse when the requester can edit that dataverse. operationId: Guestbooks_createGuestbook tags: - Guestbooks parameters: - description: Dataverse alias where the guestbook is created. required: true name: identifier in: path schema: type: string requestBody: description: Guestbook JSON definition to parse and create. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /guestbooks/{identifier}/list: get: summary: Lists guestbooks for a dataverse description: "Returns guestbooks configured for a dataverse, optionally including\ \ inherited guestbooks and usage statistics." operationId: Guestbooks_getGuestbooks tags: - Guestbooks parameters: - description: Dataverse alias whose guestbooks are listed. required: true name: identifier in: path schema: type: string - description: Include guestbooks inherited from parent dataverses. name: includeInherited in: query schema: type: boolean - description: Include guestbook usage and response counts. name: includeStats in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /guestbooks/{identifier}/{id}/enabled: put: summary: Sets guestbook enabled state description: Updates whether a guestbook in the specified dataverse is enabled. operationId: Guestbooks_enableGuestbook tags: - Guestbooks parameters: - description: Numeric id of the guestbook to update. required: true name: id in: path schema: type: string - description: Dataverse alias containing the guestbook. required: true name: identifier in: path schema: type: string requestBody: description: Boolean text indicating whether the guestbook is enabled. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /guestbooks/{id}: put: summary: Updates a guestbook description: Updates a guestbook definition from JSON when the requester may edit the owning dataverse. operationId: Guestbooks_updateGuestbook tags: - Guestbooks parameters: - description: Numeric id of the guestbook to update. required: true name: id in: path schema: type: integer format: int64 requestBody: description: Guestbook JSON definition to parse and apply. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] get: summary: Returns a guestbook description: Returns the guestbook with the specified numeric id. operationId: Guestbooks_getGuestbook tags: - Guestbooks parameters: - description: Numeric id of the guestbook to return. required: true name: id in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /guestbooks/{id}/responses: get: summary: Lists guestbook responses description: "Returns guestbook metadata and response records, with pagination\ \ links when a limit is supplied." operationId: Guestbooks_getResponses tags: - Guestbooks parameters: - description: Numeric id of the guestbook whose responses are listed. required: true name: id in: path schema: type: integer format: int64 - description: Maximum number of response records to return. name: limit in: query schema: type: integer format: int32 - description: Response record offset. name: offset in: query schema: type: integer format: int32 responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /harvest/clients: get: summary: Lists harvesting clients description: Returns harvesting client configurations visible to the authenticated requester. operationId: HarvestingClients_harvestingClients tags: - Admin responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /harvest/clients/{nickName}: put: summary: Updates a harvesting client description: Updates editable harvesting client fields when the authenticated user is a superuser. operationId: HarvestingClients_modifyHarvestingClient tags: - Admin parameters: - description: Nickname of the harvesting client to update. required: true name: nickName in: path schema: type: string requestBody: description: "Harvesting client update JSON containing editable fields such\ \ as harvest URL, archive URL, metadata format, set, and custom headers." content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] get: summary: Returns a harvesting client description: Returns the harvesting client configuration with the specified nickname when the requester is authorized to view it. operationId: HarvestingClients_harvestingClient tags: - Admin parameters: - description: Harvesting client nickname to return. required: true name: nickName in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Deletes a harvesting client description: Starts asynchronous deletion of a harvesting client when the authenticated user is a superuser and no harvest or delete is already in progress. operationId: HarvestingClients_deleteHarvestingClient tags: - Admin parameters: - description: Nickname of the harvesting client to delete. required: true name: nickName in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] post: summary: Creates a harvesting client description: Creates a harvesting client with the specified nickname when the authenticated user is a superuser. operationId: HarvestingClients_createHarvestingClient tags: - Admin parameters: - description: Nickname assigned to the harvesting client. required: true name: nickName in: path schema: type: string requestBody: description: "Harvesting client JSON containing dataverse alias, harvest URL,\ \ archive URL, metadata format, and optional settings." content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /harvest/clients/{nickName}/run: post: summary: Starts a harvesting job description: Starts an asynchronous harvesting job for the specified client when the authenticated user is a superuser. operationId: HarvestingClients_startHarvestingJob tags: - Admin parameters: - description: Nickname of the harvesting client to run. required: true name: nickName in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /harvest/server/oaisets: get: summary: Lists OAI sets description: "Returns all configured OAI sets with name, spec, description,\ \ definition, and version." operationId: HarvestingServer_oaiSets tags: - Admin parameters: - description: Legacy key value accepted by the endpoint. name: key in: query schema: type: string responses: "200": description: OK content: '*/*': {} /harvest/server/oaisets/add: post: summary: Creates an OAI set description: "Creates an OAI set from name, definition, and optional description\ \ JSON when the authenticated user is a superuser." operationId: HarvestingServer_createOaiSet tags: - Admin requestBody: description: "OAI set JSON containing name, definition, and optional description." content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /harvest/server/oaisets/{specname}: get: summary: Returns an OAI set description: Returns the OAI set with the specified set specification name. operationId: HarvestingServer_oaiSet tags: - Admin parameters: - description: OAI set specification name to return. required: true name: specname in: path schema: type: string - description: Legacy key value accepted by the endpoint. name: key in: query schema: type: string responses: "200": description: OK content: '*/*': {} put: summary: Updates an OAI set description: Updates the definition or description of an OAI set when the authenticated user is a superuser. operationId: HarvestingServer_modifyOaiSet tags: - Admin parameters: - description: OAI set specification name to update. required: true name: specname in: path schema: type: string requestBody: description: "OAI set update JSON containing definition, description, or both." content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Deletes an OAI set description: Marks an OAI set for deletion and removes it when the authenticated user is a superuser. operationId: HarvestingServer_deleteOaiSet tags: - Admin parameters: - description: OAI set specification name to delete. required: true name: specname in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /harvest/server/oaisets/{specname}/datasets: get: summary: Lists datasets in an OAI set description: Validates that the specified OAI set exists and returns the current placeholder response for dataset listing. operationId: HarvestingServer_oaiSetListDatasets tags: - Admin parameters: - description: OAI set specification name whose datasets are requested. required: true name: specname in: path schema: type: string - description: Legacy key value accepted by the endpoint. name: key in: query schema: type: string responses: "200": description: OK content: '*/*': {} /inbox: post: summary: Accepts a Linked Data Notification description: Accepts a whitelisted Linked Data Notification inbox message and dispatches supported relationship announcements. operationId: LDNInbox_acceptMessage requestBody: description: Linked Data Notification message body encoded as JSON-LD. content: application/ld+json: schema: type: string application/json-ld: schema: type: string required: true responses: "200": description: OK content: '*/*': {} /info/apiTermsOfUse: get: summary: Returns API terms of use description: Returns the configured API terms of use for this Dataverse installation. operationId: Info_getTermsOfUse tags: - Info responses: "200": description: OK content: '*/*': {} /info/applicationTermsOfUse: get: summary: Returns application terms of use description: "Returns the general application terms of use that users agree\ \ to during signup, optionally localized by language code." operationId: Info_getApplicationTermsOfUse tags: - Info parameters: - description: Two-character language code. example: en required: false schema: type: string name: lang in: query responses: "200": description: Application Terms of Use (General Terms of Use) that must be agreed to at signup. content: '*/*': {} /info/exportFormats: get: summary: Lists export formats description: "Returns dataset export formats with display name, media type,\ \ harvestability, user-interface visibility, and XML metadata when available." operationId: Info_getExportFormats tags: - Info responses: "200": description: OK content: '*/*': {} /info/metrics/accounts: get: summary: Calculates total account count description: Calculates the number of user accounts through the current month. operationId: Metrics_getAccountsAllTime tags: - Info responses: "200": description: OK content: '*/*': {} /info/metrics/accounts/monthly: get: summary: Calculates monthly account counts description: Calculates a monthly time series of user account counts as JSON or CSV. operationId: Metrics_getAccountsTimeSeries tags: - Info responses: "200": description: OK content: text/csv: {} application/json: schema: {} /info/metrics/accounts/pastDays/{days}: get: summary: Calculates recent account count description: Calculates the number of user accounts created during the specified number of past days. operationId: Metrics_getAccountsPastDays tags: - Info parameters: - description: Positive number of past days included in the metric. required: true name: days in: path schema: type: integer format: int32 responses: "200": description: OK content: '*/*': {} /info/metrics/accounts/toMonth/{yyyymm}: get: summary: Calculates account count through a month description: Calculates the number of user accounts through the specified month. operationId: Metrics_getAccountsToMonth tags: - Info parameters: - description: "Year and month cutoff for the metric, formatted as YYYYMM." required: true name: yyyymm in: path schema: type: string responses: "200": description: OK content: '*/*': {} /info/metrics/datasets: get: summary: Calculates total dataset count description: "Calculates the number of released datasets through the current\ \ month, optionally filtered by storage location and parent dataverse." operationId: Metrics_getDatasetsAllTime tags: - Info parameters: - description: Storage location filter for the dataset metric. name: dataLocation in: query schema: type: string - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: '*/*': {} /info/metrics/datasets/bySubject: get: summary: Calculates dataset counts by subject description: "Calculates released dataset counts grouped by subject through\ \ the current month as JSON or CSV, optionally filtered by storage location\ \ and parent dataverse." operationId: Metrics_getDatasetsBySubject tags: - Info parameters: - description: Storage location filter for the dataset metric. name: dataLocation in: query schema: type: string - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: text/csv: {} application/json: schema: {} /info/metrics/datasets/bySubject/toMonth/{yyyymm}: get: summary: Calculates dataset counts by subject through a month description: "Calculates released dataset counts grouped by subject through\ \ the specified month as JSON or CSV, optionally filtered by storage location\ \ and parent dataverse." operationId: Metrics_getDatasetsBySubjectToMonth tags: - Info parameters: - description: "Year and month cutoff for the metric, formatted as YYYYMM." required: true name: yyyymm in: path schema: type: string - description: Storage location filter for the dataset metric. name: dataLocation in: query schema: type: string - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: text/csv: {} application/json: schema: {} /info/metrics/datasets/monthly: get: summary: Calculates monthly dataset counts description: "Calculates a monthly time series of released dataset counts as\ \ JSON or CSV, optionally filtered by storage location and parent dataverse." operationId: Metrics_getDatasetsTimeSeriest tags: - Info parameters: - description: Storage location filter for the dataset metric. name: dataLocation in: query schema: type: string - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: text/csv: {} application/json: schema: {} /info/metrics/datasets/pastDays/{days}: get: summary: Calculates recent dataset count description: "Calculates the number of released datasets created during the\ \ specified number of past days, optionally filtered by storage location and\ \ parent dataverse." operationId: Metrics_getDatasetsPastDays tags: - Info parameters: - description: Positive number of past days included in the metric. required: true name: days in: path schema: type: integer format: int32 - description: Storage location filter for the dataset metric. name: dataLocation in: query schema: type: string - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: '*/*': {} /info/metrics/datasets/toMonth/{yyyymm}: get: summary: Calculates dataset count through a month description: "Calculates the number of released datasets through the specified\ \ month, optionally filtered by storage location and parent dataverse." operationId: Metrics_getDatasetsToMonth tags: - Info parameters: - description: "Year and month cutoff for the metric, formatted as YYYYMM." required: true name: yyyymm in: path schema: type: string - description: Storage location filter for the dataset metric. name: dataLocation in: query schema: type: string - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: '*/*': {} /info/metrics/dataverses: get: summary: Calculates total dataverse count description: "Calculates the number of released dataverses through the current\ \ month, optionally scoped to a released parent dataverse." operationId: Metrics_getDataversesAllTime tags: - Info parameters: - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: '*/*': {} /info/metrics/dataverses/byCategory: get: summary: Calculates dataverse counts by category description: "Calculates released dataverse counts grouped by dataverse category\ \ as JSON or CSV, optionally scoped to a released parent dataverse." operationId: Metrics_getDataversesByCategory tags: - Info parameters: - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: text/csv: {} application/json: schema: {} /info/metrics/dataverses/bySubject: get: summary: Calculates dataverse counts by subject description: "Calculates released dataverse counts grouped by subject as JSON\ \ or CSV, optionally scoped to a released parent dataverse." operationId: Metrics_getDataversesBySubject tags: - Info parameters: - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: text/csv: {} application/json: schema: {} /info/metrics/dataverses/monthly: get: summary: Calculates monthly dataverse counts description: "Calculates a monthly time series of released dataverse counts\ \ as JSON or CSV, optionally scoped to a released parent dataverse." operationId: Metrics_getDataversesTimeSeries tags: - Info parameters: - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: text/csv: {} application/json: schema: {} /info/metrics/dataverses/pastDays/{days}: get: summary: Calculates recent dataverse count description: "Calculates the number of released dataverses created during the\ \ specified number of past days, optionally scoped to a released parent dataverse." operationId: Metrics_getDataversesPastDays tags: - Info parameters: - description: Positive number of past days included in the metric. required: true name: days in: path schema: type: integer format: int32 - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: '*/*': {} /info/metrics/dataverses/toMonth/{yyyymm}: get: summary: Calculates dataverse count through a month description: "Calculates the number of released dataverses through the specified\ \ month, optionally scoped to a released parent dataverse." operationId: Metrics_getDataversesToMonth tags: - Info parameters: - description: "Year and month cutoff for the metric, formatted as YYYYMM." required: true name: yyyymm in: path schema: type: string - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: '*/*': {} /info/metrics/downloads: get: summary: Calculates total download count description: "Calculates the number of file downloads through the current month,\ \ optionally scoped to a released parent dataverse." operationId: Metrics_getDownloadsAllTime tags: - Info parameters: - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: '*/*': {} /info/metrics/downloads/monthly: get: summary: Calculates monthly download counts description: "Calculates a monthly time series of file download counts as JSON\ \ or CSV, optionally scoped to a released parent dataverse." operationId: Metrics_getDownloadsTimeSeries tags: - Info parameters: - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: text/csv: {} application/json: schema: {} /info/metrics/downloads/pastDays/{days}: get: summary: Calculates recent download count description: "Calculates the number of file downloads during the specified number\ \ of past days, optionally scoped to a released parent dataverse." operationId: Metrics_getDownloadsPastDays tags: - Info parameters: - description: Positive number of past days included in the metric. required: true name: days in: path schema: type: integer format: int32 - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: '*/*': {} /info/metrics/downloads/toMonth/{yyyymm}: get: summary: Calculates download count through a month description: "Calculates the number of file downloads through the specified\ \ month, optionally scoped to a released parent dataverse." operationId: Metrics_getDownloadsToMonth tags: - Info parameters: - description: "Year and month cutoff for the metric, formatted as YYYYMM." required: true name: yyyymm in: path schema: type: string - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: '*/*': {} /info/metrics/filedownloads: get: summary: Calculates file download counts description: "Calculates file download counts by file through the current month\ \ as JSON or CSV, optionally scoped to a released parent dataverse." operationId: Metrics_getFileDownloadsAllTime tags: - Info parameters: - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: text/csv: {} application/json: schema: {} /info/metrics/filedownloads/monthly: get: summary: Calculates monthly file download counts description: "Calculates a monthly time series of file download counts by file\ \ as JSON or CSV, optionally scoped to a released parent dataverse." operationId: Metrics_getFileDownloadsTimeSeries tags: - Info parameters: - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: text/csv: {} application/json: schema: {} /info/metrics/filedownloads/toMonth/{yyyymm}: get: summary: Calculates file download counts through a month description: "Calculates file download counts by file through the specified\ \ month as JSON or CSV, optionally scoped to a released parent dataverse." operationId: Metrics_getFileDownloadsToMonth tags: - Info parameters: - description: "Year and month cutoff for the metric, formatted as YYYYMM." required: true name: yyyymm in: path schema: type: string - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: text/csv: {} application/json: schema: {} /info/metrics/files: get: summary: Calculates total file count description: "Calculates the number of released files through the current month,\ \ optionally scoped to a released parent dataverse." operationId: Metrics_getFilesAllTime tags: - Info parameters: - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: '*/*': {} /info/metrics/files/byType: get: summary: Calculates file counts by type description: "Calculates released file counts and sizes grouped by content type\ \ as JSON or CSV, optionally scoped to a released parent dataverse." operationId: Metrics_getFilesByType tags: - Info parameters: - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: text/csv: {} application/json: schema: {} /info/metrics/files/byType/monthly: get: summary: Calculates monthly file counts by type description: "Calculates a monthly time series of released file counts and sizes\ \ grouped by content type as JSON or CSV, optionally scoped to a released\ \ parent dataverse." operationId: Metrics_getFilesByTypeTimeSeries tags: - Info parameters: - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: text/csv: {} application/json: schema: {} /info/metrics/files/monthly: get: summary: Calculates monthly file counts description: "Calculates a monthly time series of released file counts as JSON\ \ or CSV, optionally scoped to a released parent dataverse." operationId: Metrics_getFilesTimeSeries tags: - Info parameters: - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: text/csv: {} application/json: schema: {} /info/metrics/files/pastDays/{days}: get: summary: Calculates recent file count description: "Calculates the number of released files created during the specified\ \ number of past days, optionally scoped to a released parent dataverse." operationId: Metrics_getFilesPastDays tags: - Info parameters: - description: Positive number of past days included in the metric. required: true name: days in: path schema: type: integer format: int32 - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: '*/*': {} /info/metrics/files/toMonth/{yyyymm}: get: summary: Calculates file count through a month description: "Calculates the number of released files through the specified\ \ month, optionally scoped to a released parent dataverse." operationId: Metrics_getFilesToMonth tags: - Info parameters: - description: "Year and month cutoff for the metric, formatted as YYYYMM." required: true name: yyyymm in: path schema: type: string - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: '*/*': {} /info/metrics/makeDataCount/{metric}: get: summary: Calculates a Make Data Count metric description: "Calculates the requested Make Data Count metric through the current\ \ month, optionally filtered by country and parent dataverse." operationId: Metrics_getMakeDataCountMetricCurrentMonth tags: - Info parameters: - description: Make Data Count metric name to return. required: true name: metric in: path schema: type: string - description: ISO country code used to filter the metric. name: country in: query schema: type: string - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: '*/*': {} /info/metrics/makeDataCount/{metric}/monthly: get: summary: Calculates monthly Make Data Count metrics description: "Calculates a monthly time series for the requested Make Data Count\ \ metric as JSON or CSV, optionally filtered by country and parent dataverse." operationId: Metrics_getMakeDataCountMetricTimeSeries tags: - Info parameters: - description: Make Data Count metric name to return. required: true name: metric in: path schema: type: string - description: ISO country code used to filter the metric. name: country in: query schema: type: string - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: text/csv: {} application/json: schema: {} /info/metrics/makeDataCount/{metric}/toMonth/{yyyymm}: get: summary: Calculates a Make Data Count metric through a month description: "Calculates the requested Make Data Count metric through the specified\ \ month, optionally filtered by country and parent dataverse." operationId: Metrics_getMakeDataCountMetricToMonth tags: - Info parameters: - description: Make Data Count metric name to return. required: true name: metric in: path schema: type: string - description: "Year and month cutoff for the metric, formatted as YYYYMM." required: true name: yyyymm in: path schema: type: string - description: ISO country code used to filter the metric. name: country in: query schema: type: string - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: '*/*': {} /info/metrics/tree: get: summary: Calculates the dataverse tree metric description: "Calculates the released dataverse tree metric through the current\ \ month, optionally scoped to a released parent dataverse." operationId: Metrics_getDataversesTree tags: - Info parameters: - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: '*/*': {} /info/metrics/tree/toMonth/{yyyymm}: get: summary: Calculates the dataverse tree metric through a month description: "Calculates the released dataverse tree metric through the specified\ \ month, optionally scoped to a released parent dataverse." operationId: Metrics_getDataversesTreeToMonth tags: - Info parameters: - description: "Year and month cutoff for the metric, formatted as YYYYMM." required: true name: yyyymm in: path schema: type: string - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: '*/*': {} /info/metrics/uniquedownloads: get: summary: Calculates unique dataset download counts description: "Calculates unique dataset download counts through the current\ \ month as JSON or CSV, optionally scoped to a released parent dataverse." operationId: Metrics_getUniqueDownloadsAllTime tags: - Info parameters: - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: text/csv: {} application/json: schema: {} /info/metrics/uniquedownloads/monthly: get: summary: Calculates monthly unique dataset download counts description: "Calculates a monthly time series of unique dataset download counts\ \ as JSON or CSV, optionally scoped to a released parent dataverse." operationId: Metrics_getUniqueDownloadsTimeSeries tags: - Info parameters: - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: text/csv: {} application/json: schema: {} /info/metrics/uniquedownloads/toMonth/{yyyymm}: get: summary: Calculates unique dataset download counts through a month description: "Calculates unique dataset download counts through the specified\ \ month as JSON or CSV, optionally scoped to a released parent dataverse." operationId: Metrics_getUniqueDownloadsToMonth tags: - Info parameters: - description: "Year and month cutoff for the metric, formatted as YYYYMM." required: true name: yyyymm in: path schema: type: string - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: text/csv: {} application/json: schema: {} /info/metrics/uniquefiledownloads: get: summary: Calculates unique file download counts description: "Calculates unique file download counts by file through the current\ \ month as JSON or CSV, optionally scoped to a released parent dataverse." operationId: Metrics_getUniqueFileDownloadsAllTime tags: - Info parameters: - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: text/csv: {} application/json: schema: {} /info/metrics/uniquefiledownloads/monthly: get: summary: Calculates monthly unique file download counts description: "Calculates a monthly time series of unique file download counts\ \ by file as JSON or CSV, optionally scoped to a released parent dataverse." operationId: Metrics_getUniqueFileDownloadsTimeSeries tags: - Info parameters: - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: text/csv: {} application/json: schema: {} /info/metrics/uniquefiledownloads/toMonth/{yyyymm}: get: summary: Calculates unique file download counts through a month description: "Calculates unique file download counts by file through the specified\ \ month as JSON or CSV, optionally scoped to a released parent dataverse." operationId: Metrics_getUniqueFileDownloadsToMonth tags: - Info parameters: - description: "Year and month cutoff for the metric, formatted as YYYYMM." required: true name: yyyymm in: path schema: type: string - description: Alias of a released parent dataverse used to scope the metric. name: parentAlias in: query schema: type: string responses: "200": description: OK content: text/csv: {} application/json: schema: {} /info/server: get: summary: Returns the server name description: Returns the configured fully qualified domain name for this Dataverse installation. operationId: Info_getServer tags: - Info responses: "200": description: OK content: '*/*': {} /info/settings/:DatasetPublishPopupCustomText: get: summary: Returns dataset publish popup text description: Returns the custom text shown in the dataset publish popup when the setting is configured. operationId: Info_getDatasetPublishPopupCustomText tags: - Info responses: "200": description: OK content: '*/*': {} /info/settings/:DatasetSubmitForReviewPopupCustomText: get: summary: Returns dataset review popup text description: Returns the custom text shown when a dataset is submitted for review and the setting is configured. operationId: Info_DatasetSubmitForReviewPopupCustomText tags: - Info responses: "200": description: OK content: '*/*': {} /info/settings/:MaxEmbargoDurationInMonths: get: summary: Returns the maximum embargo duration description: Returns the configured maximum embargo duration in months when the setting is configured. operationId: Info_getMaxEmbargoDurationInMonths tags: - Info responses: "200": description: OK content: '*/*': {} /info/settings/:PublishDatasetDisclaimerText: get: summary: Returns dataset publish disclaimer text description: Returns the disclaimer text shown during dataset publication when the setting is configured. operationId: Info_getPublishDatasetDisclaimerText tags: - Info responses: "200": description: OK content: '*/*': {} /info/settings/:SubmitForReviewDatasetDisclaimerText: get: summary: Returns dataset review disclaimer text description: Returns the disclaimer text shown when a dataset is submitted for review and the setting is configured. operationId: Info_getSubmitForReviewDatasetDisclaimerText tags: - Info responses: "200": description: OK content: '*/*': {} /info/settings/customization/{customizationFileType}: get: summary: Returns a customization file description: Returns the configured customization file for the requested customization type. operationId: Info_getCustomizationFile tags: - Info parameters: - description: Customization file type to retrieve. required: true name: customizationFileType in: path schema: type: string responses: "200": description: OK content: '*/*': {} /info/settings/incompleteMetadataViaApi: get: summary: Returns incomplete metadata API policy description: Returns whether API requests may create or update datasets with incomplete metadata. operationId: Info_getAllowsIncompleteMetadata tags: - Info responses: "200": description: OK content: '*/*': {} /info/version: get: summary: Returns version and build information description: Returns the Dataverse application version and build identifier. operationId: Info_getInfo tags: - Info responses: "200": description: Version and build information content: '*/*': {} /info/zipDownloadLimit: get: summary: Returns the ZIP download limit description: Returns the configured maximum size for ZIP downloads in bytes. operationId: Info_getZipDownloadLimit tags: - Info responses: "200": description: OK content: '*/*': {} /licenses: get: summary: Lists licenses description: Returns all configured licenses as JSON. operationId: Licenses_getLicenses tags: - Licenses responses: "200": description: OK content: '*/*': {} post: summary: Creates a license description: Creates a license when the authenticated user is a superuser and returns the created license location. operationId: Licenses_addLicense tags: - Licenses requestBody: description: "License definition to persist, including name, URI, active state,\ \ and sort order." content: application/json: schema: description: License definition accepted by the license administration API. type: object required: true responses: "201": description: License created with a Location header pointing to the new license. security: - DataverseApiKey: [] /licenses/default: get: summary: Returns the default license description: Returns the numeric id of the configured default license. operationId: Licenses_getDefault tags: - Licenses responses: "200": description: OK content: '*/*': {} /licenses/default/{id}: put: summary: Sets the default license description: Sets the specified license as the default when the authenticated user is a superuser. operationId: Licenses_setDefault tags: - Licenses parameters: - description: Numeric id of the license to make default. required: true name: id in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /licenses/{id}: get: summary: Returns a license description: Returns the configured license with the specified numeric id. operationId: Licenses_getLicenseById tags: - Licenses parameters: - description: Numeric id of the license to return. required: true name: id in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} delete: summary: Deletes a license description: Deletes a non-default license when the authenticated user is a superuser. operationId: Licenses_deleteLicenseById tags: - Licenses parameters: - description: Numeric id of the license to delete. required: true name: id in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /licenses/{id}/:active/{activeState}: put: summary: Sets license active state description: Updates whether the specified license is active when the authenticated user is a superuser. operationId: Licenses_setActiveState tags: - Licenses parameters: - description: New active state for the license. required: true name: activeState in: path schema: type: boolean - description: Numeric id of the license to update. required: true name: id in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /licenses/{id}/:sortOrder/{sortOrder}: put: summary: Sets license sort order description: Updates the sort order for the specified license when the authenticated user is a superuser. operationId: Licenses_setSortOrder tags: - Licenses parameters: - description: Numeric id of the license to update. required: true name: id in: path schema: type: integer format: int64 - description: New sort order value for the license. required: true name: sortOrder in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /localcontexts/datasets/{id}: get: summary: Finds Local Contexts projects for a dataset description: Queries the configured Local Contexts service by dataset DOI and returns matching project information when the requester is allowed to inspect the dataset. operationId: LocalContexts_getDatasetLocalContexts tags: - Datasets parameters: - description: Dataset id or persistent identifier whose DOI is sent to Local Contexts. required: true name: id in: path schema: type: string responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /localcontexts/datasets/{id}/{projectId}: get: summary: Returns a Local Contexts project description: Returns a Local Contexts project only when the project response includes a DOI matching the specified dataset. operationId: LocalContexts_searchLocalContexts tags: - Datasets parameters: - description: Dataset id or persistent identifier used to validate the Local Contexts project DOI. required: true name: id in: path schema: type: string - description: Local Contexts project id to retrieve. required: true name: projectId in: path schema: type: string responses: "200": description: OK content: application/json: schema: {} /logout: post: summary: Logs out the current session description: Clears the authenticated session-cookie user when API session authentication is enabled. operationId: Logout_logout tags: - Users responses: "200": description: OK content: '*/*': {} /mail/notifications: get: summary: Reports deprecated bulk notification status description: Logs the deprecated bulk notification request and returns a message indicating that bulk notification sending is deprecated. operationId: Mail_sendMail tags: - Admin responses: "200": description: OK content: '*/*': {} /metadatablocks: get: summary: Lists metadata blocks description: "Returns metadata blocks as JSON, optionally limited to blocks\ \ displayed during dataset creation and optionally including dataset field\ \ types." operationId: MetadataBlocks_listMetadataBlocks tags: - Metadata parameters: - description: Limit results to metadata blocks displayed during dataset creation. name: onlyDisplayedOnCreate in: query schema: type: boolean - description: Include dataset field type definitions in each metadata block. name: returnDatasetFieldTypes in: query schema: type: boolean responses: "200": description: OK content: application/json: schema: {} /metadatablocks/{identifier}: get: summary: Returns a metadata block description: "Returns the metadata block identified by id, name, or display\ \ name." operationId: MetadataBlocks_getMetadataBlock tags: - Metadata parameters: - description: "Metadata block id, name, or display name." required: true name: identifier in: path schema: type: string responses: "200": description: OK content: application/json: schema: {} /mydata/retrieve: get: summary: Retrieves My Data results description: "Returns datasets, files, and collections visible to the requester\ \ with filters for object type, publication state, role, validity, search\ \ text, and pagination." operationId: DataRetrieverAPI_retrieveMyDataAsJsonString tags: - Users parameters: - description: Dataset validity filter. name: dataset_valid in: query schema: type: array items: type: boolean - description: Dataverse object type filters. name: dvobject_types in: query schema: type: array items: $ref: "#/components/schemas/DType" - description: Validity filters for My Data results. name: filter_validities in: query schema: type: boolean - description: Filter query. name: fq in: query schema: type: array items: type: string - description: Metadata fields to include. name: metadata_fields in: query schema: type: array items: type: string - description: Search term for My Data results. name: mydata_search_term in: query schema: type: string - description: Sort order. name: order in: query schema: type: string - description: Publication state filters. name: published_states in: query schema: type: array items: type: string - description: Role id filters. name: role_ids in: query schema: type: array items: type: integer format: int64 - description: Selected results page. name: selected_page in: query schema: type: integer format: int32 - description: Whether collection results are included. name: show_collections in: query schema: type: boolean - description: Sort field. name: sort in: query schema: type: string - description: User identifier filter. name: userIdentifier in: query schema: type: string responses: "200": description: OK content: application/json: schema: type: string security: - DataverseApiKey: [] /mydata/retrieve/collectionList: get: summary: Lists collections for My Data description: Returns collections where the requester or selected user may add datasets. operationId: DataRetrieverAPI_retrieveMyCollectionList tags: - Users parameters: - description: User identifier filter. name: userIdentifier in: query schema: type: string responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /notifications/all: get: summary: Lists user notifications description: "Returns notifications for the authenticated user with optional\ \ unread filtering, formatting, and pagination." operationId: Notifications_getAllNotificationsForUser tags: - Notifications parameters: - description: Format notifications for in-app display. name: inAppNotificationFormat in: query schema: type: boolean - description: Maximum number of notifications to return. name: limit in: query schema: type: integer format: int32 - description: Number of notifications to skip before returning results. name: offset in: query schema: type: integer format: int32 - description: Limit results to unread notifications. name: onlyUnread in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /notifications/mutedEmails: get: summary: Lists muted notification emails description: Returns notification types whose emails are muted for the authenticated user. operationId: Notifications_getMutedEmailsForUser tags: - Notifications responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /notifications/mutedEmails/{typeName}: delete: summary: Unmutes notification emails description: Removes the specified notification type from the authenticated user's muted email preferences. operationId: Notifications_unmuteEmailsForUser tags: - Notifications parameters: - description: Notification type name whose emails are unmuted. required: true name: typeName in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] put: summary: Mutes notification emails description: Adds the specified notification type to the authenticated user's muted email preferences. operationId: Notifications_muteEmailsForUser tags: - Notifications parameters: - description: Notification type name whose emails are muted. required: true name: typeName in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /notifications/mutedNotifications: get: summary: Lists muted in-app notifications description: Returns notification types whose in-app notifications are muted for the authenticated user. operationId: Notifications_getMutedNotificationsForUser tags: - Notifications responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /notifications/mutedNotifications/{typeName}: delete: summary: Unmutes in-app notifications description: Removes the specified notification type from the authenticated user's muted in-app notification preferences. operationId: Notifications_unmuteNotificationsForUser tags: - Notifications parameters: - description: Notification type name whose in-app notifications are unmuted. required: true name: typeName in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] put: summary: Mutes in-app notifications description: Adds the specified notification type to the authenticated user's muted in-app notification preferences. operationId: Notifications_muteNotificationsForUser tags: - Notifications parameters: - description: Notification type name whose in-app notifications are muted. required: true name: typeName in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /notifications/unreadCount: get: summary: Returns unread notification count description: Returns the number of unread notifications for the authenticated user. operationId: Notifications_getUnreadNotificationsCountForUser tags: - Notifications responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /notifications/{id}: delete: summary: Deletes a notification description: Deletes one notification when it belongs to the authenticated user. operationId: Notifications_deleteNotificationForUser tags: - Notifications parameters: - description: Notification id to delete. required: true name: id in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /notifications/{id}/markAsRead: put: summary: Marks a notification as read description: Marks one notification as read when it belongs to the authenticated user. operationId: Notifications_markNotificationAsReadForUser tags: - Notifications parameters: - description: Notification id to mark as read. required: true name: id in: path schema: type: integer format: int64 responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /pids: get: summary: Returns PID provider metadata description: Queries configured DataCite metadata for the supplied persistent identifier when the requester is a superuser. operationId: Pids_getPid tags: - Admin parameters: - description: Persistent identifier to query. name: persistentId in: query schema: type: string responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /pids/providers: get: summary: Lists PID providers description: Returns the configured persistent identifier providers. operationId: Pids_getPidProviders tags: - Admin responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /pids/providers/{persistentId}: get: summary: Returns the provider for a PID description: Parses a persistent identifier and returns the managed provider id or reports that the PID belongs to an unmanaged provider. operationId: Pids_getPidProviderId tags: - Admin parameters: - description: Persistent identifier whose provider is requested. required: true name: persistentId in: path schema: type: string pattern: .+ responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /pids/unreserved: get: summary: Lists unreserved dataset PIDs description: Returns draft datasets whose persistent identifiers have not been reserved when the requester is a superuser. operationId: Pids_getUnreserved tags: - Admin parameters: - description: Optional persistent identifier value accepted by the endpoint. name: persistentId in: query schema: type: string responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /pids/{id}/delete: delete: summary: Deletes a draft dataset PID description: Deletes the persistent identifier for an unpublished dataset. operationId: Pids_deletePid tags: - Admin parameters: - description: Dataset id or persistent identifier whose PID is deleted. required: true name: id in: path schema: type: string responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /pids/{id}/reserve: post: summary: Reserves a dataset PID description: Reserves the persistent identifier for the specified dataset. operationId: Pids_reservePid tags: - Admin parameters: - description: Dataset id or persistent identifier whose PID is reserved. required: true name: id in: path schema: type: string responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /roles: post: summary: Creates a role description: Creates a role definition in the specified dataverse and returns the saved role. operationId: Roles_createNewRole tags: - Roles parameters: - description: Dataverse identifier where the role is created. required: true name: dvo in: query schema: type: string requestBody: description: "Role definition containing alias, name, permissions, and role\ \ metadata." content: '*/*': schema: $ref: "#/components/schemas/RoleDTO" required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /roles/userSelectable: get: summary: Lists selectable roles description: Returns dataverse roles that the authenticated requester can select for role assignment. operationId: Roles_getUserSelectableRoles tags: - Roles responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /roles/{id}: get: summary: Returns a role description: Returns a role definition when the authenticated user can manage permissions on the role owner. operationId: Roles_viewRole tags: - Roles parameters: - description: Role id or alias to return. required: true name: id in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Deletes a role description: Deletes a non-builtin role definition from its owner dataverse. operationId: Roles_deleteRole tags: - Roles parameters: - description: Role id or alias to delete. required: true name: id in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /search: get: summary: Searches Dataverse content description: "Searches dataverses, datasets, and files using query text, type\ \ filters, subtree filters, facets, sorting, and pagination options." operationId: Search_search tags: - Search parameters: - description: Filter query. name: fq in: query schema: type: array items: type: string - description: Geographic point used for spatial search. name: geo_point in: query schema: type: string - description: Geographic radius used for spatial search. name: geo_radius in: query schema: type: string - description: Metadata fields to include. name: metadata_fields in: query schema: type: array items: type: string - description: Sort order. name: order in: query schema: type: string - description: Number of results to return per page. name: per_page in: query schema: type: integer format: int32 - description: Search query string. name: q in: query schema: type: string - description: Whether search queries entity fields. name: query_entities in: query schema: type: boolean default: true - description: Search service name to use. name: search_service in: query schema: type: string - description: Whether API URLs are included. name: show_api_urls in: query schema: type: boolean - description: Whether collection results are included. name: show_collections in: query schema: type: boolean - description: Whether entity ids are included. name: show_entity_ids in: query schema: type: boolean - description: Whether facet counts are included. name: show_facets in: query schema: type: boolean - description: Whether relevance scores are included. name: show_relevance in: query schema: type: boolean - description: Whether object type counts are included. name: show_type_counts in: query schema: type: boolean - description: Sort field. name: sort in: query schema: type: string - description: Result offset. name: start in: query schema: type: integer format: int32 - description: Dataverse subtree alias filter. name: subtree in: query schema: type: array items: type: string - description: Resource type filter. name: type in: query schema: type: array items: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /search/services: get: summary: Lists search services description: "Returns the configured search service names, display names, and\ \ the default search service." operationId: Search_getSearchEngines tags: - Search responses: "200": description: OK content: '*/*': {} /sendfeedback: post: summary: Submits feedback description: Sends a feedback email to contacts for a target object or to the support address after validating the sender and message body. operationId: SendFeedbackAPI_submitFeedback tags: - Users requestBody: description: "Feedback JSON with subject, body, optional sender email, and\ \ an optional target id or identifier." content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /users/:me: get: summary: Returns the authenticated user description: Returns the authenticated user associated with the supplied API token or active API session. operationId: Users_getAuthenticatedUserByToken tags: - Users responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /users/register: post: summary: Registers an OIDC user description: Registers an OIDC user from the supplied user JSON when API bearer authentication is enabled and a bearer token is present. operationId: Users_registerOIDCUser tags: - Users requestBody: description: User JSON parsed into a new authenticated OIDC user registration. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} /users/token: get: summary: Returns the current user's API token expiration description: Returns the authenticated user's API token string and expiration time. operationId: Users_getTokenExpirationDate tags: - Users responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] delete: summary: Deletes the current user's API token description: Removes the API token for the authenticated user. operationId: Users_deleteToken tags: - Users responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /users/token/recreate: post: summary: Recreates the current user's API token description: "Deletes the authenticated user's existing API token, creates a\ \ new token, and optionally includes its expiration time in the response." operationId: Users_recreateToken tags: - Users parameters: - description: Include the new token expiration time in the response. name: returnExpiration in: query schema: type: boolean responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /users/{consumedIdentifier}/mergeIntoUser/{baseIdentifier}: post: summary: Merges one user account into another description: Moves account data from one authenticated user into another when the requester is a superuser. operationId: Users_mergeInAuthenticatedUser tags: - Users parameters: - description: Identifier of the authenticated user account that receives the merged account data. required: true name: baseIdentifier in: path schema: type: string - description: Identifier of the authenticated user account whose data is merged into another account. required: true name: consumedIdentifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /users/{identifier}/allowedCollections/{permission}: get: summary: Lists collections permitted for a user description: Returns collections where the specified user has the requested permission when the requester is that user or a superuser. operationId: Users_getUserPermittedCollections tags: - Users parameters: - description: Authenticated user identifier whose permitted collections are returned. required: true name: identifier in: path schema: type: string - description: Permission name used to select permitted collections. required: true name: permission in: path schema: type: string responses: "200": description: OK content: application/json: schema: {} security: - DataverseApiKey: [] /users/{identifier}/changeIdentifier/{newIdentifier}: post: summary: Changes a user identifier description: Changes an authenticated user's identifier when the requester is a superuser. operationId: Users_changeAuthenticatedUserIdentifier tags: - Users parameters: - description: Current authenticated user identifier. required: true name: identifier in: path schema: type: string - description: New authenticated user identifier to assign. required: true name: newIdentifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /users/{identifier}/removeRoles: post: summary: Removes all roles from a user description: Revokes all role assignments for the specified authenticated user. operationId: Users_removeUserRoles tags: - Users parameters: - description: Authenticated user identifier whose role assignments are removed. required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /users/{identifier}/traces: get: summary: Returns user traces description: "Returns trace information showing where the specified authenticated\ \ user appears across role assignments, groups, datasets, files, guestbooks,\ \ and saved searches." operationId: Users_getTraces tags: - Users parameters: - description: Authenticated user identifier whose traces are returned. required: true name: identifier in: path schema: type: string responses: "200": description: OK content: '*/*': {} security: - DataverseApiKey: [] /users/{identifier}/traces/{element}: get: summary: Returns a user trace element description: Returns one category of trace information for the specified authenticated user as JSON or CSV. operationId: Users_getTracesElement tags: - Users parameters: - description: "Trace category to return, such as roleAssignments, explicitGroups,\ \ guestbookEntries, or savedSearches." required: true name: element in: path schema: type: string - description: Authenticated user identifier whose trace element is returned. required: true name: identifier in: path schema: type: string responses: "200": description: OK content: text/csv: {} application/json: schema: {} security: - DataverseApiKey: [] /workflows/{invocationId}: post: summary: Resumes a pending workflow description: Accepts the result body from an external workflow step and resumes the pending workflow invocation when the caller IP address is allowed. operationId: Workflows_resumeWorkflow tags: - Workflows parameters: - description: Identifier of the pending workflow invocation to resume. required: true name: invocationId in: path schema: type: string requestBody: description: Workflow step result body passed to the pending invocation. content: '*/*': schema: type: string required: true responses: "200": description: OK content: '*/*': {} info: title: Dataverse API version: 6.12.1 description: Open source research data repository software.