Sign in
Bundle Studio Dashboards

Get layout options

Changed on

Get all available layout options for a dashboard row

get/pimcore-studio/api/bundle/studio-dashboards/layout-options

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/bundle/studio-dashboards/layout-options
  • Auth: none declared

Response

All layout options successfully retrieved

totalItemsinteger required

Example response

{
  "totalItems": 666,
  "items": [
    {
      "layoutId": "dashboard-layout-1",
      "rows": 4,
      "columns": 3,
      "items": [
        {
          "id": 1,
          "colSpan": 2,
          "rowSpan": 1,
          "widget": {
            "id": "5026c239_eb75_499a_8576_841bca283350",
            "name": "Cars",
            "widgetType": "wysiwyg",
            "icon": {
              "type": "path",
              "value": "/path/to/icon"
            },
            "visualization": "table"
          }
        }
      ],
      "headline": "Quality overview",
      "headlineFontSize": "medium"
    }
  ]
}

Changes

  • 81b097a1505fRevision changes
    • breaking

      added subschema #2 to the ////// response property oneOf list for the response status

    • breaking

      the ////// response's property type changed from object to no type for status

    • breaking

      removed the required property /////// from the response with the status

    • breaking

      removed the required property /////// from the response with the status

    • info

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

    • info

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