Organization
Users and User Groups
Permissions
Data Source
Workspaces
    Workspaces - Entity APIs
    Workspaces - Declarative APIs
      Get all workspaces layoutgetSet all workspaces layoutputGet workspace layoutgetSet workspace layoutput
    Data Filters
    Workspaces - Settings
    Appearance
    Plugins
    Hierarchy
    Translations
Logical Data Model
Analytical Objects
Reporting
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

Workspaces - Declarative APIs (3.51)

Endpoint:/

Get all workspaces layout

GET
/api/v1/layout/workspaces

Gets complete layout of workspaces, their hierarchy, models.

Get all workspaces layout › query Parameters

  • excludestring[]
    Enum values:
    ACTIVITY_INFO

Get all workspaces layout › Responses

Retrieved layout of all workspaces.

  • workspaceDataFiltersobject[] · required
  • workspacesobject[] · required
GET /api/v1/layout/workspaces

Set all workspaces layout

PUT
/api/v1/layout/workspaces

Sets complete layout of workspaces, their hierarchy, models.

Set all workspaces layout › Request Body

  • workspaceDataFiltersobject[] · required
  • workspacesobject[] · required

Set all workspaces layout › Responses

All workspaces layout set.

No data returned
PUT /api/v1/layout/workspaces

Get workspace layout

GET
/api/v1/layout/workspaces/{workspaceId}

Retrieve current model of the workspace in declarative form.

Get workspace layout › path Parameters

  • workspaceIdstring · required

Get workspace layout › query Parameters

  • excludestring[]
    Enum values:
    ACTIVITY_INFO

Get workspace layout › Responses

Retrieved the workspace model.

  • analyticsobject
  • ldmobject

    A logical data model (LDM) representation.

GET /api/v1/layout/workspaces/{workspaceId}

Set workspace layout

PUT
/api/v1/layout/workspaces/{workspaceId}

Set complete layout of workspace, like model, authorization, etc.

Set workspace layout › path Parameters

  • workspaceIdstring · required

Set workspace layout › Request Body

  • analyticsobject
  • ldmobject

    A logical data model (LDM) representation.

Set workspace layout › Responses

The model of the workspace was set.

No data returned
PUT /api/v1/layout/workspaces/{workspaceId}
Workspaces - Entity APIsData Filters