Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
Reporting
Export & Automations
Other
    Other
      (BETA) Check Organization Metadata Inconsistenciespost(BETA) Sync organization scope Metadata to other servicespostSwitch Active Identity ProviderpostApplies all the given cancel tokens.post(BETA) Sync Metadata to other servicespost/api/v1/actions/workspaces/{workspaceId}/userGroupsget/api/v1/actions/workspaces/{workspaceId}/usersget/api/v1/entities/workspaces/{workspaceId}/aggregatedFactsgetSearch request for AggregatedFactpost/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/{objectId}getSearch request for AnalyticalDashboardpostSearch request for AttributeHierarchypostSearch request for AttributepostSearch request for AutomationResultpostSearch request for AutomationpostSearch request for CustomApplicationSettingpostSearch request for DashboardPluginpostSearch request for DatasetpostSearch request for ExportDefinitionpostSearch request for FactpostSearch request for FilterContextpostSearch request for FilterViewpost/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendationsget/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendationspost/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/searchpost/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}get/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}put/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}delete/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}patchSearch request for Labelpost/api/v1/entities/workspaces/{workspaceId}/memoryItemsget/api/v1/entities/workspaces/{workspaceId}/memoryItemspostSearch request for MemoryItempost/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}get/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}put/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}delete/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}patchSearch request for MetricpostSearch request for UserDataFilterpostSearch request for VisualizationObjectpostSearch request for WorkspaceDataFilterSettingpostSearch request for WorkspaceDataFilterpost/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/searchpostGet user data filtersgetSet user data filtersputGet collection featuresget
Schemas
powered by Zudoku
OpenAPI definition

Other (3.51)

Endpoint:/

(BETA) Check Organization Metadata Inconsistencies

POST
/api/v1/actions/organization/metadataCheck

(BETA) Temporary solution. Resyncs all organization objects and full workspaces within the organization with target GEN_AI_CHECK.

(BETA) Check Organization Metadata Inconsistencies › Responses

OK

No data returned
POST /api/v1/actions/organization/metadataCheck

(BETA) Sync organization scope Metadata to other services

POST
/api/v1/actions/organization/metadataSync

(BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only.

(BETA) Sync organization scope Metadata to other services › Responses

OK

No data returned
POST /api/v1/actions/organization/metadataSync

Switch Active Identity Provider

POST
/api/v1/actions/organization/switchActiveIdentityProvider

Switch the active identity provider for the organization. Requires MANAGE permission on the organization.

Switch Active Identity Provider › Request Body

  • idpIdstring · required

    Identity provider ID to set as active for the organization.

    Example: my-idp-123

Switch Active Identity Provider › Responses

No Content

No data returned
POST /api/v1/actions/organization/switchActiveIdentityProvider

Applies all the given cancel tokens.

POST
/api/v1/actions/workspaces/{workspaceId}/execution/afm/cancel

Each cancel token corresponds to one unique execution request for the same result id. If all cancel tokens for the same result id are applied, the execution for this result id is cancelled.

Applies all the given cancel tokens. › path Parameters

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

    Workspace identifier

Applies all the given cancel tokens. › Request Body

  • resultIdToCancelTokenPairsobject · required

    resultId to cancel token pairs

Applies all the given cancel tokens. › Responses

Status of the cancellation operation.

  • resultIdToCancelTokenPairsobject · required

    resultId to cancel token pairs

POST /api/v1/actions/workspaces/{workspaceId}/execution/afm/cancel

(BETA) Sync Metadata to other services

POST
/api/v1/actions/workspaces/{workspaceId}/metadataSync

(BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only.

(BETA) Sync Metadata to other services › path Parameters

  • workspaceIdstring · required

(BETA) Sync Metadata to other services › Responses

OK

No data returned
POST /api/v1/actions/workspaces/{workspaceId}/metadataSync

GET
/api/v1/actions/workspaces/{workspaceId}/userGroups

path Parameters

  • workspaceIdstring · required

query Parameters

  • pageinteger · int32 · style: form

    Zero-based page index (0..N)

    Default: 0
  • sizeinteger · int32 · style: form

    The size of the page to be returned.

    Default: 20
  • namestring · style: form

    Filter by user name. Note that user name is case insensitive.

Responses

OK

  • totalCountinteger · int32 · required

    Total number of groups

  • userGroupsobject[] · required
GET /api/v1/actions/workspaces/{workspaceId}/userGroups

GET
/api/v1/actions/workspaces/{workspaceId}/users

path Parameters

  • workspaceIdstring · required

query Parameters

  • pageinteger · int32 · style: form

    Zero-based page index (0..N)

    Default: 0
  • sizeinteger · int32 · style: form

    The size of the page to be returned.

    Default: 20
  • namestring · style: form

    Filter by user name. Note that user name is case insensitive.

Responses

OK

  • totalCountinteger · int32 · required

    The total number of users is based on applied filters.

  • usersobject[] · required
GET /api/v1/actions/workspaces/{workspaceId}/users

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

path Parameters

  • workspaceIdstring · required

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:
    datasets
    facts
    dataset
    sourceFact
    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

Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Responses

Request successfully processed

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

    Included resources

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

Search request for AggregatedFact

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

Search request for AggregatedFact › path Parameters

  • workspaceIdstring · required

Search request for AggregatedFact › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL

Search request for AggregatedFact › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

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

Request successfully processed

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

    Included resources

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

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

path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

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

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of aggregatedFact entity.

  • includedarray · unique

    Included resources

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

Search request for AnalyticalDashboard

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

Search request for AnalyticalDashboard › path Parameters

  • workspaceIdstring · required

Search request for AnalyticalDashboard › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL

Search request for AnalyticalDashboard › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

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

Request successfully processed

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

    Included resources

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

Search request for AttributeHierarchy

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

Search request for AttributeHierarchy › path Parameters

  • workspaceIdstring · required

Search request for AttributeHierarchy › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL

Search request for AttributeHierarchy › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

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

Request successfully processed

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

    Included resources

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

Search request for Attribute

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

Search request for Attribute › path Parameters

  • workspaceIdstring · required

Search request for Attribute › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL

Search request for Attribute › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

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

Request successfully processed

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

    Included resources

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

Search request for AutomationResult

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

Search request for AutomationResult › path Parameters

  • workspaceIdstring · required

Search request for AutomationResult › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL

Search request for AutomationResult › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

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

Request successfully processed

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

    Included resources

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

Search request for Automation

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

Search request for Automation › path Parameters

  • workspaceIdstring · required

Search request for Automation › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL

Search request for Automation › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

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

Request successfully processed

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

    Included resources

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

Search request for CustomApplicationSetting

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

Search request for CustomApplicationSetting › path Parameters

  • workspaceIdstring · required

Search request for CustomApplicationSetting › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL

Search request for CustomApplicationSetting › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

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

Request successfully processed

  • dataobject[] · unique · required
  • linksobject
  • metaobject
POST /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search

Search request for DashboardPlugin

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

Search request for DashboardPlugin › path Parameters

  • workspaceIdstring · required

Search request for DashboardPlugin › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL

Search request for DashboardPlugin › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

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

Request successfully processed

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

    Included resources

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

Search request for Dataset

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

Search request for Dataset › path Parameters

  • workspaceIdstring · required

Search request for Dataset › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL

Search request for Dataset › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

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

Request successfully processed

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

    Included resources

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

Search request for ExportDefinition

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

Search request for ExportDefinition › path Parameters

  • workspaceIdstring · required

Search request for ExportDefinition › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL

Search request for ExportDefinition › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

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

Request successfully processed

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

    Included resources

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

Search request for Fact

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

Search request for Fact › path Parameters

  • workspaceIdstring · required

Search request for Fact › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL

Search request for Fact › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

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

Request successfully processed

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

    Included resources

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

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

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
/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations

path Parameters

  • workspaceIdstring · required

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:
    metrics
    analyticalDashboards
    metric
    analyticalDashboard
    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

Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Responses

Request successfully processed

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

    Included resources

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

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

path Parameters

  • workspaceIdstring · required

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:
    metrics
    analyticalDashboards
    metric
    analyticalDashboard
    ALL
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Request Body

  • dataobject · required

    JSON:API representation of knowledgeRecommendation entity.

Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of knowledgeRecommendation entity.

  • includedarray · unique

    Included resources

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

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

path Parameters

  • workspaceIdstring · required

query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL

Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

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)

Responses

Request successfully processed

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

    Included resources

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

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

path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

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:
    metrics
    analyticalDashboards
    metric
    analyticalDashboard
    ALL
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of knowledgeRecommendation entity.

  • includedarray · unique

    Included resources

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

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

path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

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:
    metrics
    analyticalDashboards
    metric
    analyticalDashboard
    ALL

Request Body

  • dataobject · required

    JSON:API representation of knowledgeRecommendation entity.

Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of knowledgeRecommendation entity.

  • includedarray · unique

    Included resources

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

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

path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

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

Responses

Successfully deleted

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

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

path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

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:
    metrics
    analyticalDashboards
    metric
    analyticalDashboard
    ALL

Request Body

  • dataobject · required

    JSON:API representation of patching knowledgeRecommendation entity.

Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of knowledgeRecommendation entity.

  • includedarray · unique

    Included resources

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

Search request for Label

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

Search request for Label › path Parameters

  • workspaceIdstring · required

Search request for Label › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL

Search request for Label › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

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

Request successfully processed

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

    Included resources

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

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

path Parameters

  • workspaceIdstring · required

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:
    userIdentifiers
    createdBy
    modifiedBy
    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

Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Responses

Request successfully processed

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

    Included resources

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

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

path Parameters

  • workspaceIdstring · required

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:
    userIdentifiers
    createdBy
    modifiedBy
    ALL
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Request Body

  • dataobject · required

    JSON:API representation of memoryItem entity.

Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of memoryItem entity.

  • includedobject[] · unique

    Included resources

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

Search request for MemoryItem

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

Search request for MemoryItem › path Parameters

  • workspaceIdstring · required

Search request for MemoryItem › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL

Search request for MemoryItem › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

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

Request successfully processed

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

    Included resources

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

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

path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

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:
    userIdentifiers
    createdBy
    modifiedBy
    ALL
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of memoryItem entity.

  • includedobject[] · unique

    Included resources

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

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

path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

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:
    userIdentifiers
    createdBy
    modifiedBy
    ALL

Request Body

  • dataobject · required

    JSON:API representation of memoryItem entity.

Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of memoryItem entity.

  • includedobject[] · unique

    Included resources

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

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

path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

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

Responses

Successfully deleted

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

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

path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

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:
    userIdentifiers
    createdBy
    modifiedBy
    ALL

Request Body

  • dataobject · required

    JSON:API representation of patching memoryItem entity.

Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of memoryItem entity.

  • includedobject[] · unique

    Included resources

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

Search request for Metric

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

Search request for Metric › path Parameters

  • workspaceIdstring · required

Search request for Metric › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL

Search request for Metric › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

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

Request successfully processed

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

    Included resources

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

Search request for UserDataFilter

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

Search request for UserDataFilter › path Parameters

  • workspaceIdstring · required

Search request for UserDataFilter › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL

Search request for UserDataFilter › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

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

Request successfully processed

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

    Included resources

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

Search request for VisualizationObject

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

Search request for VisualizationObject › path Parameters

  • workspaceIdstring · required

Search request for VisualizationObject › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL

Search request for VisualizationObject › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

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

Request successfully processed

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

    Included resources

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

Search request for WorkspaceDataFilterSetting

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

Search request for WorkspaceDataFilterSetting › path Parameters

  • workspaceIdstring · required

Search request for WorkspaceDataFilterSetting › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL

Search request for WorkspaceDataFilterSetting › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

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

Request successfully processed

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

    Included resources

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

Search request for WorkspaceDataFilter

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

Search request for WorkspaceDataFilter › path Parameters

  • workspaceIdstring · required

Search request for WorkspaceDataFilter › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL

Search request for WorkspaceDataFilter › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

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

Request successfully processed

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

    Included resources

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

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

path Parameters

  • workspaceIdstring · required

query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL

Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

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)

