Sign in
Data Objects

Preview data object by ID

Preview data object by ID. Any additional query parameters (e.g. locale, site) are forwarded to the preview generator configured on the data object class. <br> Available parameters depend on the preview generator implementation and can be retrieved from the layout endpoint's previewConfig.

get/pimcore-studio/api/data-objects/preview/{id}

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

Path parameters

idinteger required
Example:83

Id of the data object

Query parameters

siteinteger

Site ID for multi-site setups

Response

302 - Redirect<br>400 - Bad Request<br>401 - Unauthorized<br>404 - Not Found<br>405 - Method Not Allowed<br>415 - Unsupported Media Type<br>422 - Unprocessable Content<br>500 - Internal Server Error

OR

Example response

{
  "message": "I am an error message"
}

Changes

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