Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
    Analytics Model
    Metrics
    Dashboards
    Context Filters
    Filter Views
    Visualization Object
      Get all Visualization ObjectsgetPost Visualization ObjectspostGet a Visualization ObjectgetPut a Visualization ObjectputDelete a Visualization ObjectdeletePatch a Visualization Objectpatch
    Dependency Graph
    Attribute Hierarchies
Reporting
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

Visualization Object (3.51)

Endpoint:/

Get all Visualization Objects

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

Get all Visualization Objects › path Parameters

  • workspaceIdstring · required

Get all Visualization Objects › 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
    facts
    attributes
    labels
    metrics
    datasets
    createdBy
    modifiedBy
  • 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 Visualization Objects › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get all Visualization Objects › Responses

Request successfully processed

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

    Included resources

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

Post Visualization Objects

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

Post Visualization Objects › path Parameters

  • workspaceIdstring · required

Post Visualization Objects › 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
    facts
    attributes
    labels
    metrics
    datasets
    createdBy
    modifiedBy
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Post Visualization Objects › Request Body

  • dataobject · required

    JSON:API representation of visualizationObject entity.

Post Visualization Objects › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of visualizationObject entity.

  • includedarray · unique

    Included resources

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

Get a Visualization Object

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

Get a Visualization Object › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Get a Visualization Object › 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
    facts
    attributes
    labels
    metrics
    datasets
    createdBy
    modifiedBy
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Get a Visualization Object › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get a Visualization Object › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of visualizationObject entity.

  • includedarray · unique

    Included resources

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

Put a Visualization Object

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

Put a Visualization Object › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Put a Visualization Object › 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
    facts
    attributes
    labels
    metrics
    datasets
    createdBy
    modifiedBy

Put a Visualization Object › Request Body

  • dataobject · required

    JSON:API representation of visualizationObject entity.

Put a Visualization Object › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of visualizationObject entity.

  • includedarray · unique

    Included resources

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

Delete a Visualization Object

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

Delete a Visualization Object › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

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

Successfully deleted

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

Patch a Visualization Object

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

Patch a Visualization Object › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Patch a Visualization Object › 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
    facts
    attributes
    labels
    metrics
    datasets
    createdBy
    modifiedBy

Patch a Visualization Object › Request Body

  • dataobject · required

    JSON:API representation of patching visualizationObject entity.

Patch a Visualization Object › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of visualizationObject entity.

  • includedarray · unique

    Included resources

  • linksobject
PATCH /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}
Filter ViewsDependency Graph