Organization
Users and User Groups
Permissions
Data Source
Workspaces
    Workspaces - Entity APIs
    Workspaces - Declarative APIs
    Data Filters
      Get all User Data FiltersgetPost User Data FilterspostGet a User Data FiltergetPut a User Data FilterputDelete a User Data FilterdeletePatch a User Data FilterpatchGet all Settings for Workspace Data FiltersgetPost Settings for Workspace Data FilterspostGet a Setting for Workspace Data FiltergetPut a Settings for Workspace Data FilterputDelete a Settings for Workspace Data FilterdeletePatch a Settings for Workspace Data FilterpatchGet all Workspace Data FiltersgetPost Workspace Data FilterspostGet a Workspace Data FiltergetPut a Workspace Data FilterputDelete a Workspace Data FilterdeletePatch a Workspace Data FilterpatchGet workspace data filters for all workspacesgetSet all workspace data filtersput
    Workspaces - Settings
    Appearance
    Plugins
    Hierarchy
    Translations
Logical Data Model
Analytical Objects
Reporting
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

Data Filters (3.51)

Endpoint:/

Get all User Data Filters

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

Get all User Data Filters › path Parameters

  • workspaceIdstring · required

Get all User Data 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:
    users
    userGroups
    facts
    attributes
    labels
    metrics
    datasets
    user
  • 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 User Data Filters › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get all User Data Filters › Responses

Request successfully processed

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

    Included resources

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

Post User Data Filters

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

Post User Data Filters › path Parameters

  • workspaceIdstring · required

Post User Data 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:
    users
    userGroups
    facts
    attributes
    labels
    metrics
    datasets
    user
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Post User Data Filters › Request Body

  • dataobject · required

    JSON:API representation of userDataFilter entity.

Post User Data Filters › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of userDataFilter entity.

  • includedarray · unique

    Included resources

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

Get a User Data Filter

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

Get a User Data Filter › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Get a User Data 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:
    users
    userGroups
    facts
    attributes
    labels
    metrics
    datasets
    user
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Get a User Data Filter › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get a User Data Filter › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of userDataFilter entity.

  • includedarray · unique

    Included resources

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

Put a User Data Filter

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

Put a User Data Filter › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Put a User Data 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:
    users
    userGroups
    facts
    attributes
    labels
    metrics
    datasets
    user

Put a User Data Filter › Request Body

  • dataobject · required

    JSON:API representation of userDataFilter entity.

Put a User Data Filter › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of userDataFilter entity.

  • includedarray · unique

    Included resources

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

Delete a User Data Filter

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

Delete a User Data Filter › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

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

Successfully deleted

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

Patch a User Data Filter

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

Patch a User Data Filter › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Patch a User Data 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:
    users
    userGroups
    facts
    attributes
    labels
    metrics
    datasets
    user

Patch a User Data Filter › Request Body

  • dataobject · required

    JSON:API representation of patching userDataFilter entity.

Patch a User Data Filter › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of userDataFilter entity.

  • includedarray · unique

    Included resources

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

Get all Settings for Workspace Data Filters

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

Get all Settings for Workspace Data Filters › path Parameters

  • workspaceIdstring · required

Get all Settings for Workspace Data 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:
    workspaceDataFilters
    workspaceDataFilter
    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 Settings for Workspace Data Filters › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get all Settings for Workspace Data Filters › Responses

Request successfully processed

  • dataobject[] · unique · required
  • includedobject[] · unique

    Included resources

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

Post Settings for Workspace Data Filters

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

Post Settings for Workspace Data Filters › path Parameters

  • workspaceIdstring · required

Post Settings for Workspace Data 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:
    workspaceDataFilters
    workspaceDataFilter
    ALL
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Post Settings for Workspace Data Filters › Request Body

  • dataobject · required

    JSON:API representation of workspaceDataFilterSetting entity.

Post Settings for Workspace Data Filters › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of workspaceDataFilterSetting entity.

  • includedobject[] · unique

    Included resources

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

Get a Setting for Workspace Data Filter

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

Get a Setting for Workspace Data Filter › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Get a Setting for Workspace Data 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:
    workspaceDataFilters
    workspaceDataFilter
    ALL
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Get a Setting for Workspace Data Filter › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get a Setting for Workspace Data Filter › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of workspaceDataFilterSetting entity.

  • includedobject[] · unique

    Included resources

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

