Custom fields data
Fields:
| Field Name | Type | Required | Description |
|---|---|---|---|
| id | string, number | Yes | Unique identifier of custom field |
| type | string | Yes | Defines the allowed types of custom field |
| name | string | Yes | Defines the name of custom field |
| catalog_fields | CatalogField[] | No | Field settings for the 'catalog' custom field type. |
| data | DataField{} | No | Contains additional data for the 'vote' and 'collective_vote' fields |
| options | Options[] | No | Defines the available options for selected or catalog custom field types |
| score_variant | string | No | Specifies the variant of the score. |
| vote_variant | string | No | Specifies the variant of the vote. |
Description of fields:
id:
Unique identifier of custom field.
type:
Defines the allowed types of custom field.
name:
Defines the name of custom field, used for display purposes.
catalog_fields:
Defines the settings for fields within the 'catalog' custom field type.
data:
Specifies the additional data for the 'vote' and 'collective_vote' fields.
options:
Defines the available options for selected or catalog custom field types.
score_variant:
Specifies the variant of custom fields with type 'collective_score'.
vote_variant:
Specifies the variant of custom fields with types 'vote' and 'collective_vote'.
CatalogField:
| Field Name | Type | Required | Description |
|---|---|---|---|
| id | string, number | Yes | Unique identifier of the catalog field. |
| name | string | Yes | Name of the catalog field. |
| required | boolean | No | Indicates whether the catalog field is mandatory. |
| sort_order | integer | No | Sorting order of the catalog field. |
DataField:
| Field Name | Type | Required | Description |
|---|---|---|---|
| count | number | Yes | The total count of rating option, which is used to show the correct emoji count. |
| emoji | string | Yes | The emoji for rating option, which is used for display purposes. |
or
| Field Name | Type | Required | Description |
|---|---|---|---|
| emojis | array | Yes | The list of emojis for emoji set option, which is used for display purposes. Accepts only valid emojis, each item is accepting just one emoji. |
Options:
| Field Name | Type | Required | Description |
|---|---|---|---|
| id | string, number | Yes | Unique identifier of custom field option or catalog field ID |
| value | string, number | array | Yes | Value of custom field option |
| color | integer | null | No | Defines the selected color of custom property |
| name | string | No | The name of the catalog option |
| sort_order | number, null | No | The numeric value which defines the sort order |
CatalogItem:
| Field Name | Type | Required | Description |
|---|---|---|---|
| catalog_field_id | string, number | Yes | Unique identifier of the catalog field |
| item | string | Yes | Value of catalog field |
JSON schema:
