Data Source - Entity APIs

Get Data Source entities

Data Source - represents data source for the workspace

get/api/v1/entities/dataSources

Request

  • Base URL
    https://www.gooddata.ai
  • Auth
    none declared

Query parameters

filterstring

Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

pageinteger

Zero-based page index (0..N)

sizeinteger

The size of the page to be returned

sortstring[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

metaIncludestring[]

Included meta objects

Include Meta objects.

Response

Request successfully processed

Example response

{
  "data": [
    {
      "attributes": {
        "alternativeDataSourceId": "pg_local_docker-demo2",
        "cacheRetention": {
          "schedule": {
            "cron": "0 0 5 * * *",
            "timezone": "Europe/Prague"
          }
        }
      },
      "id": "id1",
      "type": "dataSource"
    }
  ]
}

Changes

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