Sign in
Perspectives

perspective_get_config_by_id_summary

perspective_get_config_by_id_description

get/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:studio_default_perspective

Get perspective by matching Id

Response

perspective_get_config_by_id_success_response

additionalAttributesobject

AdditionalAttributes

idstring required

Perspective ID

namestring required

Name

isWriteableboolean required

Is Writeable

contextPermissionsobject required

Context Permissions

expandedLeftstring nullable required

Left Expanded Widget

expandedRightstring nullable required

Right Expanded Widget

Example response

{
  "id": "5026c239_eb75_499a_8576_841bca283350",
  "name": "Cars",
  "icon": {
    "type": "path",
    "value": "/path/to/icon"
  },
  "isWriteable": true,
  "contextPermissions": {
    "permission_group": {
      "permission1": true,
      "permission2": false
    }
  },
  "widgetsLeft": [
    {
      "id": "5026c239_eb75_499a_8576_841bca283350",
      "name": "Cars",
      "widgetType": "element_trees",
      "icon": {
        "type": "path",
        "value": "/path/to/icon"
      },
      "contextPermissions": {
        "add": true,
        "addFolder": true,
        "changeChildrenSortBy": true,
        "copy": true,
        "cut": true,
        "delete": true,
        "lock": true,
        "lockAndPropagate": true,
        "paste": true,
        "publish": true,
        "refresh": true,
        "rename": true,
        "searchAndMove": true,
        "unlock": true,
        "unlockAndPropagate": true,
        "unpublish": true
      },
      "elementType": "data-object",
      "rootFolder": {
        "id": 83,
        "type": "object",
        "subtype": "Product",
        "fullPath": "/path/to/element",
        "isPublished": true
      },
      "pageSize": 20,
      "isWriteable": true
    }
  ],
  "widgetsRight": [
    {
      "id": "5026c239_eb75_499a_8576_841bca283350",
      "name": "Cars",
      "widgetType": "element_trees",
      "icon": {
        "type": "path",
        "value": "/path/to/icon"
      },
      "contextPermissions": {
        "add": true,
        "addFolder": true,
        "changeChildrenSortBy": true,
        "copy": true,
        "cut": true,
        "delete": true,
        "lock": true,
        "lockAndPropagate": true,
        "paste": true,
        "publish": true,
        "refresh": true,
        "rename": true,
        "searchAndMove": true,
        "unlock": true,
        "unlockAndPropagate": true,
        "unpublish": true
      },
      "elementType": "data-object",
      "rootFolder": {
        "id": 83,
        "type": "object",
        "subtype": "Product",
        "fullPath": "/path/to/element",
        "isPublished": true
      },
      "pageSize": 20,
      "isWriteable": true
    }
  ],
  "widgetsBottom": [
    {
      "id": "5026c239_eb75_499a_8576_841bca283350",
      "name": "Cars",
      "widgetType": "element_trees",
      "icon": {
        "type": "path",
        "value": "/path/to/icon"
      },
      "contextPermissions": {
        "add": true,
        "addFolder": true,
        "changeChildrenSortBy": true,
        "copy": true,
        "cut": true,
        "delete": true,
        "lock": true,
        "lockAndPropagate": true,
        "paste": true,
        "publish": true,
        "refresh": true,
        "rename": true,
        "searchAndMove": true,
        "unlock": true,
        "unlockAndPropagate": true,
        "unpublish": true
      },
      "elementType": "data-object",
      "rootFolder": {
        "id": 83,
        "type": "object",
        "subtype": "Product",
        "fullPath": "/path/to/element",
        "isPublished": true
      },
      "pageSize": 20,
      "isWriteable": true
    }
  ],
  "expandedLeft": "widget_id",
  "expandedRight": "widget_id"
}

Changes

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