Harvard University

Harvard University Files API

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

GitHub OpenAPI
Business capability
Information & Data Management BC-610

Operations 26

GET /files/fixityAlgorithm Files get fixity algorithm #
GET /files/{id} Files get file data #
DELETE /files/{id} Files delete file in dataset #
GET /files/{id}/dataTables Files get file data tables #
GET /files/{id}/downloadCount Files get file download count #
POST /files/{id}/externalTool/{tid}/toolUrl Files get external tool url #
POST /files/{id}/extractNcml Files extract ncml #
GET /files/{id}/hasBeenDeleted Files get has been deleted #
GET /files/{id}/metadata Files get file metadata #
POST /files/{id}/metadata Files update file metadata #
POST /files/{id}/metadata/categories Files set file categories #
GET /files/{id}/metadata/draft Files get file metadata draft #
POST /files/{id}/metadata/tabularTags Files set file tabular tags #
GET /files/{id}/metadata/{fmid}/toolparams/{tid} Files get external tool FM params #
GET /files/{id}/prov-freeform Prov get prov free form #
POST /files/{id}/prov-freeform Prov add prov free form #
GET /files/{id}/prov-json Prov get prov json #
POST /files/{id}/prov-json Prov add prov json #
DELETE /files/{id}/prov-json Prov delete prov json #
POST /files/{id}/redetect Files redetect datafile #
POST /files/{id}/reingest Files reingest #
PUT /files/{id}/restrict Files restrict file in dataset #
POST /files/{id}/uningest Files uningest datafile #
GET /files/{id}/versionDifferences Files get file versions list #
GET /files/{id}/versions/{datasetVersionId} Files get file data for version #
GET /files/{id}/versions/{dsVersionString}/citation Files get file citation by version #

Documentation

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

Specifications

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

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/harvard/refs/heads/main/json-schema/harvard-lil-lawskills-persona-index.schema.json

Other Resources

🔗
GitHub
https://github.com/IQSS/dataverse
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/harvard/refs/heads/main/examples/harvard-dataverse-search-response.json
🔗
GitHub
https://github.com/harvard-lil/lawskills-hub
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/harvard/refs/heads/main/examples/harvard-lil-lawskills-personas.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/harvard-files-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

harvard-files-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Dataverse Files API
  description: Open source research data repository software.
  version: 6.10.1
tags:
- name: Files
paths:
  /files/fixityAlgorithm:
    get:
      operationId: Files_getFixityAlgorithm
      responses:
        '200':
          description: OK
      tags:
      - Files
      summary: Files get fixity algorithm
      x-summary-source: derived
  /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
      summary: Files get file data
      x-summary-source: derived
    delete:
      operationId: Files_deleteFileInDataset
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
      summary: Files delete file in dataset
      x-summary-source: derived
  /files/{id}/dataTables:
    get:
      operationId: Files_getFileDataTables
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
      summary: Files get file data tables
      x-summary-source: derived
  /files/{id}/downloadCount:
    get:
      operationId: Files_getFileDownloadCount
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
      summary: Files get file download count
      x-summary-source: derived
  /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
      summary: Files get external tool url
      x-summary-source: derived
  /files/{id}/extractNcml:
    post:
      operationId: Files_extractNcml
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
      summary: Files extract ncml
      x-summary-source: derived
  /files/{id}/hasBeenDeleted:
    get:
      operationId: Files_getHasBeenDeleted
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
      summary: Files get has been deleted
      x-summary-source: derived
  /files/{id}/metadata:
    get:
      operationId: Files_getFileMetadata
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
      summary: Files get file metadata
      x-summary-source: derived
    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
      summary: Files update file metadata
      x-summary-source: derived
  /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
      summary: Files set file categories
      x-summary-source: derived
  /files/{id}/metadata/draft:
    get:
      operationId: Files_getFileMetadataDraft
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
      summary: Files get file metadata draft
      x-summary-source: derived
  /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
      summary: Files set file tabular tags
      x-summary-source: derived
  /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
      summary: Files get external tool FM params
      x-summary-source: derived
  /files/{id}/prov-freeform:
    get:
      operationId: Prov_getProvFreeForm
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
      summary: Prov get prov free form
      x-summary-source: derived
    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
      summary: Prov add prov free form
      x-summary-source: derived
  /files/{id}/prov-json:
    get:
      operationId: Prov_getProvJson
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
      summary: Prov get prov json
      x-summary-source: derived
    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
      summary: Prov add prov json
      x-summary-source: derived
    delete:
      operationId: Prov_deleteProvJson
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
      summary: Prov delete prov json
      x-summary-source: derived
  /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
      summary: Files redetect datafile
      x-summary-source: derived
  /files/{id}/reingest:
    post:
      operationId: Files_reingest
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
      summary: Files reingest
      x-summary-source: derived
  /files/{id}/restrict:
    put:
      operationId: Files_restrictFileInDataset
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
      summary: Files restrict file in dataset
      x-summary-source: derived
  /files/{id}/uningest:
    post:
      operationId: Files_uningestDatafile
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Files
      summary: Files uningest datafile
      x-summary-source: derived
  /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
      summary: Files get file versions list
      x-summary-source: derived
  /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
      summary: Files get file data for version
      x-summary-source: derived
  /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
      summary: Files get file citation by version
      x-summary-source: derived