University of Groningen

University of Groningen Files API

The Files API from University of Groningen — 21 operation(s) for files.

GitHub OpenAPI

Documentation

📖
Documentation
https://www.rug.nl/library/support/pure/?lang=en
📖
Authentication
https://www.rug.nl/library/support/pure/?lang=en
📖
Documentation
https://guides.dataverse.org/en/latest/api/native-api.html
📖
Documentation
https://www.rug.nl/digital-competence-centre/research-data/archive-and-publish/open-data?lang=en

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/university-of-groningen/refs/heads/main/openapi/university-of-groningen-files-api-openapi.yml

Other Resources

🔗
x-vocabulary
https://raw.githubusercontent.com/api-evangelist/university-of-groningen/refs/heads/main/vocabulary/university-of-groningen-vocabulary.yml
🔗
x-rules
https://raw.githubusercontent.com/api-evangelist/university-of-groningen/refs/heads/main/rules/university-of-groningen-rules.yml
🔗
x-json-ld
https://raw.githubusercontent.com/api-evangelist/university-of-groningen/refs/heads/main/json-ld/university-of-groningen-context.jsonld

OpenAPI Specification

university-of-groningen-files-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Dataverse Access Files API
  description: Open source research data repository software.
  version: '6.9'
servers:
- url: https://dataverse.nl
tags:
- name: Files
paths:
  /files/fixityAlgorithm:
    get:
      operationId: Files_getFixityAlgorithm
      responses:
        '200':
          description: OK
      tags:
      - Files
  /files/{id}:
    get:
      operationId: Files_getFileData
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: includeDeaccessioned
        in: query
        schema:
          type: boolean
      - name: returnDatasetVersion
        in: query
        schema:
          type: boolean
      - name: returnOwners
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: OK
      tags:
      - Files
    delete:
      operationId: Files_deleteFileInDataset
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
  /files/{id}/dataTables:
    get:
      operationId: Files_getFileDataTables
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
  /files/{id}/downloadCount:
    get:
      operationId: Files_getFileDownloadCount
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
  /files/{id}/externalTool/{tid}/toolUrl:
    post:
      operationId: Files_getExternalToolUrl
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: tid
        in: path
        required: true
        schema:
          format: int64
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
  /files/{id}/extractNcml:
    post:
      operationId: Files_extractNcml
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
  /files/{id}/hasBeenDeleted:
    get:
      operationId: Files_getHasBeenDeleted
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
  /files/{id}/metadata:
    get:
      operationId: Files_getFileMetadata
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
    post:
      operationId: Files_updateFileMetadata
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: sourceLastUpdateTime
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
  /files/{id}/metadata/categories:
    post:
      operationId: Files_setFileCategories
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: replace
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: OK
      tags:
      - Files
  /files/{id}/metadata/draft:
    get:
      operationId: Files_getFileMetadataDraft
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
  /files/{id}/metadata/tabularTags:
    post:
      operationId: Files_setFileTabularTags
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: replace
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: OK
      tags:
      - Files
  /files/{id}/metadata/{fmid}/toolparams/{tid}:
    get:
      operationId: Files_getExternalToolFMParams
      parameters:
      - name: fmid
        in: path
        required: true
        schema:
          format: int64
          type: integer
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: tid
        in: path
        required: true
        schema:
          format: int64
          type: integer
      - name: locale
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
  /files/{id}/prov-freeform:
    get:
      operationId: Prov_getProvFreeForm
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
    post:
      operationId: Prov_addProvFreeForm
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
  /files/{id}/prov-json:
    get:
      operationId: Prov_getProvJson
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
    post:
      operationId: Prov_addProvJson
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: entityName
        in: query
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
    delete:
      operationId: Prov_deleteProvJson
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
  /files/{id}/redetect:
    post:
      operationId: Files_redetectDatafile
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: dryRun
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: OK
      tags:
      - Files
  /files/{id}/reingest:
    post:
      operationId: Files_reingest
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
  /files/{id}/restrict:
    put:
      operationId: Files_restrictFileInDataset
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
  /files/{id}/uningest:
    post:
      operationId: Files_uningestDatafile
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
  /files/{id}/versionDifferences:
    get:
      operationId: Files_getFileVersionsList
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: limit
        in: query
        schema:
          format: int32
          type: integer
      - name: offset
        in: query
        schema:
          format: int32
          type: integer
      responses:
        '200':
          description: OK
      tags:
      - Files
  /files/{id}/versions/{datasetVersionId}:
    get:
      operationId: Files_getFileDataForVersion
      parameters:
      - name: datasetVersionId
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: includeDeaccessioned
        in: query
        schema:
          type: boolean
      - name: returnDatasetVersion
        in: query
        schema:
          type: boolean
      - name: returnOwners
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: OK
      tags:
      - Files
  /files/{id}/versions/{dsVersionString}/citation:
    get:
      operationId: Files_getFileCitationByVersion
      parameters:
      - name: dsVersionString
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: includeDeaccessioned
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: OK
      tags:
      - Files