Metadata

Get predefined metadata collection with filtering and sorting

Changed on

Get predefined metadata collection with optional search, column filtering, and sorting. Supports <strong>searchTerm</strong> for global text search across all fields, <strong>columnFilters</strong> for per-column filtering (like/equals), and <strong>sortFilter</strong> for sorting by any filterable column.

post/pimcore-studio/api/metadata

Request

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

Request body

searchTermstring nullable

Global search term applied across all fields

Example request

{
  "searchTerm": "author",
  "columnFilters": [
    {
      "key": "name",
      "type": "like",
      "filterValue": "author"
    }
  ],
  "sortFilter": {
    "key": "name",
    "direction": "ASC"
  }
}

Response

Predefined metadata collection with total item count

totalItemsinteger required

Example response

{
  "totalItems": 666,
  "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

  • 81b097a1505fRevision changes
    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status