{
  "opencollection": "1.0.0",
  "info": {
    "name": "Dataverse Access dataSet API",
    "version": "6.9"
  },
  "items": [
    {
      "info": {
        "name": "dataSet",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Lists all data sets",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets",
            "params": [
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Number of returned data sets per request."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The offset for the returned list. 0 or null value is from the start"
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "The order of the list, must be a value from /data sets/orderings"
              }
            ]
          },
          "docs": "Lists all data sets in the Pure instance. If you need to filter the data sets returned, see the POST version which supports additional filtering."
        },
        {
          "info": {
            "name": "Create data set",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://dataverse.nl/data-sets",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create data set"
        },
        {
          "info": {
            "name": "A list of allowed classified identifier types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets/allowed-classified-identifier-types"
          },
          "docs": "Get a list of allowed classified identifier types that can be used for the 'identifiers.type' attribute of data sets"
        },
        {
          "info": {
            "name": "A list of allowed contributors roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets/allowed-contributors-roles"
          },
          "docs": "Get a list of allowed contributors roles that can be used for the 'contributor.role' attribute of the data set."
        },
        {
          "info": {
            "name": "Get allowed classifications for the custom-defined field associated with the data set",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets/allowed-custom-defined-field-values/:propertyName/classifications",
            "params": [
              {
                "name": "propertyName",
                "value": "",
                "type": "path",
                "description": "PropertyName for the desired custom-defined field"
              }
            ]
          },
          "docs": "Get allowed classifications for the custom-defined field associated with the data set."
        },
        {
          "info": {
            "name": "A list of allowed classifications for the descriptions property",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets/allowed-description-types"
          },
          "docs": "Get a list of classifications that can be used when submitting a description."
        },
        {
          "info": {
            "name": "A list of allowed document licenses",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets/allowed-document-licenses"
          },
          "docs": "Get a list of allowed license types that can be used for the 'documents.license' attribute of data sets"
        },
        {
          "info": {
            "name": "A list of allowed document types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets/allowed-document-types"
          },
          "docs": "Get a list of allowed license types that can be used for the 'documents.type' attribute of data sets"
        },
        {
          "info": {
            "name": "A list of allowed access types for DOI",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets/allowed-doi-access-types"
          },
          "docs": "Get a list of allowed DOI access types on data sets"
        },
        {
          "info": {
            "name": "A list of allowed license types for DOI",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets/allowed-doi-license-types"
          },
          "docs": "Get a list of allowed DOI license types on data sets"
        },
        {
          "info": {
            "name": "A list of allowed image types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets/allowed-image-types"
          },
          "docs": "Get a list of allowed image types that can be used for the 'images.type' attribute of the data set."
        },
        {
          "info": {
            "name": "A list of keyword group configurations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets/allowed-keyword-group-configurations"
          },
          "docs": "Get a list of allowed keyword group configurations that can be used when submitting keyword groups."
        },
        {
          "info": {
            "name": "A list of allowed classifications for the specified keyword group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets/allowed-keyword-group-configurations/:id/classifications",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Pure id of the keyword group configuration"
              }
            ]
          },
          "docs": "Get a list of allowed classifications that can be used when submitting a specified keyword group."
        },
        {
          "info": {
            "name": "A list of allowed legal condition types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets/allowed-legal-condition-types"
          },
          "docs": "Get a list of allowed types for legal condition on data sets"
        },
        {
          "info": {
            "name": "A list of allowed licenses",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets/allowed-licenses"
          },
          "docs": "Get a list of allowed licenses on data sets"
        },
        {
          "info": {
            "name": "A list of allowed link types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets/allowed-link-types"
          },
          "docs": "Get a list of allowed link types that can be used for the 'links.linkType' attribute of data sets"
        },
        {
          "info": {
            "name": "A list of allowed locales in localized strings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets/allowed-locales"
          },
          "docs": "Get a list of allowed locales that can be used when submitting localized string entities."
        },
        {
          "info": {
            "name": "A list of allowed nature types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets/allowed-nature-types"
          },
          "docs": "Get a list of allowed nature types for data sets."
        },
        {
          "info": {
            "name": "A list of allowed open access permissions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets/allowed-open-access-permissions"
          },
          "docs": "Get a list of allowed open access permissions on data sets"
        },
        {
          "info": {
            "name": "A list of allowed person roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets/allowed-persons-roles"
          },
          "docs": "Get a list of allowed person roles that can be used for the 'persons.role' attribute of the data set."
        },
        {
          "info": {
            "name": "A list of allowed physical data types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets/allowed-physical-data-types"
          },
          "docs": "Get a list of allowed types for physical data on data sets"
        },
        {
          "info": {
            "name": "A list of allowed classifications for the type property",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets/allowed-types"
          },
          "docs": "Get a list of classifications that can be used when submitting a type."
        },
        {
          "info": {
            "name": "A list of allowed workflow steps",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets/allowed-workflow-steps"
          },
          "docs": "Get a list of allowed workflow steps that can be used for the 'workflow' attribute of data sets"
        },
        {
          "info": {
            "name": "Upload file to a specific data set",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://dataverse.nl/data-sets/file-uploads",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ]
          },
          "docs": "Uploads file for the data set"
        },
        {
          "info": {
            "name": "Query operation for data sets",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://dataverse.nl/data-sets/search",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Lists data sets in the Pure instance that matches the provided query, similar to the GET version, instead of using parameters to alter the response, an JSON document is posted with the request. The JSON document contains fields for all the parameters available for the GET version, but also additional filtering options."
        },
        {
          "info": {
            "name": "Get data set",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the desired data set"
              }
            ]
          },
          "docs": "Get data set with specific UUID."
        },
        {
          "info": {
            "name": "Update data set",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://dataverse.nl/data-sets/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the data set to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update data set with specific UUID."
        },
        {
          "info": {
            "name": "Delete data set",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://dataverse.nl/data-sets/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the data set"
              }
            ]
          },
          "docs": "Delete data set with specific UUID."
        },
        {
          "info": {
            "name": "Lock the content",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://dataverse.nl/data-sets/:uuid/actions/lock",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the content to lock"
              }
            ]
          },
          "docs": "Mark the content as external (used when content contains synchronised data). This has no effect on interactions with the content through the API."
        },
        {
          "info": {
            "name": "Unlock the content",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://dataverse.nl/data-sets/:uuid/actions/unlock",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the content to unlock"
              }
            ]
          },
          "docs": "Remove the external mark on the content (used when content contains synchronised data). This has no effect on interactions with the content through the API."
        },
        {
          "info": {
            "name": "Lists all dependents to a  data set",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets/:uuid/dependents",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the  data set"
              },
              {
                "name": "verbose",
                "value": "",
                "type": "query",
                "description": "DEPRECATED - Parameter has no effect."
              }
            ]
          },
          "docs": "Lists all dependents to a data set with the specified UUID. If the user does not have access to view all the dependent content, an authorization error will be thrown. "
        },
        {
          "info": {
            "name": "Get file from the data set",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets/:uuid/files/:fileId",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the data set"
              },
              {
                "name": "fileId",
                "value": "",
                "type": "path",
                "description": "File id "
              }
            ]
          },
          "docs": "Get file from the data set"
        },
        {
          "info": {
            "name": "Lists notes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/data-sets/:uuid/notes",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the data set to get notes for"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Number of returned notes per request"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The offset for the returned list. 0 or null value is from the start"
              }
            ]
          },
          "docs": "Lists notes associated with an data set ordered by date (nulls last)"
        },
        {
          "info": {
            "name": "Create note",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://dataverse.nl/data-sets/:uuid/notes",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the data set to add note to"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create note and associate it with a data set"
        }
      ]
    }
  ],
  "bundled": true
}