Sign in
Data Object Grid

Get data object data for grid

Changed on

Retrieve data objects data for grid. <br> You can use different query parameters to filter the data objects data: <br>

<ul> <li><strong>folderId</strong>: ID of parent folder</li> <li><strong>columns</strong>: To see the full description of request fields see the schema <strong>Grid Column Request</strong></li> <li><strong>filters</strong>: To see the full description of request fields see the schema <strong>Grid Filter</strong></li> </ul>
post/pimcore-studio/api/data-objects/grid/{classId}

Request

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

Path parameters

classIdstring required
Example:EV

Identifies the class name for which the the grid should be build.

Request body

folderIdinteger required
applyFallbackLanguagesboolean

When true, empty localized values fall back to configured fallback languages

Example request

{
  "folderId": 1,
  "columns": [
    {
      "key": "id",
      "locale": "en",
      "type": "system.id",
      "group": [
        "system"
      ],
      "config": [
        {
          "advancedColumns": [
            {
              "key": "simpleField",
              "config": {
                "field": "name"
              }
            }
          ],
          "transformers": [
            {
              "key": "uppercase"
            }
          ]
        }
      ],
      "width": 200
    }
  ],
  "filters": {
    "page": 1,
    "pageSize": 50
  }
}

Response

Data object grid data

totalItemsinteger required

Example response

{
  "totalItems": 666,
  "items": [
    {
      "columns": [
        {
          "key": "id",
          "locale": "en",
          "value": 73,
          "fieldType": "input",
          "inheritance": {
            "objectId": 42,
            "inInherited": true
          }
        }
      ],
      "permissions": {
        "list": true,
        "view": true,
        "publish": true,
        "delete": true,
        "rename": true,
        "create": true,
        "settings": true,
        "versions": true,
        "properties": true
      }
    }
  ]
}

Changes

  • 81b097a1505fRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //

    • info

      added the new optional request property /