Data Set

Update Data Set Name

This endpoint takes the payload specified below and updates the data set name. Updates will only occur if the user has access to the data set. Note that the other fields in a dataset cannot be updated through this endpoint.

patch/dataSets/{dataSetId}

Request

  • Base URL
    https://data.lucid.app
  • URL
    https://data.lucid.app/dataSets/{dataSetId}
  • Auth
    OAuth 2
    Authorization code: https://lucid.app/oauth2/authorize
    Token URL: https://api.lucid.co/oauth2/token scopes: data-service.admin

Path parameters

dataSetIdinteger required

ID of data set to update

Request body

namestring required

Name to give the existing data set

Example request

{
  "name": "New Data Set Name"
}

Response

OK with Data Set

uristring required

URI of the data set

namestring required

Name of the data set

propertiesstring required

Link to get properties of the data set

createdstring required

Date the data set was created

modifiedstring required

Date the data set was last modified

creatorIdinteger required

ID of the user who created the data set

dataSetGrantsstring required

Link to get grants for the data set

dataSourcesstring required

Link to get data sources for the data set

Example response

{
  "uri": "https://data.lucid.app/dataSets/2168",
  "name": "Data Set Name",
  "properties": "https://data.lucid.app/dataSets/2168/properties",
  "created": "2021-01-01",
  "modified": "2021-01-01T00:00:00Z",
  "creatorId": 123456,
  "dataSetGrants": "https://data.lucid.app/dataSetGrants?dataSet=https%3A%2F%2Fdata.lucid.app%2FdataSets%2F2168",
  "dataSources": "https://data.lucid.app/dataSources?dataSet=https%3A%2F%2Fdata.lucid.app%2FdataSets%2F2168"
}

Changes

No recorded changes to this operation across all 1 revision of this API.