Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
Reporting
Export & Automations
AI Lake
AI Assistant
    Conversations
    Dashboard Summary
    Knowledge
    Knowledge Recommendations
      Get all Knowledge RecommendationsgetPost Knowledge RecommendationspostThe search endpoint (beta)postGet a Knowledge RecommendationgetPut a Knowledge RecommendationputDelete a Knowledge RecommendationdeletePatch a Knowledge Recommendationpatch
    Memory Items
    LLM Providers
    Observability
Agents
Other
Schemas
powered by Zudoku
OpenAPI definition

Knowledge Recommendations

Endpoint:/

Get all Knowledge Recommendations

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

Get all Knowledge Recommendations › path Parameters

  • workspaceIdstring · required

Get all Knowledge Recommendations › 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

Get all Knowledge Recommendations › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get all Knowledge Recommendations › Responses

Request successfully processed

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

    Included resources

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

Post Knowledge Recommendations

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

Post Knowledge Recommendations › path Parameters

  • workspaceIdstring · required

Post Knowledge Recommendations › 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

Post Knowledge Recommendations › Request Body

  • dataobject · required

    JSON:API representation of knowledgeRecommendation entity.

Post Knowledge Recommendations › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of knowledgeRecommendation entity.

  • includedarray · unique

    Included resources

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

The search endpoint (beta)

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

The search endpoint (beta) › path Parameters

  • workspaceIdstring · required

The search endpoint (beta) › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL

The search endpoint (beta) › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

The search endpoint (beta) › 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)

The search endpoint (beta) › Responses

Request successfully processed

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

    Included resources

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

Get a Knowledge Recommendation

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

Get a Knowledge Recommendation › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Get a Knowledge Recommendation › 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

Get a Knowledge Recommendation › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get a Knowledge Recommendation › 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 a Knowledge Recommendation

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

Put a Knowledge Recommendation › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Put a Knowledge Recommendation › 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

Put a Knowledge Recommendation › Request Body

  • dataobject · required

    JSON:API representation of knowledgeRecommendation entity.

Put a Knowledge Recommendation › 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 a Knowledge Recommendation

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

Delete a Knowledge Recommendation › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Delete a Knowledge Recommendation › Responses

Successfully deleted

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

Patch a Knowledge Recommendation

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

Patch a Knowledge Recommendation › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Patch a Knowledge Recommendation › 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

Patch a Knowledge Recommendation › Request Body

  • dataobject · required

    JSON:API representation of patching knowledgeRecommendation entity.

Patch a Knowledge Recommendation › 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}
KnowledgeMemory Items