Organization
Users and User Groups
Permissions
Data Source
Workspaces
    Workspaces - Entity APIs
    Workspaces - Declarative APIs
    Data Filters
    Workspaces - Settings
    Appearance
    Plugins
      Get all PluginsgetPost PluginspostGet a PlugingetPut a PluginputDelete a PlugindeletePatch a Pluginpatch
    Hierarchy
    Translations
Logical Data Model
Analytical Objects
Reporting
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

Plugins (3.51)

Endpoint:/

Get all Plugins

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

Get all Plugins › path Parameters

  • workspaceIdstring · required

Get all Plugins › 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

Get all Plugins › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get all Plugins › Responses

Request successfully processed

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

    Included resources

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

Post Plugins

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

Post Plugins › path Parameters

  • workspaceIdstring · required

Post Plugins › 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

Post Plugins › Request Body

  • dataobject · required

    JSON:API representation of dashboardPlugin entity.

Post Plugins › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of dashboardPlugin entity.

  • includedobject[] · unique

    Included resources

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

Get a Plugin

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

Get a Plugin › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Get a Plugin › 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

Get a Plugin › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get a Plugin › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of dashboardPlugin entity.

  • includedobject[] · unique

    Included resources

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

Put a Plugin

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

Put a Plugin › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Put a Plugin › 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

Put a Plugin › Request Body

  • dataobject · required

    JSON:API representation of dashboardPlugin entity.

Put a Plugin › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of dashboardPlugin entity.

  • includedobject[] · unique

    Included resources

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

Delete a Plugin

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

Delete a Plugin › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Delete a Plugin › 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 Plugin › Responses

Successfully deleted

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

Patch a Plugin

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

Patch a Plugin › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Patch a Plugin › 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

Patch a Plugin › Request Body

  • dataobject · required

    JSON:API representation of patching dashboardPlugin entity.

Patch a Plugin › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of dashboardPlugin entity.

  • includedobject[] · unique

    Included resources

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