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

Norwegian University of Science and Technology Access API

The Access API from Norwegian University of Science and Technology — 23 operation(s) for access.

Norwegian University of Science and Technology Access API is one of 39 APIs that Norwegian University of Science and Technology publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

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

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

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

24 operations 23 paths 213 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.6
Base URL
https://api.cristin.no/v2/
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 213

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

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ntnu-access-api-openapi.yml Raw ↑

Other APIs Norwegian University of Science and Technology publishes across the network.

Cristin Research Information API
NVA Nasjonalt Vitenarkiv API
TP Timetable Web Service
Feide / Dataporten Identity (OpenID Connect / SAML)
Norwegian University of Science and Technology addFilesToDataset API
Norwegian University of Science and Technology addFileToDataset API
Norwegian University of Science and Technology addGlobusFilesToDataset API
Norwegian University of Science and Technology Admin API
Norwegian University of Science and Technology Batch API
Norwegian University of Science and Technology Builtin Users API
Norwegian University of Science and Technology Datasetfields API
Norwegian University of Science and Technology Datasets API