Dataverse

Dataverse is a collection of datasets and/or sub-dataverses.

---
title: Handle a dataset
---
classDiagram
  DataverseClient *-- DataverseHandler
  click DataverseClient href "../index.html" "Open the page"

  class DataverseHandler {
    %% Assign a New Role on a Dataverse Collection.
    %% See https://guides.dataverse.org/en/6.0/api/native-api.html#assign-a-new-role-on-a-dataverse-collection
    %% POST /api/dataverses/{DATAVERSE_ID}/assignments
    +Result~String, String~ assignRole(Integer dataverseId, Assignment assignment)

    %% Create a Dataverse Collection.
    %% See https://guides.dataverse.org/en/6.0/api/native-api.html#create-a-dataverse-collection
    %% POST /api/dataverses/{PARENT}
    +Result~WsDataverse, String~ create(String json)

    %% Delete Role Assignment from a Dataverse Collection.
    %% See https://guides.dataverse.org/en/6.0/api/native-api.html#delete-role-assignment-from-a-dataverse-collection
    %% DELETE /api/dataverses/{DATAVERSE_ID}/assignments/$ASSIGNMENT_ID
    +Result~String, String~ deleteAssignment(Integer dataverseId, Integer assignmentId)

    %% View a Dataverse Collection.
    %% See https://guides.dataverse.org/en/6.0/api/native-api.html#view-a-dataverse-collection
    %% GET /api/dataverses/{DATAVERSE}
    +Result~WsDataverse, String~ get(String dataverse)

    %% List Role Assignments in a Dataverse Collection.
    %% See https://guides.dataverse.org/en/6.0/api/native-api.html#list-role-assignments-in-a-dataverse-collection
    %% GET /api/dataverses/{DATAVERSE}/assignments
    +Result~List~Assignment~,String~ listAssignments(String id)

    %% Publish a Dataverse Collection.
    %% See https://guides.dataverse.org/en/6.0/api/native-api.html#publish-a-dataverse-collection
    %% POST /api/dataverses/{DATAVERSE}/actions/:publish
    %% id : alias or id of dataverse
    +Result~String, String~ publish(String id)

    %% Validate Dataset JSON File for a Collection
    %% See https://guides.dataverse.org/en/latest/api/native-api.html#validate-dataset-json-file-for-a-collection
    %% POST /api/dataverses/{DATAVERSE}/validateDatasetJson
    %% json : JSON string of dataset
    +Result~String, String~ validateDatasetJson(String json)
  }