GOgooddata
Plugins

The search endpoint (beta)

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

Request

  • Base URL
    https://www.gooddata.ai
  • Auth
    none declared

Path parameters

workspaceIdstring required

Query parameters

origin'ALL' | 'PARENTS' | 'NATIVE'

Defines scope of origin of objects. All by default.

Headers

X-GDC-VALIDATE-RELATIONSboolean

Request body

filterstring nullable

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[] nullable

List of related entities to include in the response

metaIncludestring[] nullable

Set of metadata fields to include in the response

Response

Request successfully processed

Example response

{
  "data": [
    {
      "attributes": {
        "content": {
          "url": "<plugin-url>"
        },
        "createdAt": "2023-07-20 12:30",
        "modifiedAt": "2023-07-20 12:30"
      },
      "id": "id1",
      "type": "dashboardPlugin"
    }
  ],
  "included": [
    {
      "id": "id1",
      "type": "userIdentifier"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.