patch

Overview

This endpoint is used for updating information about a dataset's tables.

HTTP Request

PATCH /api/v1/tables/:tableReference

Path parameters

Parameter

tableReference

A qualified reference to the table. See referencing resources for more information.

This endpoint extends the general API structure

Request body

Provide a JSON object with information about the table.

Property name

Type

Description

name

string

The name of the table. Must be unique (non-word characters ignored) within the version of the dataset.

uploadMergeStrategy

string

How to handle subsequent uploads after the first version. Defaults to "replace". Must be one of:

  • append - Uploads in future versions will append to the previous version of the table.

  • replace - Uploads in future versions will replace all data from the previous version of the table.

Important: the uploadMergeStrategy may only be modified on tables corresponding to an unreleased version of a dataset.

description

string

A description of the table, limited to 5000 characters.

Authorization

Edit access to the corresponding dataset is required. Your access token must have the following scope:

  • data.edit

Learn more about authorization.

Response body

Returns the JSON-encoded "get" representation of a table resource.

Last updated