Assets

Get asset by ID

Changed on

Retrieves a specific asset data based on the given <strong>{id}</strong>. <br> The <strong>{id}</strong> must be an ID of existing asset.

get/pimcore-studio/api/assets/{id}

Request

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

Path parameters

idinteger required
Example:83

Id of the asset

Response

Successfully retrieved one of asset type data as JSON

OR
OR
OR
OR
OR
OR
OR

Example response

{
  "id": 83,
  "parentId": 1,
  "path": "/path/to/element",
  "icon": {
    "type": "path",
    "value": "/path/to/icon"
  },
  "userOwner": 1,
  "userModification": 1,
  "locked": "locked",
  "creationDate": 221846400,
  "modificationDate": 327417600,
  "elementType": "asset",
  "customAttributes": {
    "icon": {
      "type": "path",
      "value": "/path/to/icon"
    },
    "tooltip": "<b>My Tooltip</b>",
    "additionalIcons": [
      "some_other_icon"
    ],
    "key": "my_custom_key",
    "additionalCssClasses": [
      "my_custom_class"
    ]
  },
  "type": "image",
  "filename": "cool.jpg",
  "mimeType": "image/jpeg",
  "fullPath": "/path/to/asset.jpg",
  "permissions": {
    "list": true,
    "view": true,
    "publish": true,
    "delete": true,
    "rename": true,
    "create": true,
    "settings": true,
    "versions": true,
    "properties": true
  },
  "width": 666,
  "height": 333,
  "imageThumbnailPath": "/path/to/element/hulk-smash.jpg"
}

Changes

  • 81b097a1505fRevision changes
    • warning

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

    • warning

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

    • warning

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