GOgooddata
Plugins

Get all Plugins

get/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins

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.

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

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.

pageinteger

Zero-based page index (0..N)

sizeinteger

The size of the page to be returned

sortstring[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

metaIncludestring[]

Included meta objects

Include Meta objects.

Headers

X-GDC-VALIDATE-RELATIONSboolean

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.