Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
    Analytics Model
    Metrics
    Dashboards
    Filter Context
      Get all Filter ContextgetPost Filter ContextpostSearch request for FilterContextpostGet a Filter ContextgetPut a Filter ContextputDelete a Filter ContextdeletePatch a Filter Contextpatch
    Filter Views
    Visualization Object
    Dependency Graph
    Attribute Hierarchies
Reporting
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

Filter Context

Endpoint:/

Get all Filter Context

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

Get all Filter Context › path Parameters

  • workspaceIdstring · required

Get all Filter Context › 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 Filter Context › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get all Filter Context › Responses

Request successfully processed

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

    Included resources

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

Post Filter Context

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

Post Filter Context › path Parameters

  • workspaceIdstring · required

Post Filter Context › 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 Filter Context › Request Body

  • dataobject · required

    JSON:API representation of filterContext entity.

Post Filter Context › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of filterContext entity.

  • includedarray · unique

    Included resources

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

Search request for FilterContext

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

Search request for FilterContext › path Parameters

  • workspaceIdstring · required

Search request for FilterContext › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL

Search request for FilterContext › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Search request for FilterContext › Request Body

  • filterstring | null

    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').

  • includearray | null

    List of related entities to include in the response

  • metaIncludearray | null · unique

    Set of metadata fields to include in the response

  • pageobject

    Pagination information for entity search

  • sortarray | null

    Sorting criteria (can specify multiple sort orders)

Search request for FilterContext › Responses

Request successfully processed

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

    Included resources

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

Get a Filter Context

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

Get a Filter Context › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Get a Filter Context › 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 Filter Context › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

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

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

Put a Filter Context › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Put a Filter Context › 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 Filter Context › Request Body

  • dataobject · required

    JSON:API representation of filterContext entity.

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

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

Delete a Filter Context › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

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

Successfully deleted

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

Patch a Filter Context

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

Patch a Filter Context › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Patch a Filter Context › 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 Filter Context › Request Body

  • dataobject · required

    JSON:API representation of patching filterContext entity.

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