Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
    Analytics Model
    Metrics
    Dashboards
    Filter Context
    Filter Views
      Get all Filter viewsgetPost Filter viewspostSearch request for FilterViewpostGet Filter viewgetPut Filter viewsputDelete Filter viewdeletePatch Filter viewpatchGet filter viewsgetSet filter viewsput
    Visualization Object
    Dependency Graph
    Attribute Hierarchies
Reporting
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

Filter Views

Endpoint:/

Get all Filter views

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

Get all Filter views › path Parameters

  • workspaceIdstring · required

Get all Filter views › 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:
    analyticalDashboards
    users
    analyticalDashboard
    user
    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:
    page
    all
    ALL

Get all Filter views › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get all Filter views › Responses

Request successfully processed

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

    Included resources

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

Post Filter views

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

Post Filter views › path Parameters

  • workspaceIdstring · required

Post Filter views › 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:
    analyticalDashboards
    users
    analyticalDashboard
    user
    ALL

Post Filter views › Request Body

  • dataobject · required

    JSON:API representation of filterView entity.

Post Filter views › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of filterView entity.

  • includedarray · unique

    Included resources

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

Search request for FilterView

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

Search request for FilterView › path Parameters

  • workspaceIdstring · required

Search request for FilterView › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL

Search request for FilterView › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Search request for FilterView › 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 FilterView › Responses

Request successfully processed

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

    Included resources

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

Get Filter view

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

Get Filter view › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Get Filter view › 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:
    analyticalDashboards
    users
    analyticalDashboard
    user
    ALL

Get Filter view › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get Filter view › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of filterView entity.

  • includedarray · unique

    Included resources

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

Put Filter views

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

Put Filter views › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Put Filter views › 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:
    analyticalDashboards
    users
    analyticalDashboard
    user
    ALL

Put Filter views › Request Body

  • dataobject · required

    JSON:API representation of filterView entity.

Put Filter views › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of filterView entity.

  • includedarray · unique

    Included resources

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

Delete Filter view

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

Delete Filter view › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

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

Successfully deleted

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

Patch Filter view

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

Patch Filter view › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Patch Filter view › 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:
    analyticalDashboards
    users
    analyticalDashboard
    user
    ALL

Patch Filter view › Request Body

  • dataobject · required

    JSON:API representation of patching filterView entity.

Patch Filter view › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of filterView entity.

  • includedarray · unique

    Included resources

  • linksobject
PATCH /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}

Get filter views

GET
/api/v1/layout/workspaces/{workspaceId}/filterViews

Retrieve filter views for the specific workspace

Get filter views › path Parameters

  • workspaceIdstring · required

Get filter views › query Parameters

  • excludestring[]
    Enum values:
    ACTIVITY_INFO

Get filter views › Responses

Retrieved filterViews.

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

    FilterView object ID.

    Example: filterView-1
  • titlestring · maxLength: 255 · required
  • analyticalDashboardobject

    An analytical dashboard identifier.

  • contentobject | null · maxLength: 15000

    Free-form JSON object

    Example: {}
  • descriptionstring · maxLength: 255
  • isDefaultboolean

    Indicator whether the filter view should by applied by default.

  • tagsstring[] · unique
  • userobject

    A user identifier.

    Example: {"id":"example123","type":"user"}
GET /api/v1/layout/workspaces/{workspaceId}/filterViews

Set filter views

PUT
/api/v1/layout/workspaces/{workspaceId}/filterViews

Set filter views for the specific workspace.

Set filter views › path Parameters

  • workspaceIdstring · required

Set filter views › Request Body

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

    FilterView object ID.

    Example: filterView-1
  • titlestring · maxLength: 255 · required
  • analyticalDashboardobject

    An analytical dashboard identifier.

  • contentobject | null · maxLength: 15000

    Free-form JSON object

    Example: {}
  • descriptionstring · maxLength: 255
  • isDefaultboolean

    Indicator whether the filter view should by applied by default.

  • tagsstring[] · unique
  • userobject

    A user identifier.

    Example: {"id":"example123","type":"user"}

Set filter views › Responses

FilterViews successfully set.

No data returned
PUT /api/v1/layout/workspaces/{workspaceId}/filterViews
Filter ContextVisualization Object