Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
    Analytics Model
    Metrics
    Dashboards
    Context Filters
      Get all Context FiltersgetPost Context FilterspostGet a Context FiltergetPut a Context FilterputDelete a Context FilterdeletePatch a Context Filterpatch
    Filter Views
    Visualization Object
    Dependency Graph
    Attribute Hierarchies
Reporting
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

Context Filters (3.51)

Endpoint:/

Get all Context Filters

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

Get all Context Filters › path Parameters

  • workspaceIdstring · required

Get all Context Filters › 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
    datasets
    labels
    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 Context Filters › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get all Context Filters › Responses

Request successfully processed

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

    Included resources

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

Post Context Filters

POST
/api/v1/entities/workspaces/{workspaceId}/filterContexts

Post Context Filters › path Parameters

  • workspaceIdstring · required

Post Context Filters › query Parameters

  • 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
    datasets
    labels
    ALL
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Post Context Filters › Request Body

  • dataobject · required

    JSON:API representation of filterContext entity.

Post Context Filters › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of filterContext entity.

  • includedarray · unique

    Included resources

  • linksobject
POST /api/v1/entities/workspaces/{workspaceId}/filterContexts

Get a Context Filter

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

Get a Context Filter › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Get a Context Filter › 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
    datasets
    labels
    ALL
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Get a Context Filter › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get a Context Filter › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of filterContext entity.

  • includedarray · unique

    Included resources

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

Put a Context Filter

PUT
/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}

Put a Context Filter › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Put a Context Filter › 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
    datasets
    labels
    ALL

Put a Context Filter › Request Body

  • dataobject · required

    JSON:API representation of filterContext entity.

Put a Context Filter › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of filterContext entity.

  • includedarray · unique

    Included resources

  • linksobject
PUT /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}

Delete a Context Filter

DELETE
/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}

Delete a Context Filter › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Delete a Context Filter › 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 a Context Filter › Responses

Successfully deleted

No data returned
DELETE /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}

Patch a Context Filter

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

Patch a Context Filter › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Patch a Context Filter › 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
    datasets
    labels
    ALL

Patch a Context Filter › Request Body

  • dataobject · required

    JSON:API representation of patching filterContext entity.

Patch a Context Filter › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of filterContext entity.

  • includedarray · unique

    Included resources

  • linksobject
PATCH /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}
DashboardsFilter Views