Organization
Users and User Groups
Permissions
Data Source
    Data Source - Declarative APIs
    Data Source - Entity APIs
      Get all Data Source IdentifiersgetGet Data Source IdentifiergetGet Data Source entitiesgetPost Data SourcespostGet Data Source entitygetPut Data Source entityputDelete Data Source entitydeletePatch Data Source entitypatch
    Test Connection
    Invalidate Cache
    Manage Permissions
    Available Drivers
    Scanning
    Data source files import
    Data source files analysis
    Data source staging location
    Data source files listing
    Data source files deletion
    Data source files manifest read
Workspaces
Logical Data Model
Analytical Objects
Reporting
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

Data Source - Entity APIs (3.51)

Endpoint:/

Get all Data Source Identifiers

GET
/api/v1/entities/dataSourceIdentifiers

Get all Data Source Identifiers › 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)

    Default: 0
  • sizeinteger

    The size of the page to be returned

    Default: 20
  • sortstring[]

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

  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    permissions
    page
    all
    ALL

Get all Data Source Identifiers › Responses

Request successfully processed

  • dataobject[] · unique · required
  • linksobject
  • metaobject
GET /api/v1/entities/dataSourceIdentifiers

Get Data Source Identifier

GET
/api/v1/entities/dataSourceIdentifiers/{id}

Get Data Source Identifier › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Get Data Source Identifier › 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').

  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    permissions
    all
    ALL

Get Data Source Identifier › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of dataSourceIdentifier entity.

  • linksobject
GET /api/v1/entities/dataSourceIdentifiers/{id}

Get Data Source entities

GET
/api/v1/entities/dataSources

Data Source - represents data source for the workspace

Get Data Source entities › 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)

    Default: 0
  • sizeinteger

    The size of the page to be returned

    Default: 20
  • sortstring[]

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

  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    permissions
    page
    all
    ALL

Get Data Source entities › Responses

Request successfully processed

  • dataobject[] · unique · required
  • linksobject
  • metaobject
GET /api/v1/entities/dataSources

Post Data Sources

POST
/api/v1/entities/dataSources

Data Source - represents data source for the workspace

Post Data Sources › query Parameters

  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    permissions
    all
    ALL

Post Data Sources › Request Body

  • dataobject · required

    JSON:API representation of dataSource entity.

Post Data Sources › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of dataSource entity.

  • linksobject
POST /api/v1/entities/dataSources

Get Data Source entity

GET
/api/v1/entities/dataSources/{id}

Data Source - represents data source for the workspace

Get Data Source entity › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Get Data Source entity › 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').

  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    permissions
    all
    ALL

Get Data Source entity › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of dataSource entity.

  • linksobject
GET /api/v1/entities/dataSources/{id}

Put Data Source entity

PUT
/api/v1/entities/dataSources/{id}

Data Source - represents data source for the workspace

Put Data Source entity › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Put Data Source entity › 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').

Put Data Source entity › Request Body

  • dataobject · required

    JSON:API representation of dataSource entity.

Put Data Source entity › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of dataSource entity.

  • linksobject
PUT /api/v1/entities/dataSources/{id}

Delete Data Source entity

DELETE
/api/v1/entities/dataSources/{id}

Data Source - represents data source for the workspace

Delete Data Source entity › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Delete Data Source entity › 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').

Delete Data Source entity › Responses

Successfully deleted

No data returned
DELETE /api/v1/entities/dataSources/{id}

Patch Data Source entity

PATCH
/api/v1/entities/dataSources/{id}

Data Source - represents data source for the workspace

Patch Data Source entity › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Patch Data Source entity › 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').

Patch Data Source entity › Request Body

  • dataobject · required

    JSON:API representation of patching dataSource entity.

Patch Data Source entity › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of dataSource entity.

  • linksobject
PATCH /api/v1/entities/dataSources/{id}
Data Source - Declarative APIsTest Connection