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

University of Groningen Access API

The Access API from University of Groningen — 23 operation(s) for access.

University of Groningen Access API is one of 75 APIs that University of Groningen 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, API documentation, and authentication docs.

This API exposes 24 operations across 23 paths, and defines 217 schemas. It is described by OpenAPI 3.0.3, at version 6.9.

Requests are made against a single base URL, https://dataverse.nl.

24 operations 23 paths 217 schemas 2 DELETE17 GET1 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
6.9
Base URL
https://pure.rug.nl/ws/oai
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 217

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

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

university-of-groningen-access-api-openapi.yml Raw ↑

Other APIs University of Groningen publishes across the network.

UG Research Portal OAI-PMH (Pure)
iBridges / Python API for iRODS
University of Groningen activity API
University of Groningen addFilesToDataset API
University of Groningen addFileToDataset API
University of Groningen addGlobusFilesToDataset API
University of Groningen Admin API
University of Groningen application API
University of Groningen authorCollaboration API
University of Groningen award API
University of Groningen Batch API
University of Groningen Builtin Users API
Where this information came from

This is an independent, third-party profile of University of Groningen Access 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.