Responses

Request successfully processed

  • dataobject[] · unique · required
  • linksobject
  • metaobject
POST /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search

Get user data filters

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

Retrieve current user data filters assigned to the workspace.

Get user data filters › path Parameters

  • workspaceIdstring · required

Get user data filters › Responses

Retrieved current user data filters.

  • userDataFiltersobject[] · required
GET /api/v1/layout/workspaces/{workspaceId}/userDataFilters

Set user data filters

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

Set user data filters assigned to the workspace.

Set user data filters › path Parameters

  • workspaceIdstring · required

Set user data filters › Request Body

  • userDataFiltersobject[] · required

Set user data filters › Responses

User data filters successfully set.

No data returned
PUT /api/v1/layout/workspaces/{workspaceId}/userDataFilters

Get collection features

GET
/api/v1/location/collections/{collectionId}/items

Retrieve features from a GeoCollections collection as GeoJSON

Get collection features › path Parameters

  • collectionIdstring · required

    Collection identifier

Get collection features › query Parameters

  • limitinteger · min: 1 · max: 100

    Maximum number of features to return

  • bboxstring

    Bounding box filter (minx,miny,maxx,maxy)

  • valuesstring[]

    List of values to filter features by

Get collection features › Responses

Features retrieved successfully

  • featuresobject[] · required
  • typestring · required
  • bboxnumber[]
GET /api/v1/location/collections/{collectionId}/items
Export templates