How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

UBC Library Abacus Dataverse API

The REST API of Abacus, UBC Library's research-data repository, running Dataverse 5.9 on UBC's own infrastructure at abacus.library.ubc.ca. UBC operates the deployment and the data is UBC's and its BC consortium partners'; the contract itself is Dataverse software's, served by the product at /openapi, and every schema, ruleset and vocabulary in this repo derived from it inherits that. Verified live 2026-08-19 at /api/info/version. This ONE surface was previously recorded as twenty-two separate APIs because the refine step splits a contract by tag — the twenty-two OpenAPI documents are kept as properties here, but they describe one API, not twenty-two.

UBC Library Abacus Dataverse API is one of 7 APIs that University of British Columbia publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 5 JSON Schema definitions.

Tagged areas include Research Data, Research Repository, Dataverse, and Open Data. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, authentication docs, and 5 JSON Schemas.

This API exposes 22 operations across 20 paths, and defines 176 schemas. It is described by OpenAPI 3.0.0, at version 5.9.

Requests are made against a single base URL, https://abacus.library.ubc.ca.

22 operations 20 paths 176 schemas 2 DELETE14 GET2 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
5.9
Base URL
https://abacus.library.ubc.ca
Resource Areas
1

Paths & Operations 22

Across 20 paths, the API surfaces 22 operations — 2 DELETE, 14 GET, 2 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Access 22
GET
/api/v1/access/datafile/bundle/{fileId}
datafileBundle 4 params → default
GET
/api/v1/access/datafile/{fileId:.+}
datafile 3 params → default
GET
/api/v1/access/datafile/{fileId}/auxiliary
listDatafileMetadataAux 2 params → default
GET
/api/v1/access/datafile/{fileId}/auxiliary/{formatTag}/{formatVersion}
downloadAuxiliaryFile 4 params → default
POST
/api/v1/access/datafile/{fileId}/auxiliary/{formatTag}/{formatVersion}
saveAuxiliaryFileWithVersion 3 params body → default
DELETE
/api/v1/access/datafile/{fileId}/auxiliary/{formatTag}/{formatVersion}
deleteAuxiliaryFileWithVersion 3 params → default
GET
/api/v1/access/datafile/{fileId}/auxiliary/{origin}
listDatafileMetadataAuxByOrigin 3 params → default
GET
/api/v1/access/datafile/{fileId}/metadata
tabularDatafileMetadata 4 params → default
GET
/api/v1/access/datafile/{fileId}/metadata/ddi
tabularDatafileMetadataDDI 4 params → default
PUT
/api/v1/access/datafile/{id}/grantAccess/{identifier}
grantFileAccess 2 params → default
GET
/api/v1/access/datafile/{id}/listRequests
listFileAccessRequests 1 param → default
PUT
/api/v1/access/datafile/{id}/rejectAccess/{identifier}
rejectFileAccess 2 params → default
PUT
/api/v1/access/datafile/{id}/requestAccess
requestFileAccess 1 param → default
DELETE
/api/v1/access/datafile/{id}/revokeAccess/{identifier}
revokeFileAccess 2 params → default
POST
/api/v1/access/datafiles
postDownloadDatafiles 2 params body → default
GET
/api/v1/access/datafiles/{fileIds}
datafiles 3 params → default
GET
/api/v1/access/dataset/{id}
downloadAllFromLatest 3 params → default
GET
/api/v1/access/dataset/{id}/versions/{versionId}
downloadAllFromVersion 4 params → default
GET
/api/v1/access/dsCardImage/{versionId}
dsCardImage 1 param → default
GET
/api/v1/access/dvCardImage/{dataverseId}
dvCardImage 1 param → default
GET
/api/v1/access/fileCardImage/{fileId}
fileCardImage 1 param → default
PUT
/api/v1/access/{id}/allowAccessRequest
allowAccessRequest 1 param body → default

Schemas 176

