Fields Info

Output representation of the metadata fields in an object.

JSON Example

1"fields": [
2          {
3            "dataType": "text",
4            "isFacetableConfigurable": true,
5            "isSearchableConfigurable": false,
6            "label": "Product Name",
7            "name": "Name",
8            "type": "Standard"
9          },
10          {
11            "dataType": "multilinetext",
12            "isFacetableConfigurable": false,
13            "isSearchableConfigurable": true,
14            "label": "Product Description",
15            "name": "Description",
16            "type": "Standard"
17          }
18        ]

Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`customFieldId`	String	ID of the custom field.	Small, 62.0	62.0
`dataType`	String	Type of data.	Small, 62.0	62.0
`isConfigurable`	Boolean	Reserved for internal use.	Small, 62.0	62.0
`isFacetableConfigurable`	Boolean	Indicates whether the field is facetable (`true`) or not (`false`).	Small, 63.0	Small, 63.0
`isSearchableConfigurable`	Boolean	Indicates whether the field is searchable (`true`) or not (`false`).	Small, 63.0	Small, 63.0
`label`	String	Label of the object field.	Small, 62.0	62.0
`name`	String	Name of the object field.	Small, 62.0	62.0
`type`	String	Type of the object field.	Small, 62.0	62.0