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

KU Leuven Access API

The Access API from KU Leuven — 23 operation(s) for access.

KU Leuven Access API is one of 41 APIs that KU Leuven 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 215 schemas. It is described by OpenAPI 3.0.3, at version 6.7.1.

Requests are made against a single base URL, https://rdr.kuleuven.be/api.

24 operations 23 paths 215 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.7.1
Base URL
https://rdr.kuleuven.be/api
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 215

The contract defines 215 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.

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ku-leuven-access-api-openapi.yml Raw ↑

Other APIs KU Leuven publishes across the network.

KU Leuven Person Information API
KU Leuven Educational Offering (Onderwijsaanbod) API
KU Leuven Organizational Chart (Organigram) API
KU Leuven Vacancies (Vacatures) API
KU Leuven Individual Timetable (Uurrooster) API
KU Leuven addFilesToDataset API
KU Leuven addFileToDataset API
KU Leuven addGlobusFilesToDataset API
KU Leuven Admin API
KU Leuven Batch API
KU Leuven Builtin Users API
KU Leuven Datasetfields API