Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Type

Description

itemId

int

The itemId of the metafield.

metafieldId

int

The metafieldId of the metafield.

guid

string/uuid/guid

The ItemGuid of the metafield

type

enum/int

A value of the enumation mentioned on the above table. Use this to figure out which specified subtype to parse the response as.

name

string

A language-indenpendent name for the field. Usually the english name.

description

string

A language-independent description for the field.

sortIndex

int

A value that indicates how this field should be sorted in relation to other metafields.

visibilityMetaFieldId

int

Specifies the metafieldId of another metafield, this metafield depends on to be visible. If the value is 0 or null, then the field does not depend on another field.

visibilityRegex

string

If visibilityMetaFieldId is non-zero, then this is the regex to run on the value of that field to figure out if this field should be shown.

required

bool

If this field needs to have a value.

readonly

bool

If the field is marked as readonly or you don’t have write access.

HasWriteAccess

bool

If you don’t have write access to the field, independent of the field being marked readonly.

showInList

bool

If this field should be shown in the metadata editor in Media Manager.

system

bool

If this field is something the system absolutely needs to run.

autoTranslate

enum/string, one of:

  • None

  • CreateIfMissing

  • Overwrite

  • AutotranslateCreateIfMissing

  • AutotranslateOverwrite

Specifies how values are copied between different languages if a value updated.

groupId

int

The id of the metafield group this field is part of.

restrictToAssetType

int

The asset type this field should be visible for. If 0, then the field is visible for all assets

uploadTagName

string

A special tag for additional metadata extraction from the source file on upload.

labels

object

Specifies information about how the metafield is described in each available language. The key of the object is the language id.

labels.labelId

int

The metafieldLabelId of the field in that language.

labels.languageId

int

The language id of this metafieldLabel

labels.metafieldId

int

The metafieldId of the main metafield.

labels.label

string

The title/name/label of the field in this language.

labels.description

string

A language specific description of the metafield.

viewType

enum/string, one of

  • Combo

  • Radio

Descripes Describes how this combo field should be rendered as an input. Only available on metafield type ComboValue.

viewType

enum/string, one of

  • Date

  • DateTime

Descripes Describes how this date field should be rendered as an input. Only available on metafield type DateTime.

ItemType

enum/string

The item type of values that are selectable for this field. Only available on metafield type MasterItemReference and SlaveItemReference.

maxCount

int

How many items can be selected at most. Or 0 for no limit. Only available on metafield type MasterItemReference and SlaveItemReference.

relatedMetaFieldLabelId (thumbs down)

int/null

The metafieldLabelId of the SlaveItemReference / MasterItemReference metafield for this MasterItemReference / SlaveItemReference metafield. Only available on metafield type MasterItemReference and SlaveItemReference.

relatedMetaFieldId

int/null

The metafieldId of the SlaveItemReference metafield for this MasterItemReference metafield. Only available on metafield type MasterItemReference and SlaveItemReference.

maxLength

int

The max number of character that can be specified as a value. Only available on metafield type Note and String.

showRichTextEditor

bool

If this note metafield should be rendered as a rich text editor, rather than just a multi-line plaintext editor. Only available on metafield type Note.

selectToRoot

bool

If selecting a leaf node in the tree should automatically select all values up to the root of the tree. Only available on metafield type Tree.

...

Name

Type

Description

values

array

The selected values.

values.id

int

The language specific id of this tree node.

values.label

string

The language specific label/name/title of this tree node.

values.optionValue

string

The language independent text value of this tree node.

values.treeNodeId

int

The language independent id of this tree node.

values.parentId

int/null

The language specific id of the parent note, or null if no parent.

values.labelPath

string

A path containing each label/name/title on the way to this node from the root.

values.optionValuePath

string

A path containing each optionValue on the way to this node from the root.

values.parentTreeNodeId

int/null

The treeNodeId of the parent tree node, or null if no parent.

values.treeNodeIdPath

string

A path containing each treeNodeId on the way to this node from the root.

...