University of Göttingen

University of Göttingen Files API

The Files API from University of Göttingen — 19 operation(s) for files.

GitHub OpenAPI

Documentation

📖
Documentation
https://guides.dataverse.org/en/latest/api/

Specifications

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

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/university-of-gottingen/refs/heads/main/json-schema/university-of-gottingen-dataset-schema.json

Other Resources

🔗
x-json-structure
https://raw.githubusercontent.com/api-evangelist/university-of-gottingen/refs/heads/main/json-structure/university-of-gottingen-dataset-structure.json
🔗
x-example
https://raw.githubusercontent.com/api-evangelist/university-of-gottingen/refs/heads/main/examples/university-of-gottingen-search-example.json
🔗
x-spectral-ruleset
https://raw.githubusercontent.com/api-evangelist/university-of-gottingen/refs/heads/main/rules/university-of-gottingen-rules.yml
🔗
x-vocabulary
https://raw.githubusercontent.com/api-evangelist/university-of-gottingen/refs/heads/main/vocabulary/university-of-gottingen-vocabulary.yml
🔗
x-json-ld-context
https://raw.githubusercontent.com/api-evangelist/university-of-gottingen/refs/heads/main/json-ld/university-of-gottingen-context.jsonld

OpenAPI Specification

university-of-gottingen-files-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: GRO.data Dataverse REST Access Files API
  description: Native REST/search API for the GRO.data (Göttingen Research Online) Dataverse research-data repository operated by the Göttingen eResearch Alliance. Based on Dataverse 6.4.
  version: '6.4'
servers:
- url: https://data.goettingen-research-online.de/api
  description: GRO.data (Göttingen Research Online) Dataverse REST API
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}/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
      responses:
        '200':
          description: OK
      tags:
      - Files
  /files/{id}/metadata/categories:
    post:
      operationId: Files_setFileCategories
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      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
      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}/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