patch

Overview

This endpoint is used for updating information about a dataset

HTTP Request

1
POST /api/v1/datasets/:datasetRefrence
Copied!

Path parameters

Parameter
datasetReference
A qualified reference to the dataset. See referencing resources for more information.
This endpoint extends the general API structure

Request body

Provide a JSON object with information about the dataset.
Property name
Type
Description
name
string
The name of the dataset. Must be unique (non-word characters ignored) within the user or organization that owns the dataset.
publicAccessLevel
string
Required. The public access level of the dataset. Must be one of:
    none - Only specific people will be able to see the existence of the dataset.
    overview - Anyone can see the existence of the dataset
    metadata - Anyone can view any variables and summary statistics on the dataset.
    sample - Anyone can view, query, and download the dataset's sample data.
    data - Anyone can view, query, and download the dataset's data.
description
string
Optional. A short description of the dataset that will show up in search results. Limited to 256 characters.

Authorization

You must either authorize as the user or an administrator of the organization that owns the dataset. Your access token must have the following scope:
    data.edit

Response body

Returns the JSON-encoded "get" representation of a dataset resource.
Last modified 1yr ago