LUlucid
Data Set

Create Data Set

Creates a new data set and a corresponding new data set grant for the user. Note that a data set cannot be created with data sources already inside it, so data sources must be added to a data set through either the Create Data Source endpoint or the Update Data Source endpoint.

post/dataSets

Request

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

Request body

namestring required

Name to give the new data set

propertiesobject

Used to create the data set properties for the new data set.

Example request

{
  "name": "Data Set Name",
  "properties": {
    "Color": "green",
    "AuthoredBy": "Lucidchart"
  }
}

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.