Skip to main content

Metadata Schema Object

AttributesDescription

id
string

Unique metadata schema ID.

Example: ms_OF36L2rk4EqhdxvZs56IW9iE

related_object
string

The resource type. There is an infinite number of possibilities for the resource type because you can define custom metadata schemas. Some examples are included here to show you the standard metadata schema resource types.

Available values: campaign, customer, earning_rule, loyalty_tier, order, order_item, product, promotion_tier, publication, redemption, reward, voucher

properties
object

Contains the metadata definitions. There can be many properties within this object.

AttributesDescription

custom_property_name
object

Custom property name. This is defined in Project Settings

Metadata Schema in the Dashboard.

AttributesDescription

type
string

Available values: string, number, object, date, datetime, geopoint, boolean, image_url

array
boolean

Indicates whether the definition is an array.

optional
boolean

Indicates whether this definition is optional or not optional for the resource.

objectType
string, null

Returns the name of the custom resource if the resource was previously defined in the Dashboard as a custom (non-standard) Nested object.

eq
array

Array of possible values when the setting for is equal to any of in the Dashboard is defined explicitly.

ne
array

Array of values that are not allowed when the setting for is not equal to any of in the Dashboard is defined explicitly.

lt
integer

A property of number type must have less than this value.

lte
integer

A property of number type must be less than or equal to this value.

gt
integer

A property of number type must be greater than this value.

gte
integer

A property of number type must be greater than or equal to this value.

deleted
boolean

Indicates whether the definition was deleted from the schema.

maxLength
integer

Value for maximum length when the setting for has maximum length of in the Dashboard is defined explicitly.

minLength
integer

Value indicating minimum length when the setting for has minimum length of in the Dashboard is defined explicitly.

exactLength
integer

Value indicating exact length when the setting for has exact length of in the Dashboard is defined explicitly.

allow_defined_only
boolean

Restricts the creation of metadata fields when set to true. In other words, it indicates whether or not you are allowed to create new metadata definitions; for example, in the campaign manager or publication manager. If it is set to true, then only the defined fields will be available for assigning values.

created_at
string

Timestamp representing the date and time when the metadata schema was created. The value is shown in the ISO 8601 format.

Example: 2021-12-03T13:33:44.556Z

updated_at
string

Timestamp representing the date and time when the metadata schema was updated. The value is shown in the ISO 8601 format.

Example: 2022-08-11T08:05:30.695Z

object
string

The type of the object represented by the JSON. This object stores information about the metadata schema.