Université de Montréal Access API
The Access API from Université de Montréal — 23 operation(s) for access.
The Access API from Université de Montréal — 23 operation(s) for access.
openapi: 3.0.3
info:
title: Dataverse Access API
description: Open source research data repository software.
version: v6.8.1-SP
tags:
- name: Access
paths:
/access/datafile/bundle/{fileId}:
get:
operationId: Access_datafileBundle
parameters:
- name: fileId
in: path
required: true
schema:
type: string
- name: fileMetadataId
in: query
schema:
format: int64
type: integer
- name: gbrecs
in: query
schema:
type: boolean
responses:
'200':
description: OK
content:
application/zip:
schema:
$ref: '#/components/schemas/BundleDownloadInstance'
tags:
- Access
/access/datafile/{fileId}:
get:
operationId: Access_datafile
parameters:
- name: fileId
in: path
required: true
schema:
pattern: .+
type: string
- name: gbrecs
in: query
schema:
type: boolean
responses:
'200':
description: OK
tags:
- Access
/access/datafile/{fileId}/auxiliary:
get:
operationId: Access_listDatafileMetadataAux
parameters:
- name: fileId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
tags:
- Access
/access/datafile/{fileId}/auxiliary/{formatTag}/{formatVersion}:
get:
operationId: Access_downloadAuxiliaryFile
parameters:
- name: fileId
in: path
required: true
schema:
type: string
- name: formatTag
in: path
required: true
schema:
type: string
- name: formatVersion
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/DownloadInstance'
tags:
- Access
delete:
operationId: Access_deleteAuxiliaryFileWithVersion
parameters:
- name: fileId
in: path
required: true
schema:
format: int64
type: integer
- name: formatTag
in: path
required: true
schema:
type: string
- name: formatVersion
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
tags:
- Access
/access/datafile/{fileId}/auxiliary/{origin}:
get:
operationId: Access_listDatafileMetadataAuxByOrigin
parameters:
- name: fileId
in: path
required: true
schema:
type: string
- name: origin
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
tags:
- Access
/access/datafile/{fileId}/metadata:
get:
operationId: Access_tabularDatafileMetadata
parameters:
- name: fileId
in: path
required: true
schema:
type: string
- name: exclude
in: query
schema:
type: string
- name: fileMetadataId
in: query
schema:
format: int64
type: integer
- name: include
in: query
schema:
type: string
responses:
'200':
description: OK
content:
text/xml:
schema:
type: string
tags:
- Access
/access/datafile/{fileId}/metadata/ddi:
get:
operationId: Access_tabularDatafileMetadataDDI
parameters:
- name: fileId
in: path
required: true
schema:
type: string
- name: exclude
in: query
schema:
type: string
- name: fileMetadataId
in: query
schema:
format: int64
type: integer
- name: include
in: query
schema:
type: string
responses:
'200':
description: OK
content:
text/xml:
schema:
type: string
tags:
- Access
/access/datafile/{id}/grantAccess/{identifier}:
put:
operationId: Access_grantFileAccess
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: identifier
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
tags:
- Access
/access/datafile/{id}/listRequests:
get:
operationId: Access_listFileAccessRequests
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
tags:
- Access
/access/datafile/{id}/rejectAccess/{identifier}:
put:
operationId: Access_rejectFileAccess
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: identifier
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
tags:
- Access
/access/datafile/{id}/requestAccess:
put:
operationId: Access_requestFileAccess
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
tags:
- Access
/access/datafile/{id}/revokeAccess/{identifier}:
delete:
operationId: Access_revokeFileAccess
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: identifier
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
tags:
- Access
/access/datafile/{id}/userFileAccessRequested:
get:
operationId: Access_getUserFileAccessRequested
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
tags:
- Access
/access/datafile/{id}/userPermissions:
get:
operationId: Access_getUserPermissionsOnFile
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
tags:
- Access
/access/datafiles:
post:
operationId: Access_postDownloadDatafiles
parameters:
- name: gbrecs
in: query
schema:
type: boolean
requestBody:
content:
text/plain:
schema:
type: string
responses:
'200':
description: OK
tags:
- Access
/access/datafiles/{fileIds}:
get:
operationId: Access_datafiles
parameters:
- name: fileIds
in: path
required: true
schema:
type: string
- name: gbrecs
in: query
schema:
type: boolean
responses:
'200':
description: OK
tags:
- Access
/access/dataset/{id}:
get:
operationId: Access_downloadAllFromLatest
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: gbrecs
in: query
schema:
type: boolean
responses:
'200':
description: OK
tags:
- Access
/access/dataset/{id}/versions/{versionId}:
get:
operationId: Access_downloadAllFromVersion
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: versionId
in: path
required: true
schema:
type: string
- name: gbrecs
in: query
schema:
type: boolean
- name: key
in: query
schema:
type: string
responses:
'200':
description: OK
tags:
- Access
/access/dataverseFeaturedItemImage/{itemId}:
get:
operationId: Access_getDataverseFeatureItemImage
parameters:
- name: itemId
in: path
required: true
schema:
format: int64
type: integer
responses:
'200':
description: OK
content:
image/png:
schema:
format: binary
type: string
tags:
- Access
/access/dsCardImage/{versionId}:
get:
operationId: Access_dsCardImage
parameters:
- name: versionId
in: path
required: true
schema:
format: int64
type: integer
responses:
'200':
description: OK
content:
image/png:
schema:
format: binary
type: string
tags:
- Access
/access/dvCardImage/{dataverseId}:
get:
operationId: Access_dvCardImage
parameters:
- name: dataverseId
in: path
required: true
schema:
format: int64
type: integer
responses:
'200':
description: OK
content:
image/png:
schema:
format: binary
type: string
tags:
- Access
/access/fileCardImage/{fileId}:
get:
operationId: Access_fileCardImage
parameters:
- name: fileId
in: path
required: true
schema:
format: int64
type: integer
responses:
'200':
description: OK
content:
image/png:
schema:
format: binary
type: string
tags:
- Access
/access/{id}/allowAccessRequest:
put:
operationId: Access_allowAccessRequest
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
tags:
- Access
components:
schemas:
VariableRangeItem:
type: object
properties:
id:
format: int64
type: integer
value:
type: number
dataVariable:
$ref: '#/components/schemas/DataVariable'
AffiliationGroup:
type: object
properties:
sortByString:
type: string
id:
format: int64
type: integer
persistedGroupAlias:
type: string
displayName:
type: string
description:
type: string
emaildomain:
type: string
alias:
type: string
displayInfo:
$ref: '#/components/schemas/RoleAssigneeDisplayInfo'
identifier:
type: string
provider:
$ref: '#/components/schemas/AffiliationGroupProvider'
editable:
type: boolean
groupProvider:
$ref: '#/components/schemas/GroupProvider'
DataverseRequestServiceBean:
type: object
properties:
dataverseSessionSvc:
$ref: '#/components/schemas/DataverseSession'
request:
type: object
dataverseRequest:
$ref: '#/components/schemas/DataverseRequest'
WorkflowStepSPI:
type: object
ExplicitGroupServiceBean:
type: object
properties:
roleAssigneeSvc:
$ref: '#/components/schemas/RoleAssigneeServiceBean'
em:
type: object
provider:
$ref: '#/components/schemas/ExplicitGroupProvider'
EjbDataverseEngineInner:
type: object
properties:
ejbCtxt:
type: object
DefaultValueSet:
type: object
properties:
id:
format: int64
type: integer
name:
type: string
datasetFieldDefaultValues:
type: array
items:
$ref: '#/components/schemas/DatasetFieldDefaultValue'
DataAccessRequest:
type: object
properties:
file:
$ref: '#/components/schemas/DataFile'
requestParameters:
type: object
additionalProperties:
type: string
DataverseFieldTypeInputLevelServiceBean:
type: object
properties:
em:
type: object
GuestbookResponse:
type: object
properties:
id:
format: int64
type: integer
guestbook:
$ref: '#/components/schemas/Guestbook'
dataFile:
$ref: '#/components/schemas/DataFile'
dataset:
$ref: '#/components/schemas/Dataset'
datasetVersion:
$ref: '#/components/schemas/DatasetVersion'
authenticatedUser:
$ref: '#/components/schemas/AuthenticatedUser'
fileAccessRequests:
type: array
items:
$ref: '#/components/schemas/FileAccessRequest'
customQuestionResponses:
type: array
items:
$ref: '#/components/schemas/CustomQuestionResponse'
name:
maxLength: 255
type: string
email:
maxLength: 255
type: string
institution:
maxLength: 255
type: string
position:
maxLength: 255
type: string
responseTime:
format: date
type: string
example: 2022-03-10
sessionId:
type: string
eventType:
type: string
writeResponse:
type: boolean
selectedFileIds:
type: string
fileFormat:
type: string
externalTool:
$ref: '#/components/schemas/ExternalTool'
responseDate:
type: string
customQuestionResponsesSorted:
type: array
items:
$ref: '#/components/schemas/CustomQuestionResponse'
fileAccessRequest:
type: array
items:
$ref: '#/components/schemas/FileAccessRequest'
ShibGroupServiceBean:
type: object
properties:
em:
type: object
roleAssigneeSvc:
$ref: '#/components/schemas/RoleAssigneeServiceBean'
groupService:
$ref: '#/components/schemas/GroupServiceBean'
actionLogSvc:
$ref: '#/components/schemas/ActionLogServiceBean'
settingService:
$ref: '#/components/schemas/SettingsServiceBean'
Retention:
type: object
properties:
id:
format: int64
type: integer
dateUnavailable:
format: date
type: string
example: 2022-03-10
reason:
type: string
dataFiles:
type: array
items:
$ref: '#/components/schemas/DataFile'
formattedDateUnavailable:
type: string
BuiltinUserServiceBean:
type: object
properties:
indexService:
$ref: '#/components/schemas/IndexServiceBean'
passwordResetService:
$ref: '#/components/schemas/PasswordResetServiceBean'
em:
type: object
DatasetRelPublication:
type: object
properties:
text:
type: string
idType:
type: string
idNumber:
type: string
url:
type: string
title:
type: string
description:
type: string
replicationData:
type: boolean
displayOrder:
format: int32
type: integer
relationType:
type: string
localeTitle:
type: string
localeDescription:
type: string
empty:
type: boolean
Embargo:
type: object
properties:
id:
format: int64
type: integer
dateAvailable:
format: date
type: string
example: 2022-03-10
reason:
type: string
dataFiles:
type: array
items:
$ref: '#/components/schemas/DataFile'
formattedDateAvailable:
type: string
DatasetMetrics:
required:
- dataset
type: object
properties:
id:
format: int64
type: integer
dataset:
$ref: '#/components/schemas/Dataset'
monthYear:
type: string
viewsTotalRegular:
format: int64
type: integer
viewsUniqueRegular:
format: int64
type: integer
viewsTotalMachine:
format: int64
type: integer
viewsUniqueMachine:
format: int64
type: integer
downloadsTotalRegular:
format: int64
type: integer
downloadsUniqueRegular:
format: int64
type: integer
downloadsTotalMachine:
format: int64
type: integer
downloadsUniqueMachine:
format: int64
type: integer
countryCode:
type: string
viewsUnique:
format: int64
type: integer
viewsTotal:
format: int64
type: integer
downloadsUnique:
format: int64
type: integer
downloadsTotal:
format: int64
type: integer
month:
type: string
RoleAssignment:
type: object
properties:
id:
format: int64
type: integer
assigneeIdentifier:
type: string
role:
$ref: '#/components/schemas/DataverseRole'
definitionPoint:
$ref: '#/components/schemas/DvObject'
privateUrlToken:
type: string
privateUrlAnonymizedAccess:
type: boolean
anonymizedAccess:
type: boolean
StorageUse:
type: object
properties:
id:
format: int64
type: integer
dvObjectContainer:
$ref: '#/components/schemas/DvObject'
sizeInBytes:
format: int64
type: integer
DatasetVersion:
type: object
properties:
id:
format: int64
type: integer
UNF:
type: string
version:
format: int64
type: integer
versionNumber:
format: int64
type: integer
minorVersionNumber:
format: int64
type: integer
deaccessionNote:
maxLength: 1000
minLength: 0
type: string
versionNote:
maxLength: 1000
minLength: 0
type: string
versionState:
$ref: '#/components/schemas/VersionState'
dataset:
$ref: '#/components/schemas/Dataset'
fileMetadatas:
type: array
items:
$ref: '#/components/schemas/FileMetadata'
termsOfUseAndAccess:
$ref: '#/components/schemas/TermsOfUseAndAccess'
datasetFields:
type: array
items:
$ref: '#/components/schemas/DatasetField'
createTime:
format: date
type: string
example: 2022-03-10
lastUpdateTime:
format: date
type: string
example: 2022-03-10
releaseTime:
format: date
type: string
example: 2022-03-10
archiveTime:
format: date
type: string
example: 2022-03-10
archivalCopyLocation:
type: string
deaccessionLink:
maxLength: 1260
minLength: 0
type: string
contributorNames:
type: string
dataverseSiteUrl:
type: string
jsonLd:
type: string
datasetVersionUsers:
type: array
items:
$ref: '#/components/schemas/DatasetVersionUser'
workflowComments:
type: array
items:
$ref: '#/components/schemas/WorkflowComment'
curationStatuses:
type: array
items:
$ref: '#/components/schemas/CurationStatus'
dvd:
$ref: '#/components/schemas/DatasetVersionDifference'
archivalStatus:
type: object
uNF:
type: string
fileMetadatasSorted:
type: array
items:
$ref: '#/components/schemas/FileMetadata'
fileMetadatasSortedByLabelAndFolder:
type: array
items:
$ref: '#/components/schemas/FileMetadata'
inReview:
type: boolean
archivalCopyLocationStatus:
type: string
archivalCopyLocationMessage:
type: string
deaccessionLinkAsURLString:
type: string
versionDate:
type: string
versionYear:
type: string
userDatasets:
type: array
items:
$ref: '#/components/schemas/DatasetVersionUser'
versionContributorIdentifiers:
type: array
items:
type: string
defaultVersionDifference:
$ref: '#/components/schemas/DatasetVersionDifference'
priorVersionState:
$ref: '#/components/schemas/VersionState'
friendlyVersionNumber:
type: string
released:
type: boolean
published:
type: boolean
draft:
type: boolean
workingCopy:
type: boolean
archived:
type: boolean
deaccessioned:
type: boolean
retiredCopy:
type: boolean
minorUpdate:
type: boolean
hasPackageFile:
type: boolean
hasNonPackageFile:
type: boolean
hasRestrictedFile:
type: boolean
mostRecentlyReleasedVersion:
$ref: '#/components/schemas/DatasetVersion'
largestMinorRelease:
$ref: '#/components/schemas/DatasetVersion'
latestVersion:
type: boolean
title:
type: string
productionDate:
type: string
description:
type: string
descriptions:
type: array
items:
type: string
descriptionPlainText:
type: string
descriptionsPlainTextTruncated:
type: string
descriptionHtmlEscaped:
type: string
datasetContacts:
type: array
items: {}
datasetProducers:
type: array
items: {}
datasetAuthors:
type: array
items:
$ref: '#/components/schemas/DatasetAuthor'
funders:
type: array
items:
type: string
timePeriodsCovered:
type: array
items:
type: string
datesOfCollection:
type: array
items:
type: string
datasetAuthorNames:
type: array
items:
type: string
datasetSubjects:
type: array
items:
type: string
topicClassifications:
type: array
items:
type: string
kindOfData:
type: array
items:
type: string
languages:
type: array
items:
type: string
spatialCoverages:
type: array
items:
type: string
keywords:
type: array
items:
type: string
relatedMaterial:
type: array
items:
type: string
dataSource:
type: array
items:
type: string
geographicCoverage:
type: array
items: {}
relatedPublications:
type: array
items:
$ref: '#/components/schemas/DatasetRelPublication'
uniqueGrantAgencyValues:
type: array
items:
type: string
seriesTitles:
type: array
items:
type: string
datasetProducerNames:
type: array
items:
type: string
citation:
type: string
citationDate:
format: date
type: string
example: 2022-03-10
distributionDate:
type: string
distributorName:
type: string
datasetDistributors:
type: array
items:
$ref: '#/components/schemas/DatasetDistributor'
distributorNames:
type: string
authorsStr:
type: string
flatDatasetFields:
type: array
items:
$ref: '#/components/schemas/DatasetField'
semanticVersion:
type: string
valid:
type: boolean
publicationDateAsString:
type: string
localeLastUpdateTime:
type: string
currentCurationStatus:
$ref: '#/components/schemas/CurationStatus'
DataverseServiceBean:
type: object
properties:
indexService:
$ref: '#/components/schemas/IndexServiceBean'
solrIndexService:
$ref: '#/components/schemas/SolrIndexServiceBean'
authService:
$ref: '#/components/schemas/AuthenticationServiceBean'
datasetService:
$ref: '#/components/schemas/DatasetServiceBean'
dataverseLinkingService:
$ref: '#/components/schemas/DataverseLinkingServiceBean'
datasetLinkingService:
$ref: '#/components/schemas/DatasetLinkingServiceBean'
groupService:
$ref: '#/components/schemas/GroupServiceBean'
rolesService:
$ref: '#/components/schemas/DataverseRoleServiceBean'
permissionService:
$ref: '#/components/schemas/PermissionServiceBean'
dataverseFieldTypeInputLevelService:
$ref: '#/components/schemas/DataverseFieldTypeInputLevelServiceBean'
systemConfig:
$ref: '#/components/schemas/SystemConfig'
session:
$ref: '#/components/schemas/DataverseSession'
em:
type: object
datasetSchemaPreface:
type: string
startOfMDB:
type: string
reqValTemplate:
type: string
minItemsTemplate:
type: string
endOfReqVal:
type: string
endOfjson:
type: string
rootDataverseName:
type: string
rootDataverseExists:
type: boolean
dataverseCount:
format: int64
type: integer
DatasetField:
type: object
properties:
id:
format: int64
type: integer
datasetFieldType:
$ref: '#/components/schemas/DatasetFieldType'
datasetVersion:
$ref: '#/components/schemas/DatasetVersion'
template:
$ref: '#/components/schemas/Template'
parentDatasetFieldCompoundValue:
$ref: '#/components/schemas/DatasetFieldCompoundValue'
datasetFieldCompoundValues:
type: array
items:
$ref: '#/components/schemas/DatasetFieldCompoundValue'
datasetFieldValues:
type: array
items:
$ref: '#/components/schemas/DatasetFieldValue'
controlledVocabularyValues:
type: array
items:
$ref: '#/components/schemas/ControlledVocabularyValue'
validationMessage:
type: string
required:
type: boolean
hasRequiredChildren:
type: boolean
include:
type: boolean
singleValue:
$ref: '#/components/schemas/DatasetFieldValue'
singleControlledVocabularyValue:
$ref: '#/components/schemas/ControlledVocabularyValue'
value:
type: string
displayValue:
type: string
rawValue:
type: string
compoundDisplayValue:
type: string
compoundRawValue:
type: string
values:
type: array
items:
type: string
rawValuesList:
type: array
items:
type: string
values_nondisplay:
type: array
items:
type: string
displayValues:
type: array
items:
type: string
valuesWithoutNaValues:
type: array
items:
type: string
empty:
type: boolean
emptyForDisplay:
type: boolean
hasRequiredChildrenDV:
type: boolean
dataverse:
$ref: '#/components/schemas/Dataverse'
StorageQuota:
type: object
properties:
id:
format: int64
type: integer
definitionPoint:
$ref: '#/components/schemas/DvObject'
allocation:
format: int64
type: integer
DatasetLock:
type: object
properties:
id:
format: int64
type: integer
startTime:
format: date
type: string
example: 2022-03-10
dataset:
$ref: '#/components/schemas/Dataset'
user:
$ref: '#/components/schemas/AuthenticatedUser'
reason:
$ref: '#/components/schemas/Reason'
info:
type: string
JsonLDNamespace:
type: object
properties:
prefix:
type: string
url:
type: string
Type2:
enum:
- EXPLORE
- CONFIGURE
- PREVIEW
- QUERY
type: string
DevOAuthAccountType:
enum:
- PRODUCTION
- RANDOM_EMAIL0
- RANDOM_EMAIL1
- RANDOM_EMAIL2
- RANDOM_EMAIL3
type: string
SavedSearchFilterQuery:
type: object
properties:
id:
format: int64
type: integer
filterQuery:
type: string
savedSearch:
$ref: '#/components/schemas/SavedSearch'
DatasetVersionServiceBean:
type: object
properties:
datasetService:
$ref: '#/components/schemas/DatasetServiceBean'
datafileService:
$ref: '#/components/schemas/DataFileServiceBean'
settingsService:
$ref: '#/components/schemas/SettingsServiceBean'
authService:
$ref: '#/components/schemas/AuthenticationServiceBean'
systemConfig:
$ref: '#/components/schemas/SystemConfig'
indexService:
$ref: '#/components/schemas/IndexServiceBean'
em:
type: object
unarchivedDatasetVersions:
type: array
items:
$ref: '#/components/schemas/DatasetVersion'
Template:
type: object
properties:
id:
format: int64
type: integer
name:
maxLength: 255
type: string
usageCount:
format: int64
type: integer
createTime:
format: date
type: string
example: 2022-03-10
termsOfUseAndAccess:
$ref: '#/components/schemas/TermsOfUseAndAccess'
datasetFields:
type: array
items:
$ref: '#/components/schemas/DatasetField'
instructions:
type: string
instructionsMap:
type: object
additionalProperties:
type: string
metadataBlocksForView:
type: object
additionalProperties:
type: array
items:
$ref: '#/components/schemas/DatasetField'
metadataBlocksForEdit:
type: object
additionalProperties:
type: array
items:
$ref: '#/components/schemas/DatasetField'
isDefaultForDataverse:
type: boolean
dataversesHasAsDefault:
type: array
items:
$ref: '#/components/schemas/Dataverse'
dataverse:
$ref: '#/components/schemas/Dataverse'
createDate:
type: string
metadataValueBlocks:
type: array
items:
# --- truncated at 32 KB (172 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/universite-de-montreal/refs/heads/main/openapi/universite-de-montreal-access-api-openapi.yml