Metadata

Update predefined metadata entry by id

Changed on

Update the predefined metadata entry with the given <strong>{id}</strong>. All provided fields will be updated on the existing entry.

put/pimcore-studio/api/metadata/predefined/{id}

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

Path parameters

idstring required
Example:alpha-numerical

Id of the metadata

Request body

namestring required

Name

descriptionstring nullable required

Description

typestring required

Type

targetSubTypestring nullable required

Target sub type

datastring required

Data

configstring nullable required

Config

languagestring nullable required

Language

groupstring nullable required

Group

Example request

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

Response

Updated 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