Skip to main content

Swagger UI

Swagger UI

For interactive API documentation, access the Swagger UI at: https://your-opencdmp-instance/api/swagger-ui/index.html. It contains documentation for the following API endpoints.

  • /api/plan/**
  • /api/description/**
  • /api/plan-blueprint/**
  • /api/description-template/**
  • /api/description-template-type/**
  • /api/reference/**
  • /api/reference-type/**
  • /api/user/**
  • /api/tenants**
  • /api/file-transformer/**
  • /api/evaluator/**
  • /api/deposit/**
  • /api/entity-doi/**
  • /api/plan-status/**
  • /api/plan-workflow/**
  • /api/description-status/**
  • /api/description-workflow/**
  • /api/tag/**
  • /api/principal/**
  • /api/lock/**
info

These endpoints require authentication.

Base URL​

All API endpoints are relative to your OpenCDMP instance:

https://your-opencdmp-instance/api

Example: https://opencdmp.example.org/api

Authentication​

All API requests (except legacy public endpoints) require authentication using OAuth2 Bearer tokens. In Swagger UI page authorize with your account to get authentication access.

Request Header​

Authorization: Bearer {access_token}

Example:

GET /api/plan HTTP/1.1
Host: opencdmp.example.org
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Content-Type: user-guide/json