Data model description
| Attribute | Description | Example |
|---|---|---|
idstring | Unique metadata schema ID. | ms_OF36L2rk4EqhdxvZs56IW9iE |
related_objectstring | The resource type. | loyalty_tier |
propertiesobject | Contains the metadata definitions. type - string - value can be a string, number, object, date, datetime, geopoint, boolean, image_urlarray - boolean - Indicates whether the definition is an arrayoptional - boolean - Indicates whether this definition is optional or not optional for the resource.objectType - string - Returns the name of the custom resource if the resource was previously defined in the UI as a custom (non-standard) Nested object.eq - array - Array of possible values when the setting for is equal to any of in the UI is defined explicitly.ne - array - Array of values that are not allowed when the setting for is not equal to any of in the UI 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 schemamaxLength - integer - Value for maximum length when the setting for has maximum length of in the UI is defined explicitly.minLength - integer - Value indicating minimum length when the setting for has minimum length of in the UI is defined explicitly.exactLength - integer - Value indicating exact length when the setting for has exact length of in the UI is defined explicitly. | "properties": { "payment_tax": { "type": "number", "array": false, "optional": true, "objectType": null }, "payment_method": { "type": "string", "array": false, "optional": true, "objectType": null } } |
allow_defined_onlyboolean | 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. | false |
created_atstring | Timestamp representing the date and time when the metadata schema was created in ISO 8601 format. | 2022-03-30T06:22:16.685Z |
updated_atstring | Timestamp representing the date and time when the metadata schema was updated in ISO 8601 format. | 2022-07-27T08:55:01.628Z |
objectstring | Type of the object represented by JSON. Value is by default metadata_schema. | metadata_schema |