Perspectives

Update widget configuration by id and type

Update the perspective configuration with the given <strong>{perspectiveId}</strong>. <br> The <strong>{perspectiveId}</strong> must be an ID of an existing perspective. <br> Please note that <strong>all configuration fields<strong> have to be provided.

put/pimcore-studio/api/perspectives/configuration/{perspectiveId}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/perspectives/configuration/{perspectiveId}
  • Auth: none declared

Path parameters

perspectiveIdstring required
Example:d061699e_da42_4075_b504_c2c93c687819

Update perspective by matching Id

Request body

namestring required

Name

contextPermissionsobject required

Context Permissions

widgetsLeftobject required

Widgets Left

widgetsRightobject required

Widgets Right

widgetsBottomobject required

Widgets Bottom

expandedLeftstring nullable required

Left Expanded Widget

expandedRightstring nullable required

Right Expanded Widget

Example request

{
  "name": "Cars",
  "icon": {
    "type": "path",
    "value": "/path/to/icon"
  },
  "widgetsLeft": {
    "widget_id": "widget_type"
  },
  "widgetsRight": {
    "widget_id": "widget_type"
  },
  "widgetsBottom": {
    "widget_id": "widget_type"
  },
  "expandedLeft": "widget_id",
  "expandedRight": "widget_id"
}

Response

Successfully updated perspective configuration

Changes

No recorded changes to this operation across all 2 revisions of this API.