The contract defines 176 schemas that model the data the API accepts and returns. The most detailed are Dataverse (54 properties), EjbDataverseEngine (43 properties), DataFile (43 properties), Dataset (39 properties). Each schema is shown below with its type and property counts.

IpAddress
object
Reason
AlternativePersistentIdentifier
object
8 properties
IpGroupsServiceBean
object
3 properties
SettingsServiceBean
object
2 properties
DvObject
object
21 properties
PermissionServiceBean
object
11 properties
DOIDataCiteServiceBean
object
7 properties
IndexServiceBean
object
22 properties
PasswordValidatorServiceBean
object
9 properties
DataverseRoleServiceBean
object
5 properties
PersistedGlobalGroup
object
4 properties
Type
Embargo
object
4 properties
AuxiliaryFile
object
10 properties
DatasetVersion
object
24 properties
AbstractGlobalIdServiceBean
object
6 properties
ExternalToolType
object
3 properties
SettingsWrapper
object
29 properties
DataverseSession
object
13 properties
IngestRequest
object
6 properties
DatasetServiceBean
object
12 properties
DatasetVersionUser
object
4 properties
DataCaptureModuleServiceBean
object
FileDifferenceDetailItem
object
3 properties
MailDomainGroupProvider
object
1 property
FeaturedDataverseServiceBean
object
2 properties
ActionLogServiceBean
object
1 property
SummaryStatistic
object
4 properties
DvObjectContainer
object
24 properties
ExternalTool
object
9 properties
CategoryMetadata
object
4 properties
RoleAssignment
object
6 properties
DvObjectServiceBean
object
1 property
WorkflowServiceBean
object
9 properties
VariableType
OAuth2TokenData
object
8 properties
ImageFormat
datasetReplaceFileItem
object
8 properties
FileVersionDifference
object
6 properties
FileDownloadHelper
object
9 properties
DatasetFieldCompoundValue
object
7 properties
IngestReport
object
7 properties
MakeDataCountLoggingServiceBean
object
1 property
IndexBatchServiceBean
object
7 properties
UserNotificationServiceBean
object
2 properties
DataverseHeaderFragment
object
14 properties
FileMetadata
object
17 properties
datasetFileDifferenceItem
object
19 properties
SavedSearchServiceBean
object
6 properties
DataverseType
DataverseEntity
object
1 property
DataverseRole
object
6 properties
SavedSearch
object
5 properties
DatasetFieldType
object
30 properties
DataCiteRESTfullClient
object
4 properties
DatasetExternalCitations
object
3 properties
PrivateUrlServiceBean
object
3 properties
GuestbookResponseServiceBean
object
2 properties
GroupServiceBean
object
10 properties
AuthenticationProvidersRegistrationServiceBean
object
8 properties
Alignment
SavedSearchFilterQuery
object
3 properties
SolrClientService
object
2 properties
DOIEZIdServiceBean
object
11 properties
DataTable
object
11 properties
VariableCategory
object
7 properties
BannerMessageServiceBean
object
1 property
ExplicitGroupProvider
object
2 properties
DatasetVersionServiceBean
object
7 properties
DataverseFacet
object
4 properties
UserNotification
object
11 properties
OAISetServiceBean
object
5 properties
TemplateServiceBean
object
2 properties
DOIDataCiteRegisterService
object
4 properties
DataverseLinkingDataverse
object
4 properties
DatasetFieldValue
object
5 properties
VariableRangeItem
object
3 properties
FieldType
DataFile
object
43 properties
GuestbookResponse
object
15 properties
DataverseFieldTypeInputLevelServiceBean
object
1 property
ControlledVocabAlternate
object
4 properties
DifferenceSummaryItem
object
6 properties
VariableMetadataUtil
object
Dataverse
object
54 properties
DataFileCategory
object
4 properties
CustomQuestionValue
object
4 properties
EmbargoServiceBean
object
2 properties
SystemConfig
object
4 properties
FileDifferenceSummaryGroup
object
2 properties
NavigationWrapper
object
2 properties
UserBannerMessage
object
4 properties
FileDownloadServiceBean
object
16 properties
AuthenticationServiceBean
object
16 properties
DataverseLinkingServiceBean
object
2 properties
ShibGroupServiceBean
object
4 properties
CustomQuestionResponse
object
5 properties
VersionState
WorkflowComment
object
7 properties
BundleDownloadInstance
object
5 properties
SearchServiceBean
object
6 properties
DataverseTheme
object
14 properties
OAIRecordServiceBean
object
5 properties
DataVariable
object
22 properties
ClientHarvestRun
object
8 properties
TermsOfUseAndAccess
object
20 properties
License
BannerMessageText
object
4 properties
TagType
DatasetMetrics
object
16 properties
DataFileTag
object
3 properties
MailServiceBean
object
11 properties
DatasetFieldDefaultValue
object
7 properties
BuiltinUserServiceBean
object
3 properties
DataverseFacetServiceBean
object
2 properties
Cart
object
1 property
MailDomainGroup
object
7 properties
VariableRangeType
VariableInterval
AuthenticatedUserLookup
object
4 properties
SolrIndexServiceBean
object
9 properties
EjbDataverseEngine
object
43 properties
DefaultValueSet
object
3 properties
CustomQuestion
object
9 properties
ShibGroupProvider
object
1 property
GuestbookServiceBean
object
1 property
ControlledVocabularyValue
object
6 properties
DatasetFieldServiceBean
object
5 properties
DataverseFieldTypeInputLevel
object
5 properties
ExplicitGroupServiceBean
object
3 properties
Template
object
11 properties
FileDifferenceSummaryItem
object
6 properties
DataverseServiceBean
object
12 properties
DifferenceSummaryGroup
object
3 properties
FakePidProviderServiceBean
object
6 properties
ConfirmEmailServiceBean
object
5 properties
Scope
HarvestingClient
object
18 properties
UserServiceBean
object
2 properties
RoleAssigneeServiceBean
object
6 properties
DownloadInfo
object
9 properties
DataverseRequestServiceBean
object
3 properties
SearchPermissionsServiceBean
object
9 properties
HandlenetServiceBean
object
7 properties
DatasetLinkingServiceBean
object
1 property
ChecksumType
VariableMetadata
object
13 properties
DownloadInstance
object
10 properties
Guestbook
object
15 properties
Dataset
object
39 properties
SummaryStatisticType
DataverseRequest
object
3 properties
AuthenticatedUser
object
24 properties
VarGroup
object
4 properties
VariableServiceBean
object
1 property
EjbDataverseEngineInner
object
1 property
MailDomainGroupServiceBean
object
6 properties
DatasetLock
object
6 properties
RunResultType
IpGroupProvider
object
1 property
Breadcrumb
object
4 properties
DataverseContact
object
4 properties
DatasetVersionDifference
object
15 properties
PasswordResetServiceBean
object
6 properties
DataFileServiceBean
object
7 properties
DatasetField
object
12 properties
MetadataBlock
object
10 properties
BannerMessage
object
5 properties
DatasetLinkingDataverse
object
4 properties
DataverseFeaturedDataverse
object
4 properties
IndexAsync
object
1 property
FileDownload
object
7 properties
IngestServiceBean
object
7 properties
OptionalAccessService
object
4 properties
VariableRange
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ubc-access-api-openapi.yml Raw ↑

Other APIs University of British Columbia publishes across the network.

UBC Library Open Collections API
UBC Library Open Collections IIIF Presentation API
Abacus OAI-PMH Metadata Harvesting Endpoint
UBC Shibboleth Identity Provider Metadata
UBC Integration Enablement Centre API Gateway
UBC IT Service Status API
Where this information came from

This is an independent, third-party profile of UBC Library Abacus Dataverse API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.