Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Queen's University at Kingston

Queen's University at Kingston Access API

The Access API from Queen's University at Kingston — 23 operation(s) for access.

Documentation Provider Profile APIs.io OpenAPI GitHub

Queen’s University at Kingston Access API is one of 38 APIs that Queen’s University at Kingston publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Access. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 24 operations across 23 paths, and defines 221 schemas. It is described by OpenAPI 3.0.3, at version v6.8.1-SP.

Requests are made against a single base URL, https://borealisdata.ca/api.

24 operations 23 paths 221 schemas 2 DELETE17 GET1 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v6.8.1-SP
Base URL
https://api.qmulus.io/v1
Resource Areas
1

Paths & Operations 24

Across 23 paths, the API surfaces 24 operations — 2 DELETE, 17 GET, 1 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Access 24
GET
/access/datafile/bundle/{fileId}
Access_datafileBundle 3 params → 200
GET
/access/datafile/{fileId}
Access_datafile 2 params → 200
GET
/access/datafile/{fileId}/auxiliary
Access_listDatafileMetadataAux 1 param → 200
GET
/access/datafile/{fileId}/auxiliary/{formatTag}/{formatVersion}
Access_downloadAuxiliaryFile 3 params → 200
DELETE
/access/datafile/{fileId}/auxiliary/{formatTag}/{formatVersion}
Access_deleteAuxiliaryFileWithVersion 3 params → 200
GET
/access/datafile/{fileId}/auxiliary/{origin}
Access_listDatafileMetadataAuxByOrigin 2 params → 200
GET
/access/datafile/{fileId}/metadata
Access_tabularDatafileMetadata 4 params → 200
GET
/access/datafile/{fileId}/metadata/ddi
Access_tabularDatafileMetadataDDI 4 params → 200
PUT
/access/datafile/{id}/grantAccess/{identifier}
Access_grantFileAccess 2 params → 200
GET
/access/datafile/{id}/listRequests
Access_listFileAccessRequests 1 param → 200
PUT
/access/datafile/{id}/rejectAccess/{identifier}
Access_rejectFileAccess 2 params → 200
PUT
/access/datafile/{id}/requestAccess
Access_requestFileAccess 1 param → 200
DELETE
/access/datafile/{id}/revokeAccess/{identifier}
Access_revokeFileAccess 2 params → 200
GET
/access/datafile/{id}/userFileAccessRequested
Access_getUserFileAccessRequested 1 param → 200
GET
/access/datafile/{id}/userPermissions
Access_getUserPermissionsOnFile 1 param → 200
POST
/access/datafiles
Access_postDownloadDatafiles 1 param body → 200
GET
/access/datafiles/{fileIds}
Access_datafiles 2 params → 200
GET
/access/dataset/{id}
Access_downloadAllFromLatest 2 params → 200
GET
/access/dataset/{id}/versions/{versionId}
Access_downloadAllFromVersion 4 params → 200
GET
/access/dataverseFeaturedItemImage/{itemId}
Access_getDataverseFeatureItemImage 1 param → 200
GET
/access/dsCardImage/{versionId}
Access_dsCardImage 1 param → 200
GET
/access/dvCardImage/{dataverseId}
Access_dvCardImage 1 param → 200
GET
/access/fileCardImage/{fileId}
Access_fileCardImage 1 param → 200
PUT
/access/{id}/allowAccessRequest
Access_allowAccessRequest 1 param → 200

Schemas 221

The contract defines 221 schemas that model the data the API accepts and returns. The most detailed are Dataverse (107 properties), Dataset (103 properties), DataFile (96 properties), DatasetVersion (94 properties). Each schema is shown below with its type and property counts.

