Maastricht University

Maastricht University Harvest API

The Harvest API from Maastricht University — 7 operation(s) for harvest.

GitHub OpenAPI

Documentation

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

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/maastricht/refs/heads/main/openapi/maastricht-harvest-api-openapi.yml

Other Resources

🔗
Website
https://dataverse.nl/dataverse/maastricht
🔗
x-json-schema
https://raw.githubusercontent.com/api-evangelist/maastricht/refs/heads/main/json-schema/maastricht-dataverse-schema.json
🔗
x-json-schema
https://raw.githubusercontent.com/api-evangelist/maastricht/refs/heads/main/json-schema/maastricht-dataset-schema.json
🔗
x-json-structure
https://raw.githubusercontent.com/api-evangelist/maastricht/refs/heads/main/json-structure/maastricht-dataverse-structure.json
🔗
x-json-structure
https://raw.githubusercontent.com/api-evangelist/maastricht/refs/heads/main/json-structure/maastricht-dataset-structure.json
🔗
x-example
https://raw.githubusercontent.com/api-evangelist/maastricht/refs/heads/main/examples/maastricht-getDataverse-example.json
🔗
x-example
https://raw.githubusercontent.com/api-evangelist/maastricht/refs/heads/main/examples/maastricht-search-example.json
🔗
x-example
https://raw.githubusercontent.com/api-evangelist/maastricht/refs/heads/main/examples/maastricht-version-example.json
🔗
x-spectral-rules
https://raw.githubusercontent.com/api-evangelist/maastricht/refs/heads/main/rules/maastricht-rules.yml
🔗
x-vocabulary
https://raw.githubusercontent.com/api-evangelist/maastricht/refs/heads/main/vocabulary/maastricht-vocabulary.yml
🔗
x-json-ld
https://raw.githubusercontent.com/api-evangelist/maastricht/refs/heads/main/json-ld/maastricht-context.jsonld

OpenAPI Specification

maastricht-harvest-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Dataverse Access Harvest API
  description: 'Open source research data repository software. — DataverseNL installation (v6.9) hosting the Maastricht University research data collection (alias: maastricht). Spec retrieved live from https://dataverse.nl/openapi and saved faithfully as OpenAPI 3.0.3.'
  version: '6.9'
servers:
- url: https://dataverse.nl/api
  description: DataverseNL production REST API (hosts the Maastricht University collection at /dataverse/maastricht)
tags:
- name: Harvest
paths:
  /harvest/clients:
    get:
      operationId: HarvestingClients_harvestingClients
      parameters:
      - name: key
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Harvest
  /harvest/clients/{nickName}:
    get:
      operationId: HarvestingClients_harvestingClient
      parameters:
      - name: nickName
        in: path
        required: true
        schema:
          type: string
      - name: key
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Harvest
    put:
      operationId: HarvestingClients_modifyHarvestingClient
      parameters:
      - name: nickName
        in: path
        required: true
        schema:
          type: string
      - name: key
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Harvest
    post:
      operationId: HarvestingClients_createHarvestingClient
      parameters:
      - name: nickName
        in: path
        required: true
        schema:
          type: string
      - name: key
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Harvest
    delete:
      operationId: HarvestingClients_deleteHarvestingClient
      parameters:
      - name: nickName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Harvest
  /harvest/clients/{nickName}/run:
    post:
      operationId: HarvestingClients_startHarvestingJob
      parameters:
      - name: nickName
        in: path
        required: true
        schema:
          type: string
      - name: key
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Harvest
  /harvest/server/oaisets:
    get:
      operationId: HarvestingServer_oaiSets
      parameters:
      - name: key
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Harvest
  /harvest/server/oaisets/add:
    post:
      operationId: HarvestingServer_createOaiSet
      parameters:
      - name: key
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Harvest
  /harvest/server/oaisets/{specname}:
    get:
      operationId: HarvestingServer_oaiSet
      parameters:
      - name: specname
        in: path
        required: true
        schema:
          type: string
      - name: key
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Harvest
    put:
      operationId: HarvestingServer_modifyOaiSet
      parameters:
      - name: specname
        in: path
        required: true
        schema:
          type: string
      - name: key
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Harvest
    delete:
      operationId: HarvestingServer_deleteOaiSet
      parameters:
      - name: specname
        in: path
        required: true
        schema:
          type: string
      - name: key
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Harvest
  /harvest/server/oaisets/{specname}/datasets:
    get:
      operationId: HarvestingServer_oaiSetListDatasets
      parameters:
      - name: specname
        in: path
        required: true
        schema:
          type: string
      - name: key
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Harvest