API Guide¶
Contents:
- Introduction
- Getting Started with APIs
- API Tokens and Authentication
- Search API
- Data Access API
- Native API
- Dataverses
- Create a Dataverse
- View a Dataverse
- Delete a Dataverse
- Show Contents of a Dataverse
- Report the data (file) size of a Dataverse
- List Roles Defined in a Dataverse
- List Facets Configured for a Dataverse
- Set Facets for a Dataverse
- Create a New Role in a Dataverse
- List Role Assignments in a Dataverse
- Assign Default Role to User Creating a Dataset in a Dataverse
- Assign a New Role on a Dataverse
- Delete Role Assignment from a Dataverse
- List Metadata Blocks Defined on a Dataverse
- Define Metadata Blocks for a Dataverse
- Determine if a Dataverse Inherits Its Metadata Blocks from Its Parent
- Configure a Dataverse to Inherit Its Metadata Blocks from Its Parent
- Create a Dataset in a Dataverse
- Import a Dataset into a Dataverse
- Import a Dataset into a Dataverse with a DDI file
- Publish a Dataverse
- Datasets
- Get JSON Representation of a Dataset
- List Versions of a Dataset
- Get Version of a Dataset
- Export Metadata of a Dataset in Various Formats
- List Files in a Dataset
- List All Metadata Blocks for a Dataset
- List Single Metadata Block for a Dataset
- Update Metadata For a Dataset
- Edit Dataset Metadata
- Delete Dataset Metadata
- Publish a Dataset
- Delete Dataset Draft
- Set Citation Date Field Type for a Dataset
- Revert Citation Date Field Type to Default for Dataset
- List Role Assignments in a Dataset
- Assign a New Role on a Dataset
- Delete Role Assignment from a Dataset
- Create a Private URL for a Dataset
- Get the Private URL for a Dataset
- Delete the Private URL from a Dataset
- Add a File to a Dataset
- Report the data (file) size of a Dataset
- Get the size of Downloading all the files of a Dataset Version
- Submit a Dataset for Review
- Return a Dataset to Author
- Link a Dataset
- Dataset Locks
- Dataset Metrics
- Delete Unpublished Dataset
- Delete Published Dataset
- Files
- Users Token Management
- Builtin Users
- Roles
- Explicit Groups
- Shibboleth Groups
- Info
- Metadata Blocks
- Notifications
- Admin
- List All Database Settings
- Configure Database Setting
- Get Single Database Setting
- Delete Database Setting
- List Authentication Provider Factories
- List Authentication Providers
- Add Authentication Provider
- Show Authentication Provider
- Enable or Disable an Authentication Provider
- Check If an Authentication Provider is Enabled
- Delete an Authentication Provider
- List Global Roles
- Create Global Role
- List Users
- List Single User
- Merge User Accounts
- Change User Identifier
- Make User a SuperUser
- Delete a User
- List Role Assignments of a Role Assignee
- List Permissions a User Has on a Dataverse or Dataset
- Show Role Assignee
- Saved Search
- Dataset Integrity
- Datafile Integrity
- Dataset Validation
- Workflows
- Metrics
- Inherit Dataverse Role Assignments
- Dataverses
- Metrics API
- SWORD API
- About
- Backward incompatible changes
- New features as of v1.1
- curl examples
- Retrieve SWORD service document
- Create a dataset with an Atom entry
- List datasets in a dataverse
- Add files to a dataset with a zip file
- Display a dataset atom entry
- Display a dataset statement
- Delete a file by database id
- Replacing metadata for a dataset
- Delete a dataset
- Determine if a dataverse has been published
- Publish a dataverse
- Publish a dataset
- Known issues
- Bug fixes in v1.1
- Client libraries
- Client Libraries
- Building External Tools
- Apps
- Frequently Asked Questions
- What is an API?
- What Are Common Use Cases for Dataverse APIs?
- Where Can I Find Examples of Using Dataverse APIs?
- When Should I Use the Native API vs. the SWORD API?
- To Operate on a Dataset Should I Use Its DOI (or Handle) or Its Database ID?
- Where is the Comprehensive List of All API Functionality?
- Is There a Changelog of API Functionality That Has Been Added Over Time?
- What Functionality is GUI Only and Not Available Via API
- Why Are the Return Values (HTTP Status Codes) Not Documented?
- What If My Question Is Not Answered Here?