DatasetLock
object
6 properties
BuiltinUserServiceBean
object
3 properties
ExternalToolType
object
3 properties
DatasetVersionUser
object
4 properties
DatasetExternalCitations
object
3 properties 1 required
WorkflowStepSPI
object
ClientHarvestRun
object
16 properties
Breadcrumb
object
4 properties
DatasetFieldCompoundValue
object
11 properties
VariableCategory
object
8 properties
DataFileCategory
object
4 properties
DataverseFieldTypeInputLevelServiceBean
object
1 property
DataverseType
string
DvObject
object
36 properties
DatasetVersion
object
94 properties
IndexServiceBean
object
23 properties
OptionalAccessService
object
5 properties
StorageQuota
object
3 properties
StorageUseServiceBean
object
1 property
DvObjectServiceBean
object
3 properties
DataverseFacet
object
4 properties
UserNotificationServiceBean
object
3 properties
CustomQuestion
object
10 properties 1 required
VariableRangeItem
object
3 properties
OIDCAuthProvider
object
26 properties
UserNotification
object
14 properties
SearchService
object
3 properties
DifferenceSummaryItem
object
6 properties
SolrClientIndexService
object
3 properties
FileDifferenceSummaryGroup
object
2 properties
IndexBatchServiceBean
object
11 properties
AuxiliaryFile
object
11 properties
Dataverse
object
107 properties 1 required
DatasetVersionDifference
object
19 properties
Type
string
datasetReplaceFileItem
object
8 properties
Guestbook
object
20 properties
DatasetFieldServiceBean
object
6 properties
PasswordValidatorServiceBean
object
9 properties
IngestServiceBean
object
9 properties
SolrClientService
object
3 properties
AuthenticationProviderFactory
object
2 properties
SavedSearchFilterQuery
object
3 properties
SummaryNote
object
5 properties
SavedSearchServiceBean
object
8 properties
OAuth2TokenData
object
8 properties
SystemConfig
object
80 properties
DatasetVersionServiceBean
object
8 properties
MailServiceBean
object
13 properties
DataverseSession
object
14 properties
RoleAssignee
object
3 properties
DataverseLinkingDataverse
object
4 properties
MetadataBlock
object
18 properties
VarGroup
object
4 properties
Reason
string
RoleAssigneeServiceBean
object
6 properties
CategoryMetadata
object
4 properties
Permission
string
TemplateServiceBean
object
2 properties
OAIRecordServiceBean
object
4 properties
PidProviderFactoryBean
object
8 properties
DataAccessRequest
object
2 properties
CacheFactoryBean
object
3 properties
VariableType
string
VariableMetadataUtil
object
DataFileTag
object
6 properties
DataverseTheme
object
15 properties
WorkflowServiceBean
object
10 properties
BannerMessageText
object
4 properties
DatasetRelPublication
object
12 properties
BundleDownloadInstance
object
5 properties
SummaryStatisticType
string
Type1
string
CustomQuestionValue
object
4 properties
FailedPIDResolutionLoggingServiceBean
object
1 property
FileDownloadHelper
object
10 properties
ShibGroupProvider
object
3 properties
DataverseRole
object
7 properties
UserBannerMessage
object
4 properties
DatasetLinkingDataverse
object
4 properties
DatasetField
object
28 properties
SettingsWrapper
object
63 properties
ConfirmEmailServiceBean
object
5 properties
DataverseFieldTypeInputLevel
object
6 properties
TagType
string
AuthenticatedUserLookup
object
4 properties
DataverseFeaturedItemServiceBean
object
4 properties
GlobusServiceBean
object
17 properties
DataverseFeaturedDataverse
object
4 properties
MailDomainGroupServiceBean
object
6 properties
RunResultType
string
SolrType
string
DifferenceSummaryGroup
object
3 properties
CustomQuestionResponse
object
5 properties
AuthenticationServiceBean
object
26 properties
PasswordResetServiceBean
object
6 properties
RoleAssigneeDisplayInfo
object
3 properties
AffiliationGroupProvider
object
5 properties
ExternalTool
object
16 properties
PermissionServiceBean
object
12 properties
ExplicitGroupProvider
object
4 properties
AuthenticatedUser
object
41 properties 4 required
SolrIndexServiceBean
object
8 properties
FileDownloadServiceBean
object
16 properties
JsonLDTerm
object
4 properties
ImageFormat
string
AuthenticationProvidersRegistrationServiceBean
object
13 properties
StorageIODataFile
object
44 properties
DataverseMetadataBlockFacet
object
3 properties
DatasetFieldType
object
49 properties
VariableRangeType
string
DatasetFieldsValidator
object
1 property
DataverseServiceBean
object
22 properties
GuestbookResponse
object
22 properties
ControlledVocabularyValue
object
7 properties
PidProvider
object
15 properties
Embargo
object
5 properties
DatasetTypeServiceBean
object
1 property
Template
object
16 properties
DataTable
object
12 properties
DatasetAuthor
object
8 properties
ExplicitGroupServiceBean
object
3 properties
VariableMetadata
object
13 properties
EjbDataverseEngineInner
object
1 property
DefaultValueSet
object
3 properties
AuthenticationProvider
object
9 properties
JsonLDNamespace
object
2 properties
MakeDataCountLoggingServiceBean
object
2 properties
Scope
string
Command
object
3 properties
IndexAsync
object
1 property
DataverseFeaturedItem
object
9 properties 1 required
DatasetDistributor
object
8 properties
UserServiceBean
object
4 properties
LicenseServiceBean
object
3 properties
OrcidOAuth2AP
object
21 properties
DataVariable
object
31 properties
WorkflowComment
object
7 properties
DataverseRequestServiceBean
object
3 properties
FieldType
string
GroupProvider
object
2 properties
IngestRequest
object
6 properties
ActionLogServiceBean
object
1 property
EjbDataverseEngine
object
49 properties
DataverseFacetServiceBean
object
2 properties
SettingsServiceBean
object
3 properties
DataverseRequest
object
6 properties
MailDomainGroupProvider
object
3 properties
DatasetType
object
4 properties
IpGroupProvider
object
3 properties
RoleAssignment
object
7 properties
CommandContext
object
1 property
Dataset
object
103 properties
Alignment
string
DownloadInfo
object
14 properties
DataverseHeaderFragment
object
15 properties
Retention
object
5 properties
ShibGroupServiceBean
object
5 properties
FileAccessRequest
object
12 properties
FileVersionDifference
object
6 properties
DatasetFieldValue
object
8 properties
AuthenticatedUserDisplayInfo
object
8 properties
BannerMessageServiceBean
object
1 property
DataverseContact
object
4 properties
GuestbookServiceBean
object
1 property
EmbargoServiceBean
object
2 properties
DevOAuthAccountType
string
Cart
object
1 property
SolrField
object
5 properties
HarvestingClient
object
40 properties
GuestbookResponseServiceBean
object
3 properties
IngestReport
object
8 properties
IpGroupsServiceBean
object
3 properties
DataverseLinkingServiceBean
object
2 properties
FileDifferenceSummaryItem
object
6 properties
DataFileServiceBean
object
9 properties
DatasetMetrics
object
17 properties 1 required
NavigationWrapper
object
3 properties
DataverseRoleServiceBean
object
6 properties
DatasetLinkingServiceBean
object
1 property
RequestState
string
SavedSearch
object
6 properties
GroupServiceBean
object
12 properties
CurationStatus
object
6 properties
PidProviderFactory
object
1 property
DatasetVersionFilesServiceBean
object
1 property
TermsOfUseAndAccess
object
21 properties
DatasetFieldDefaultValue
object
9 properties
AuxiliaryFileServiceBean
object
3 properties
AbstractOAuth2AuthenticationProvider
object
19 properties
VariableServiceBean
object
1 property
BannerMessage
object
6 properties
VersionState
string
SummaryStatistic
object
14 properties
Type2
string
AffiliationServiceBean
object
3 properties
License
object
14 properties
datasetFileDifferenceItem
object
19 properties
StorageUse
object
3 properties
AuthenticationProviderDisplayInfo
object
3 properties
VariableRange
object
16 properties
AffiliationGroup
object
12 properties
MailDomainGroup
object
16 properties 1 required
PrivateUrlServiceBean
object
3 properties
IpAddress
object
1 property
AlternativePersistentIdentifier
object
8 properties
DataCaptureModuleServiceBean
object
FileMetadata
object
22 properties
ControlledVocabAlternate
object
4 properties
User
object
6 properties
DataFile
object
96 properties 1 required
MetadataBlockServiceBean
object
1 property
FeaturedDataverseServiceBean
object
2 properties
ChecksumType
string
SearchServiceFactory
object
6 properties
DatasetServiceBean
object
15 properties
SearchPermissionsServiceBean
object
8 properties
FileDifferenceDetailItem
object
3 properties
AffiliationGroupServiceBean
object
4 properties
VariableInterval
string
DownloadInstance
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

queens-university-at-kingston-access-api-openapi.yml Raw ↑

Other APIs Queen's University at Kingston publishes across the network.

Qmulus Open Data API
AE Profile APIs.io
QSpace Repository API (DSpace)
AE Profile APIs.io
Queen's University at Kingston addFilesToDataset API
AE Profile APIs.io
Queen's University at Kingston addFileToDataset API
AE Profile APIs.io
Queen's University at Kingston addGlobusFilesToDataset API
AE Profile APIs.io
Queen's University at Kingston Admin API
AE Profile APIs.io
Queen's University at Kingston Batch API
AE Profile APIs.io
Queen's University at Kingston Builtin Users API
AE Profile APIs.io
Queen's University at Kingston Datasetfields API
AE Profile APIs.io
Queen's University at Kingston Datasets API
AE Profile APIs.io
Queen's University at Kingston Datatags API
AE Profile APIs.io
Queen's University at Kingston DataverseFeaturedItems API
AE Profile APIs.io
#Access
← Back to Q APIs
API Details
ID
queens-university-at-kingston:queens-university-at-kingston-access-api
Base URL
https://api.qmulus.io/v1
Docs
https://qmulus.io/
Provider
Queen's University at Kingston
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network