Sign in
Data Object Grid

data_object_get_grid_preview_summary

data_object_get_grid_preview_description

post/pimcore-studio/api/data-objects/grid/preview

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/preview
  • Auth: none declared

Request body

objectIdinteger required

Example request

{
  "objectId": 1,
  "column": {
    "key": "id",
    "locale": "en",
    "type": "system.id",
    "group": [
      "system"
    ],
    "config": [
      {
        "advancedColumns": [
          {
            "key": "simpleField",
            "config": {
              "field": "name"
            }
          }
        ],
        "transformers": [
          {
            "key": "uppercase"
          }
        ]
      }
    ]
  }
}

Response

data_object_get_grid_preview_success_response

additionalAttributesobject

AdditionalAttributes

keystring

Key

localestring nullable

Locale

valueunknown
fieldTypestring nullable

Field Type of the column

inheritanceobject nullable

inheritance

Example response

{
  "key": "id",
  "locale": "en",
  "value": 73,
  "fieldType": "input",
  "inheritance": {
    "objectId": 42,
    "inInherited": true
  }
}

Changes

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