Put a Settings for Workspace Data Filter

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

Put a Settings for Workspace Data Filter › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Put a Settings for Workspace Data 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:
    workspaceDataFilters
    workspaceDataFilter
    ALL

Put a Settings for Workspace Data Filter › Request Body

  • dataobject · required

    JSON:API representation of workspaceDataFilterSetting entity.

Put a Settings for Workspace Data Filter › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of workspaceDataFilterSetting entity.

  • includedobject[] · unique

    Included resources

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

Delete a Settings for Workspace Data Filter

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

Delete a Settings for Workspace Data Filter › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Delete a Settings for Workspace Data 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 Settings for Workspace Data Filter › Responses

Successfully deleted

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

Patch a Settings for Workspace Data Filter

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

Patch a Settings for Workspace Data Filter › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Patch a Settings for Workspace Data 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:
    workspaceDataFilters
    workspaceDataFilter
    ALL

Patch a Settings for Workspace Data Filter › Request Body

  • dataobject · required

    JSON:API representation of patching workspaceDataFilterSetting entity.

Patch a Settings for Workspace Data Filter › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of workspaceDataFilterSetting entity.

  • includedobject[] · unique

    Included resources

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

Get all Workspace Data Filters

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

Get all Workspace Data Filters › path Parameters

  • workspaceIdstring · required

Get all Workspace Data 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:
    workspaceDataFilterSettings
    filterSettings
    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 Workspace Data Filters › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get all Workspace Data Filters › Responses

Request successfully processed

  • dataobject[] · unique · required
  • includedobject[] · unique

    Included resources

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

Post Workspace Data Filters

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

Post Workspace Data Filters › path Parameters

  • workspaceIdstring · required

Post Workspace Data 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:
    workspaceDataFilterSettings
    filterSettings
    ALL
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Post Workspace Data Filters › Request Body

  • dataobject · required

    JSON:API representation of workspaceDataFilter entity.

Post Workspace Data Filters › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of workspaceDataFilter entity.

  • includedobject[] · unique

    Included resources

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

Get a Workspace Data Filter

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

Get a Workspace Data Filter › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Get a Workspace Data 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:
    workspaceDataFilterSettings
    filterSettings
    ALL
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Get a Workspace Data Filter › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get a Workspace Data Filter › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of workspaceDataFilter entity.

  • includedobject[] · unique

    Included resources

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

Put a Workspace Data Filter

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

Put a Workspace Data Filter › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Put a Workspace Data 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:
    workspaceDataFilterSettings
    filterSettings
    ALL

Put a Workspace Data Filter › Request Body

  • dataobject · required

    JSON:API representation of workspaceDataFilter entity.

Put a Workspace Data Filter › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of workspaceDataFilter entity.

  • includedobject[] · unique

    Included resources

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

Delete a Workspace Data Filter

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

Delete a Workspace Data Filter › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

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

Successfully deleted

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

Patch a Workspace Data Filter

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

Patch a Workspace Data Filter › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Patch a Workspace Data 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:
    workspaceDataFilterSettings
    filterSettings
    ALL

Patch a Workspace Data Filter › Request Body

  • dataobject · required

    JSON:API representation of patching workspaceDataFilter entity.

Patch a Workspace Data Filter › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of workspaceDataFilter entity.

  • includedobject[] · unique

    Included resources

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

Get workspace data filters for all workspaces

GET
/api/v1/layout/workspaceDataFilters

Retrieve all workspaces and related workspace data filters (and their settings / values).

Get workspace data filters for all workspaces › Responses

Retrieved all workspace data filters.

  • workspaceDataFiltersobject[] · required
GET /api/v1/layout/workspaceDataFilters

Set all workspace data filters

PUT
/api/v1/layout/workspaceDataFilters

Sets workspace data filters in all workspaces in entire organization.

Set all workspace data filters › Request Body

  • workspaceDataFiltersobject[] · required

Set all workspace data filters › Responses

All workspace data filters set.

No data returned
PUT /api/v1/layout/workspaceDataFilters
Workspaces - Declarative APIsWorkspaces - Settings