LUlucid
Data Source

Update Data Source

This endpoint takes a JSON object and uses it to update the data source's name and/or adapter type. The JSON object of the updated data source is returned. Updates will only occur if the user has access to the data source.

patch/dataSources/{dataSourceId}

Request

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

Path parameters

dataSourceIdinteger required

ID of data source to update

Request body

namestring

New name for the data source being updated

adapterTypestring

New adapter type for the data source being update. Valid values are CSV, DATA_API, and UNKNOWN

Example request

{
  "name": "Updated Data Source name",
  "adapterType": "CSV"
}

Response

OK with Data Source

uristring required

URI of the data source

namestring required

Name of the data source

adapterTypestring required

Type of adapter used to create the data source. Valid values are CSV, DATA_API, and UNKNOWN

collectionsstring required

Link to get collections for the data source

createdstring required

Date the data source was created

lastModifiedstring required

Date the data source was last modified

pendingboolean required

If a data source is marked pending it won't be availble for users to select within Lucid

dataSetstring required

Link to get the data set for the data source

linkParametersobject

Link parameters for the data source

deletedstring

Date the data source was deleted

Example response

{
  "uri": "https://data.lucid.app/dataSources/2967",
  "name": "Updated Data Source name",
  "adapterType": "CSV",
  "collections": "https://data.lucid.app/collections?dataSource=https://data.lucid.app/dataSources/2967",
  "created": "2021-01-01T00:00:00Z",
  "lastModified": "2021-01-01T00:00:00Z",
  "pending": false,
  "dataSet": "https://data.lucid.app/dataSets/2168"
}

Changes

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