dataverse-api API reference · SKMTC Hub

/

/Dataverse API

APIs
Generators
Stacks
Projects

Docs
History
Schema

Checked 18h ago · Updated 18h ago

Filter operations

addFilesToDataset1

postUploads a set of files to a dataset

addFileToDataset1

postUploads a file for a dataset

addGlobusFilesToDataset1

postUploads a Globus file for a dataset

info11

get/info/apiTermsOfUse
get/info/applicationTermsOfUse
get/info/exportFormats
get/info/idpignorelist
get/info/server
get/info/settings/:DatasetPublishPopupCustomText
get/info/settings/:MaxEmbargoDurationInMonths
get/info/settings/customization/{customizationFileType}
get/info/settings/incompleteMetadataViaApi
getGet version and build information
get/info/zipDownloadLimit

replaceFilesInDataset2

postReplace a set of files to a dataset
postReplace a file on a dataset

saveAuxiliaryFileWithVersion1

postSave auxiliary file with version

uploadDatasetLogo1

postUploads a logo for a dataset

get/access/datafile/bundle/{fileId}
get/access/datafile/{fileId}
get/access/datafile/{fileId}/auxiliary
get/access/datafile/{fileId}/auxiliary/{formatTag}/{formatVersion}
delete/access/datafile/{fileId}/auxiliary/{formatTag}/{formatVersion}
get/access/datafile/{fileId}/auxiliary/{origin}
get/access/datafile/{fileId}/metadata
get/access/datafile/{fileId}/metadata/ddi
put/access/datafile/{id}/grantAccess/{identifier}
get/access/datafile/{id}/listRequests
put/access/datafile/{id}/rejectAccess/{identifier}
put/access/datafile/{id}/requestAccess
delete/access/datafile/{id}/revokeAccess/{identifier}
get/access/datafile/{id}/userFileAccessRequested
get/access/datafile/{id}/userPermissions
post/access/datafiles
get/access/datafiles/{fileIds}
get/access/dataset/{id}
get/access/dataset/{id}/versions/{versionId}
get/access/dataverseFeaturedItemImage/{itemId}
get/access/dsCardImage/{versionId}
get/access/dvCardImage/{dataverseId}
get/access/fileCardImage/{fileId}
put/access/{id}/allowAccessRequest
post/admin/archiveAllUnarchivedDatasetVersions
get/admin/assignee/{idtf}
get/admin/assignments/assignees/{raIdtf}
get/admin/authenticatedUsers
post/admin/authenticatedUsers
put/admin/authenticatedUsers/convert/builtin2oauth
put/admin/authenticatedUsers/convert/builtin2shib
delete/admin/authenticatedUsers/id/{id}
put/admin/authenticatedUsers/id/{id}/convertRemoteToBuiltIn
put/admin/authenticatedUsers/id/{id}/convertShibToBuiltIn
post/admin/authenticatedUsers/id/{id}/deactivate
get/admin/authenticatedUsers/{identifier}
delete/admin/authenticatedUsers/{identifier}
post/admin/authenticatedUsers/{identifier}/deactivate
get/admin/authenticationProviderFactories
get/admin/authenticationProviders
post/admin/authenticationProviders
get/admin/authenticationProviders/{id}
delete/admin/authenticationProviders/{id}
post/admin/authenticationProviders/{id}/:enabled
get/admin/authenticationProviders/{id}/enabled
put/admin/authenticationProviders/{id}/enabled
get/admin/bannerMessage
post/admin/bannerMessage
delete/admin/bannerMessage/{id}
put/admin/bannerMessage/{id}/deactivate
get/admin/batch/jobs
get/admin/batch/jobs/name/{jobName}
get/admin/batch/jobs/{jobId}
delete/admin/clearMetricsCache
delete/admin/clearMetricsCache/{name}
delete/admin/clearThumbnailFailureFlag
delete/admin/clearThumbnailFailureFlag/{id}
post/admin/computeDataFileHashValue/{fileId}/algorithm/{alg}
get/admin/confirmEmail/{userId}
post/admin/confirmEmail/{userId}
post/admin/convertUserFromBcryptToSha1
get/admin/datafiles/auditFiles
get/admin/datafiles/integrity/fixmissingoriginalsizes
get/admin/datafiles/integrity/fixmissingoriginaltypes
get/admin/datasetfield
get/admin/datasetfield/controlledVocabulary/subject
post/admin/datasetfield/load
get/admin/datasetfield/loadNAControlledVocabularyValue
post/admin/datasetfield/loadpropertyfiles
post/admin/datasetfield/setDisplayOnCreate
get/admin/datasetfield/{name}
post/admin/datasets/integrity/{datasetVersionId}/fixmissingunf
get/admin/datasets/thumbnailMetadata/{id}
get/admin/dataverse/curationLabelSets
get/admin/dataverse/storageDrivers
get/admin/dataverse/{alias}/addRoleAssignmentsToChildren
get/admin/dataverse/{alias}/curationLabelSet
put/admin/dataverse/{alias}/curationLabelSet
delete/admin/dataverse/{alias}/curationLabelSet
get/admin/dataverse/{alias}/storageDriver
put/admin/dataverse/{alias}/storageDriver
delete/admin/dataverse/{alias}/storageDriver
get/admin/downloadTmpFile
get/admin/externalTools
post/admin/externalTools
get/admin/externalTools/{id}
delete/admin/externalTools/{id}
get/admin/featureFlags
get/admin/featureFlags/{flag}
post/admin/feedback
get/admin/groups/affiliation
post/admin/groups/affiliation
get/admin/groups/affiliation/{groupId}
delete/admin/groups/affiliation/{groupId}
put/admin/groups/affiliation/{groupName}
post/admin/groups/affiliations
get/admin/groups/domain
post/admin/groups/domain
get/admin/groups/domain/{groupAlias}
put/admin/groups/domain/{groupAlias}
delete/admin/groups/domain/{groupAlias}
get/admin/groups/ip
post/admin/groups/ip
get/admin/groups/ip/{group}
put/admin/groups/ip/{group}
delete/admin/groups/ip/{group}
get/admin/groups/shib
post/admin/groups/shib
delete/admin/groups/shib/{primaryKey}
get/admin/index
get/admin/index/clear
get/admin/index/clear-orphans
get/admin/index/continue
get/admin/index/dataset
delete/admin/index/datasets/{id}
get/admin/index/filemetadata/{dataset_id}
get/admin/index/filesearch
get/admin/index/mod
get/admin/index/perms
get/admin/index/perms/{id}
get/admin/index/permsDebug
get/admin/index/solr/schema
get/admin/index/status
get/admin/index/test
delete/admin/index/timestamps
delete/admin/index/timestamps/{dvObjectId}
get/admin/index/{type}/{id}
get/admin/isOrcid
get/admin/list-users
post/admin/makeDataCount/addUsageMetricsFromSushiReport
post/admin/makeDataCount/sendToHub
post/admin/makeDataCount/{id}/addUsageMetricsFromSushiReport
post/admin/makeDataCount/{id}/updateCitationsForDataset
get/admin/makeDataCount/{yearMonth}/processingState
post/admin/makeDataCount/{yearMonth}/processingState
delete/admin/makeDataCount/{yearMonth}/processingState
get/admin/metadata/clearExportTimestamps
get/admin/metadata/exportAll
put/admin/metadata/exportOAI/{specname}
get/admin/metadata/reExportAll
get/admin/metadata/{id}/reExportDataset
get/admin/permissions/{dvo}
post/admin/publishDataverseAsCreator/{id}
get/admin/rateLimitStats
get/admin/registerDataFileAll
get/admin/registerDataFiles/{alias}
post/admin/requestSignedUrl
get/admin/roles
post/admin/roles
put/admin/roles/{id}
delete/admin/roles/{id}
get/admin/savedsearches
post/admin/savedsearches
get/admin/savedsearches/list
put/admin/savedsearches/makelinks/all
put/admin/savedsearches/makelinks/{id}
get/admin/savedsearches/{id}
delete/admin/savedsearches/{id}
get/admin/settings
get/admin/settings/{name}
put/admin/settings/{name}
delete/admin/settings/{name}
put/admin/settings/{name}/lang/{lang}
delete/admin/settings/{name}/lang/{lang}
post/admin/sitemap
get/admin/storageSites
post/admin/storageSites
get/admin/storageSites/{id}
delete/admin/storageSites/{id}
put/admin/storageSites/{id}/primaryStorage
post/admin/submitDatasetVersionToArchive/{id}/{version}
put/admin/superuser/{identifier}
post/admin/superuser/{identifier}
delete/admin/template/{id}
get/admin/templates
get/admin/templates/{alias}
get/admin/updateHashValues/{alg}
get/admin/validate/dataset/files/{id}
get/admin/validate/dataset/{id}
get/admin/validate/datasets
post/admin/validateDataFileHashValue/{fileId}
post/admin/validatePassword
get/admin/workflows
post/admin/workflows
get/admin/workflows/default
get/admin/workflows/default/{triggerType}
put/admin/workflows/default/{triggerType}
delete/admin/workflows/default/{triggerType}
get/admin/workflows/ip-whitelist
put/admin/workflows/ip-whitelist
delete/admin/workflows/ip-whitelist
get/admin/workflows/{id}
delete/admin/workflows/{id}
get/admin/{id}/registerDataFile
post/admin/{id}/reregisterHDLToPID
get/batch/harvest
get/batch/import
post/batch/import
post/batch/jobs/import/datasets/files/{identifier}
post/builtin-users
post/builtin-users/{password}/{key}
post/builtin-users/{password}/{key}/{sendEmailNotification}
get/builtin-users/{username}/api-token
get/datasetfields/facetables
get/datasets/datasetTypes
post/datasets/datasetTypes
get/datasets/datasetTypes/{idOrName}
put/datasets/datasetTypes/{idOrName}
put/datasets/datasetTypes/{idOrName}/licenses
delete/datasets/datasetTypes/{id}
get/datasets/export
get/datasets/listCurationStates
get/datasets/locks
post/datasets/modifyRegistrationAll
post/datasets/modifyRegistrationPIDMetadataAll
put/datasets/mpupload
delete/datasets/mpupload
get/datasets/previewUrlDatasetVersion/{previewUrlToken}
get/datasets/previewUrlDatasetVersion/{previewUrlToken}/citation
get/datasets/privateUrlDatasetVersion/{privateUrlToken}
get/datasets/privateUrlDatasetVersion/{privateUrlToken}/citation
get/datasets/summaryFieldNames
delete/datasets/{datasetId}/deleteLink/{linkedDataverseId}
get/datasets/{identifier}/allowedCurationLabels
get/datasets/{identifier}/assignments
post/datasets/{identifier}/assignments
delete/datasets/{identifier}/assignments/{id}
get/datasets/{identifier}/curationLabelSet
put/datasets/{identifier}/curationLabelSet
delete/datasets/{identifier}/curationLabelSet
post/datasets/{identifier}/dataCaptureModule/checksumValidation
get/datasets/{identifier}/dataCaptureModule/rsync
get/datasets/{identifier}/guestbookEntryAtRequest
put/datasets/{identifier}/guestbookEntryAtRequest
delete/datasets/{identifier}/guestbookEntryAtRequest
post/datasets/{identifier}/lock/{type}
get/datasets/{identifier}/locks
delete/datasets/{identifier}/locks
get/datasets/{identifier}/pidGenerator
put/datasets/{identifier}/pidGenerator
delete/datasets/{identifier}/pidGenerator
put/datasets/{identifier}/pidReconcile
get/datasets/{identifier}/storageDriver
put/datasets/{identifier}/storageDriver
delete/datasets/{identifier}/storageDriver
get/datasets/{identifier}/storagesize
get/datasets/{identifier}/timestamps
get/datasets/{identifier}/versions/{versionId}/downloadsize
get/datasets/{id}
delete/datasets/{id}
get/datasets/{id}/actions/:publish
post/datasets/{id}/actions/:publish
post/datasets/{id}/actions/:releasemigrated
get/datasets/{id}/availableFileCategories
put/datasets/{id}/citationdate
delete/datasets/{id}/citationdate
get/datasets/{id}/cleanStorage
get/datasets/{id}/curationStatus
put/datasets/{id}/curationStatus
delete/datasets/{id}/curationStatus
put/datasets/{id}/deleteFiles
put/datasets/{id}/deleteMetadata
delete/datasets/{id}/destroy
get/datasets/{id}/dirindex
get/datasets/{id}/download/count
put/datasets/{id}/editMetadata
post/datasets/{id}/externalTool/{tid}/toolUrl
post/datasets/{id}/files/actions/:set-embargo
post/datasets/{id}/files/actions/:set-retention
post/datasets/{id}/files/actions/:unset-embargo
post/datasets/{id}/files/actions/:unset-retention
post/datasets/{id}/files/metadata
delete/datasets/{id}/files/uploadlimit
post/datasets/{id}/files/uploadlimit/{limit}
get/datasets/{id}/globusDownloadParameters
get/datasets/{id}/globusUploadParameters
get/datasets/{id}/links
get/datasets/{id}/logo
get/datasets/{id}/makeDataCount/citations
get/datasets/{id}/makeDataCount/{metric}
get/datasets/{id}/makeDataCount/{metric}/{yyyymm}
get/datasets/{id}/metadata
put/datasets/{id}/metadata
put/datasets/{id}/metadata/delete
post/datasets/{id}/modifyRegistration
post/datasets/{id}/modifyRegistrationMetadata
post/datasets/{id}/monitorGlobusDownload
post/datasets/{id}/move/{targetDataverseAlias}
get/datasets/{id}/previewUrl
post/datasets/{id}/previewUrl
delete/datasets/{id}/previewUrl
get/datasets/{id}/privateUrl
post/datasets/{id}/privateUrl
delete/datasets/{id}/privateUrl
post/datasets/{id}/requestGlobusDownload
post/datasets/{id}/requestGlobusUploadPaths
post/datasets/{id}/returnToAuthor
post/datasets/{id}/submitForReview
get/datasets/{id}/thumbnail
delete/datasets/{id}/thumbnail
get/datasets/{id}/thumbnail/candidates
post/datasets/{id}/thumbnail/{dataFileId}
get/datasets/{id}/uploadurls
get/datasets/{id}/userPermissions
get/datasets/{id}/versions
get/datasets/{id}/versions/compareSummary
get/datasets/{id}/versions/{versionId1}/compare/{versionId2}
get/datasets/{id}/versions/{versionId}
put/datasets/{id}/versions/{versionId}
delete/datasets/{id}/versions/{versionId}
get/datasets/{id}/versions/{versionId}/canDownloadAtLeastOneFile
get/datasets/{id}/versions/{versionId}/citation
get/datasets/{id}/versions/{versionId}/citation/{format}
get/datasets/{id}/versions/{versionId}/customlicense
post/datasets/{id}/versions/{versionId}/deaccession
get/datasets/{id}/versions/{versionId}/files
get/datasets/{id}/versions/{versionId}/files/counts
get/datasets/{id}/versions/{versionId}/linkset
get/datasets/{id}/versions/{versionId}/metadata
get/datasets/{id}/versions/{versionId}/versionNote
put/datasets/{id}/versions/{versionId}/versionNote
delete/datasets/{id}/versions/{versionId}/versionNote
get/datasets/{id}/versions/{versionNumber}/metadata/{block}
get/datasets/{id}/versions/{version}/toolparams/{tid}
get/datasets/{id}/{version}/archivalStatus
put/datasets/{id}/{version}/archivalStatus
delete/datasets/{id}/{version}/archivalStatus
put/datasets/{linkedDatasetId}/link/{linkingDataverseAlias}
post/datatags/receiveTags/{uniqueCacheId}
put/dataverseFeaturedItems/{id}
delete/dataverseFeaturedItems/{id}
post/dataverses
put/dataverses/{dataverseId}/featuredItems
get/dataverses/{identifier}
put/dataverses/{identifier}
post/dataverses/{identifier}
delete/dataverses/{identifier}
post/dataverses/{identifier}/actions/:publish
get/dataverses/{identifier}/assignments
post/dataverses/{identifier}/assignments
delete/dataverses/{identifier}/assignments/{id}
put/dataverses/{identifier}/attribute/{attribute}
get/dataverses/{identifier}/contents
get/dataverses/{identifier}/datasetSchema
post/dataverses/{identifier}/datasets
post/dataverses/{identifier}/datasets/:import
post/dataverses/{identifier}/datasets/:importddi
post/dataverses/{identifier}/datasets/:startmigration
put/dataverses/{identifier}/defaultContributorRole/{roleAlias}
get/dataverses/{identifier}/facets
post/dataverses/{identifier}/facets
get/dataverses/{identifier}/featured
post/dataverses/{identifier}/featured
delete/dataverses/{identifier}/featured
get/dataverses/{identifier}/featuredItems
post/dataverses/{identifier}/featuredItems
delete/dataverses/{identifier}/featuredItems
get/dataverses/{identifier}/groups
post/dataverses/{identifier}/groups
get/dataverses/{identifier}/groups/{aliasInOwner}
put/dataverses/{identifier}/groups/{aliasInOwner}
delete/dataverses/{identifier}/groups/{aliasInOwner}
post/dataverses/{identifier}/groups/{aliasInOwner}/roleAssignees
put/dataverses/{identifier}/groups/{aliasInOwner}/roleAssignees/{roleAssigneeIdentifier}
delete/dataverses/{identifier}/groups/{aliasInOwner}/roleAssignees/{roleAssigneeIdentifier}
get/dataverses/{identifier}/guestbookResponses
get/dataverses/{identifier}/inputLevels
put/dataverses/{identifier}/inputLevels
get/dataverses/{identifier}/links
get/dataverses/{identifier}/metadatablockfacets
post/dataverses/{identifier}/metadatablockfacets
post/dataverses/{identifier}/metadatablockfacets/isRoot
get/dataverses/{identifier}/metadatablocks
post/dataverses/{identifier}/metadatablocks
get/dataverses/{identifier}/metadatablocks/:isRoot
post/dataverses/{identifier}/metadatablocks/:isRoot
get/dataverses/{identifier}/metadatablocks/isRoot
put/dataverses/{identifier}/metadatablocks/isRoot
get/dataverses/{identifier}/roles
post/dataverses/{identifier}/roles
get/dataverses/{identifier}/storage/quota
delete/dataverses/{identifier}/storage/quota
post/dataverses/{identifier}/storage/quota/{bytesAllocated}
get/dataverses/{identifier}/storage/use
get/dataverses/{identifier}/storagesize
get/dataverses/{identifier}/templates
post/dataverses/{identifier}/templates
get/dataverses/{identifier}/userPermissions
post/dataverses/{identifier}/validateDatasetJson
post/dataverses/{id}/move/{targetDataverseAlias}
put/dataverses/{linkedDataverseAlias}/link/{linkingDataverseAlias}
delete/dataverses/{linkingDataverseId}/deleteLink/{linkedDataverseId}
put/edit/{fileId}
get/externalTools
post/externalTools
get/externalTools/{id}
delete/externalTools/{id}
get/files/fixityAlgorithm
get/files/{id}
delete/files/{id}
get/files/{id}/dataTables
get/files/{id}/downloadCount
post/files/{id}/externalTool/{tid}/toolUrl
post/files/{id}/extractNcml
get/files/{id}/hasBeenDeleted
get/files/{id}/metadata
post/files/{id}/metadata
post/files/{id}/metadata/categories
get/files/{id}/metadata/draft
post/files/{id}/metadata/tabularTags
get/files/{id}/metadata/{fmid}/toolparams/{tid}
get/files/{id}/prov-freeform
post/files/{id}/prov-freeform
get/files/{id}/prov-json
post/files/{id}/prov-json
delete/files/{id}/prov-json
post/files/{id}/redetect
post/files/{id}/reingest
put/files/{id}/restrict
post/files/{id}/uningest
get/files/{id}/versionDifferences
get/files/{id}/versions/{datasetVersionId}
get/files/{id}/versions/{dsVersionString}/citation
get/harvest/clients
get/harvest/clients/{nickName}
put/harvest/clients/{nickName}
post/harvest/clients/{nickName}
delete/harvest/clients/{nickName}
post/harvest/clients/{nickName}/run
get/harvest/server/oaisets
post/harvest/server/oaisets/add
get/harvest/server/oaisets/{specname}
put/harvest/server/oaisets/{specname}
delete/harvest/server/oaisets/{specname}
get/harvest/server/oaisets/{specname}/datasets
post/inbox
get/info/metrics/accounts
get/info/metrics/accounts/monthly
get/info/metrics/accounts/pastDays/{days}
get/info/metrics/accounts/toMonth/{yyyymm}
get/info/metrics/datasets
get/info/metrics/datasets/bySubject
get/info/metrics/datasets/bySubject/toMonth/{yyyymm}
get/info/metrics/datasets/monthly
get/info/metrics/datasets/pastDays/{days}
get/info/metrics/datasets/toMonth/{yyyymm}
get/info/metrics/dataverses
get/info/metrics/dataverses/byCategory
get/info/metrics/dataverses/bySubject
get/info/metrics/dataverses/monthly
get/info/metrics/dataverses/pastDays/{days}
get/info/metrics/dataverses/toMonth/{yyyymm}
get/info/metrics/downloads
get/info/metrics/downloads/monthly
get/info/metrics/downloads/pastDays/{days}
get/info/metrics/downloads/toMonth/{yyyymm}
get/info/metrics/filedownloads
get/info/metrics/filedownloads/monthly
get/info/metrics/filedownloads/toMonth/{yyyymm}
get/info/metrics/files
get/info/metrics/files/byType
get/info/metrics/files/byType/monthly
get/info/metrics/files/monthly
get/info/metrics/files/pastDays/{days}
get/info/metrics/files/toMonth/{yyyymm}
get/info/metrics/makeDataCount/{metric}
get/info/metrics/makeDataCount/{metric}/monthly
get/info/metrics/makeDataCount/{metric}/toMonth/{yyyymm}
get/info/metrics/tree
get/info/metrics/tree/toMonth/{yyyymm}
get/info/metrics/uniquedownloads
get/info/metrics/uniquedownloads/monthly
get/info/metrics/uniquedownloads/toMonth/{yyyymm}
get/info/metrics/uniquefiledownloads
get/info/metrics/uniquefiledownloads/monthly
get/info/metrics/uniquefiledownloads/toMonth/{yyyymm}
get/ingest/test/file
get/licenses
post/licenses
get/licenses/default
put/licenses/default/{id}
get/licenses/{id}
delete/licenses/{id}
put/licenses/{id}/:active/{activeState}
put/licenses/{id}/:sortOrder/{sortOrder}
get/localcontexts/datasets/{id}
get/localcontexts/datasets/{id}/{projectId}
post/logout
get/mail/notifications
get/meta/datafile/{fileId}
get/meta/dataset/{datasetId}
get/metadatablocks
get/metadatablocks/{identifier}
get/mydata/retrieve
get/mydata/retrieve/collectionList
get/notifications/all
get/notifications/mutedEmails
put/notifications/mutedEmails/{typeName}
delete/notifications/mutedEmails/{typeName}
get/notifications/mutedNotifications
put/notifications/mutedNotifications/{typeName}
delete/notifications/mutedNotifications/{typeName}
get/notifications/unreadCount
delete/notifications/{id}
put/notifications/{id}/markAsRead
get/pids
get/pids/providers
get/pids/providers/{persistentId}
get/pids/unreserved
delete/pids/{id}/delete
post/pids/{id}/reserve
post/roles
get/roles/userSelectable
get/roles/{id}
delete/roles/{id}
get/search
get/search/services
post/sendfeedback
get/users/:me
post/users/register
get/users/token
delete/users/token
post/users/token/recreate
post/users/{consumedIdentifier}/mergeIntoUser/{baseIdentifier}
get/users/{identifier}/allowedCollections/{permission}
post/users/{identifier}/changeIdentifier/{newIdentifier}
post/users/{identifier}/removeRoles
get/users/{identifier}/traces
get/users/{identifier}/traces/{element}
post/workflows/{invocationId}

get/access/datafile/bundle/{fileId}

Path parameters

fileIdstring required

Query parameters

fileMetadataIdinteger

gbrecsboolean

Response

OK

Changes