Sign in
Metadata

Create a new predefined metadata entry

Changed on

Create a new predefined metadata entry. An optional request body can be provided to set name, type, language, and other fields. If no body is sent, the entry is created with default values (name: "New Definition", type: "input").

post/pimcore-studio/api/metadata/predefined

Request

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

Request body

namestring required

Name

typestring required

Type

descriptionstring nullable required

Description

targetSubTypestring nullable required

Target sub type

datastring required

Data

configstring nullable required

Config

languagestring nullable required

Language

groupstring nullable required

Group

Example request

{
  "name": "New Definition",
  "type": "input",
  "description": "A predefined metadata",
  "targetSubType": "image",
  "data": "data",
  "config": "config",
  "language": "en",
  "group": "group"
}

Response

Newly created predefined metadata entry

additionalAttributesobject

AdditionalAttributes

idstring required

Id

namestring required

Name

descriptionstring nullable

Description

typestring required

Type

targetSubTypestring nullable

Target sub type

datastring

Data

configstring nullable

Config

languagestring nullable

Language

groupstring nullable

Group

creationDateinteger required

Creation Date

modificationDateinteger required

Modfication Date

isWriteableboolean required

Writable

Example response

{
  "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