Organization
Users and User Groups
Permissions
Data Source
Workspaces
    Workspaces - Entity APIs
      Get Workspace entitiesgetPost Workspace entitiespostGet Workspace entitygetPut Workspace entityputDelete Workspace entitydeletePatch Workspace entitypatch
    Workspaces - Declarative APIs
    Data Filters
    Workspaces - Settings
    Appearance
    Plugins
    Hierarchy
    Translations
Logical Data Model
Analytical Objects
Reporting
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

Workspaces - Entity APIs (3.51)

Endpoint:/

Get Workspace entities

GET
/api/v1/entities/workspaces

Space of the shared interest

Get Workspace entities › 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:
    workspaces
    parent
    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:
    permissions
    config
    hierarchy
    dataModelDatasets
    page
    all
    ALL

Get Workspace entities › Responses

Request successfully processed

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

    Included resources

  • linksobject
  • metaobject
GET /api/v1/entities/workspaces

Post Workspace entities

POST
/api/v1/entities/workspaces

Space of the shared interest

Post Workspace entities › 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:
    workspaces
    parent
    ALL
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    permissions
    config
    hierarchy
    dataModelDatasets
    all
    ALL

Post Workspace entities › Request Body

  • dataobject · required

    JSON:API representation of workspace entity.

Post Workspace entities › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of workspace entity.

  • includedobject[] · unique

    Included resources

  • linksobject
POST /api/v1/entities/workspaces

Get Workspace entity

GET
/api/v1/entities/workspaces/{id}

Space of the shared interest

Get Workspace entity › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Get Workspace entity › 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:
    workspaces
    parent
    ALL
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    permissions
    config
    hierarchy
    dataModelDatasets
    all
    ALL

Get Workspace entity › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of workspace entity.

  • includedobject[] · unique

    Included resources

  • linksobject
GET /api/v1/entities/workspaces/{id}

Put Workspace entity

PUT
/api/v1/entities/workspaces/{id}

Space of the shared interest

Put Workspace entity › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Put Workspace entity › 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:
    workspaces
    parent
    ALL

Put Workspace entity › Request Body

  • dataobject · required

    JSON:API representation of workspace entity.

Put Workspace entity › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of workspace entity.

  • includedobject[] · unique

    Included resources

  • linksobject
PUT /api/v1/entities/workspaces/{id}

Delete Workspace entity

DELETE
/api/v1/entities/workspaces/{id}

Space of the shared interest

Delete Workspace entity › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Delete Workspace entity › 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 Workspace entity › Responses

Successfully deleted

No data returned
DELETE /api/v1/entities/workspaces/{id}

Patch Workspace entity

PATCH
/api/v1/entities/workspaces/{id}

Space of the shared interest

Patch Workspace entity › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Patch Workspace entity › 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:
    workspaces
    parent
    ALL

Patch Workspace entity › Request Body

  • dataobject · required

    JSON:API representation of patching workspace entity.

Patch Workspace entity › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of workspace entity.

  • includedobject[] · unique

    Included resources

  • linksobject
PATCH /api/v1/entities/workspaces/{id}
Data source files manifest readWorkspaces - Declarative APIs