Data Source

Get All Data Sources

This endpoint returns all data sources that the user has access to. The results will be paginated. If the number of data sources exceeds the pagination limit, links will be provided to get the next set of results or the previous set of results (if applicable). The range of returned values can be determined by optional start and end parameters. If the difference between the end and start values is greater than the pagination limit, the endpoint returns data sources in the range from start to start + pagination limit. Items in the response are determined based on their creation order.

get/dataSources

Request

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

Query parameters

startinteger

Starting 1-based index of data sources to retreive. Defaults to 1.

endinteger

Ending index of data sources to retreive. Defaults to 100.

Response

OK with paginated list of Data Source objects

totalinteger

Total number of data sources

prevstring

Link to get the previous set of data sources

nextstring

Link to get the next set of data sources

Example response

{
  "dataSources": [
    {
      "uri": "https://data.lucid.app/dataSources/2967",
      "name": "Internal Org Chart",
      "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",
      "linkParameters": {
        "param1": "value1",
        "param2": "value2"
      },
      "deleted": "2021-01-01T00:00:00Z"
    }
  ],
  "total": 125,
  "prev": "https://data.lucid.app/dataSources?start=80&end=90",
  "next": "https://data.lucid.app/dataSources?start=100&end=110"
}

Changes

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