Sign in
Metadata

Get predefined metadata for assets by type

Changed on

Get predefined metadata entries filtered by asset type, sub-type and group. Returns metadata definitions applicable to a specific asset type.

get/pimcore-studio/api/metadata/asset

Request

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

Query parameters

subTypestring
Example:image

Filter by asset sub-type (e.g. image, video).

groupstring
Example:default

Filter by metadata group. Use 'default' to match entries with no group assigned.

Response

Filtered predefined metadata entries for the specified asset type

Example response

{
  "items": [
    {
      "id": "1",
      "name": "custom_metadata",
      "description": "A predefined metadata",
      "type": "input",
      "targetSubType": "input",
      "data": "data",
      "config": "config",
      "language": "en",
      "group": "group",
      "creationDate": 1634025600,
      "modificationDate": 1634025600
    }
  ]
}

Changes