Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
    Generate Logical Data Model
    LDM - Declarative APIs
    Datasets
      Get all DatasetsgetGet a DatasetgetPatch a Dataset (beta)patch
    Attributes
    Facts
    Labels
Analytical Objects
Reporting
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

Datasets (3.51)

Endpoint:/

Get all Datasets

GET
/api/v1/entities/workspaces/{workspaceId}/datasets

Get all Datasets › path Parameters

  • workspaceIdstring · required

Get all Datasets › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL
  • 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').

  • includestring[] · style: form

    Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

    WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.

    Enum values:
    attributes
    facts
    aggregatedFacts
    datasets
    workspaceDataFilters
    references
    ALL
  • 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:
    origin
    page
    all
    ALL

Get all Datasets › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get all Datasets › Responses

Request successfully processed

  • dataobject[] · unique · required
  • includedarray · unique

    Included resources

  • linksobject
  • metaobject
GET /api/v1/entities/workspaces/{workspaceId}/datasets

Get a Dataset

GET
/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}

Get a Dataset › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Get a Dataset › 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').

  • includestring[] · style: form

    Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

    WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.

    Enum values:
    attributes
    facts
    aggregatedFacts
    datasets
    workspaceDataFilters
    references
    ALL
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Get a Dataset › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get a Dataset › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of dataset entity.

  • includedarray · unique

    Included resources

  • linksobject
GET /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}

Patch a Dataset (beta)

PATCH
/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}

Patch a Dataset (beta) › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Patch a Dataset (beta) › 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').

  • includestring[] · style: form

    Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

    WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.

    Enum values:
    attributes
    facts
    aggregatedFacts
    datasets
    workspaceDataFilters
    references
    ALL

Patch a Dataset (beta) › Request Body

  • dataobject · required

    JSON:API representation of patching dataset entity.

Patch a Dataset (beta) › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of dataset entity.

  • includedarray · unique

    Included resources

  • linksobject
PATCH /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}
LDM - Declarative APIsAttributes