University of North Carolina at Chapel Hill

University of North Carolina at Chapel Hill Batch API

The Batch API from University of North Carolina at Chapel Hill — 3 operation(s) for batch.

GitHub OpenAPI

Documentation

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

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/university-of-north-carolina-at-chapel-hill/refs/heads/main/openapi/university-of-north-carolina-at-chapel-hill-batch-api-openapi.yml

Other Resources

🔗
Website
https://dataverse.unc.edu/
🔗
x-json-schema
https://raw.githubusercontent.com/api-evangelist/university-of-north-carolina-at-chapel-hill/refs/heads/main/json-schema/university-of-north-carolina-at-chapel-hill-dataset-schema.json
🔗
x-json-schema
https://raw.githubusercontent.com/api-evangelist/university-of-north-carolina-at-chapel-hill/refs/heads/main/json-schema/university-of-north-carolina-at-chapel-hill-info-version-schema.json
🔗
x-json-structure
https://raw.githubusercontent.com/api-evangelist/university-of-north-carolina-at-chapel-hill/refs/heads/main/json-structure/university-of-north-carolina-at-chapel-hill-dataset-structure.json
🔗
x-json-structure
https://raw.githubusercontent.com/api-evangelist/university-of-north-carolina-at-chapel-hill/refs/heads/main/json-structure/university-of-north-carolina-at-chapel-hill-info-version-structure.json
🔗
x-example
https://raw.githubusercontent.com/api-evangelist/university-of-north-carolina-at-chapel-hill/refs/heads/main/examples/university-of-north-carolina-at-chapel-hill-info-version-example.json
🔗
x-example
https://raw.githubusercontent.com/api-evangelist/university-of-north-carolina-at-chapel-hill/refs/heads/main/examples/university-of-north-carolina-at-chapel-hill-search-example.json
🔗
x-spectral-rules
https://raw.githubusercontent.com/api-evangelist/university-of-north-carolina-at-chapel-hill/refs/heads/main/rules/university-of-north-carolina-at-chapel-hill-rules.yml
🔗
x-vocabulary
https://raw.githubusercontent.com/api-evangelist/university-of-north-carolina-at-chapel-hill/refs/heads/main/vocabulary/university-of-north-carolina-at-chapel-hill-vocabulary.yml
🔗
x-json-ld
https://raw.githubusercontent.com/api-evangelist/university-of-north-carolina-at-chapel-hill/refs/heads/main/json-ld/university-of-north-carolina-at-chapel-hill-context.jsonld

OpenAPI Specification

university-of-north-carolina-at-chapel-hill-batch-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Dataverse Access Batch API
  description: Open source research data repository software.
  version: '6.8'
servers:
- url: https://dataverse.unc.edu/api
  description: UNC Dataverse production instance
tags:
- name: Batch
paths:
  /batch/harvest:
    get:
      operationId: BatchImport_harvest
      parameters:
      - name: createDV
        in: query
        schema:
          type: boolean
      - name: dv
        in: query
        schema:
          type: string
      - name: key
        in: query
        schema:
          type: string
      - name: path
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Batch
  /batch/import:
    get:
      operationId: BatchImport_getImport
      parameters:
      - name: createDV
        in: query
        schema:
          type: boolean
      - name: dv
        in: query
        schema:
          type: string
      - name: key
        in: query
        schema:
          type: string
      - name: path
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Batch
    post:
      operationId: BatchImport_postImport
      parameters:
      - name: dv
        in: query
        schema:
          type: string
      - name: key
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Batch
  /batch/jobs/import/datasets/files/{identifier}:
    post:
      operationId: FileRecordJobResource_getFilesystemImport
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          type: string
      - name: mode
        in: query
        schema:
          default: MERGE
          type: string
      - name: totalSize
        in: query
        schema:
          format: int64
          type: integer
      - name: uploadFolder
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Batch