Sign in
Perspectives

Get perspective configuration by ID

Changed on

Get the perspective configuration with the given <strong>{perspectiveId}</strong>. <br> The <strong>{perspectiveId}</strong> must be an ID of an existing perspective.

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 configuration data as JSON

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,
        "hasViewAccess": 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,
        "hasViewAccess": 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,
        "hasViewAccess": true
      },
      "pageSize": 20,
      "isWriteable": true
    }
  ],
  "expandedLeft": "widget_id",
  "expandedRight": "widget_id"
}

Changes

  • 81b097a1505fRevision changes
    • info

      added the required property ///// to the response with the status

    • info

      added the required property ///// to the response with the status

    • info

      added the required property ///// to the response with the status