Attribute Definition

Output representation of the attribute definition.

JSON Example

1"attributes": [
2     {
3      "additionalFields": {
4      "scope": "Order"
5       },
6      "attributeNameOverride": "AD Text",
7      "code": "AD02",
8      "dataType": "Text",
9      "defaultValue": "AD Text DV",
10      "description": "AD Text Desc",
11      "displayType": "Text",
12      "helpText": "AD Text DHT",
13      "id": "0tjT1000000002bIAA",
14      "isHidden": false,
15      "isPriceImpacting": true,
16      "isReadOnly": true,
17      "isRequired": true,
18      "label": "AD Text Label",
19      "maximumCharacterCount": 20,
20      "maximumValue": "100",
21      "minimumCharacterCount": 1,
22      "minimumValue": "50",
23      "name": "AD Text",
24      "sequence": 1,
25      "status": "Active",
26      "valueDescription": "AD Text VD"
27     }
28   ],
29    "code": "AC001",
30    "id": "0v3T1000000000BIAQ",
31    "name": "build and make"
32}]

Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`additionalFields`	Map<String, Additional Fields Input>	Key-value pair of additional standard or custom fields to include in the response.	Small, 61.0	61.0
`attributeNameOverride`	String	Name to display for the attribute, which overrides the name on the attribute. For example, the Color attribute is overridden to display as Laptop Color.	Small, 60.0	60.0
`code`	String	Unique code of the attribute definition.	Small, 60.0	60.0
`dataType`	String	Data type of the attribute definition value.	Small, 60.0	60.0
`defaultValue`	String	Default value of the attribute.	Small, 60.0	60.0
`description`	String	Description of the attribute.	Small, 60.0	60.0
`displayType`	String	Display types of the attribute. Valid values are `Radio Button`, `Checkbox`, `Toggle`, `Input Date`, `DateTime`, `Currency Symbol`, `Currency Code`, `Currency Name`, `Percentage`, `Text`, `Combobox`, `Radio Button`, `MultiSelect`, or `MultiSelectCheckboxes`.	Small, 60.0	60.0
`helpText`	String	Help text that appears at run time for the attribute. If data translation is set up and specified in the org, the translated description is available.	Small, 60.0	60.0
`id`	String	ID of the attribute definition.	Small, 60.0	60.0
`isConfigurable`	Boolean	Reserved for future use.	Small, 60.0	60.0
`isHidden`	Boolean	Indicates whether to hide the attribute from the users in the order capture interface (`true`) or not (`false`).	Small, 60.0	60.0
`isPriceImpacting`	Boolean	Indicates whether the attribute impacts the product price (`true`) or not (`false`).	Small, 60.0	60.0
`isReadOnly`	Boolean	Indicates whether the product attribute is read-only for the end users in the order capture page (`true`) or not (`false`).	Small, 60.0	60.0
`isRequired`	Boolean	Indicates whether a value for the attribute is required for the assigned parent object (`true`) or not (`false`).	Small, 60.0	60.0
`isValueCloneable`	Boolean	Reserved for future use.	Small, 60.0	60.0
`label`	String	Label of the attribute. If data translation is set up and specified in the org, the translated description is available.	Small, 60.0	60.0
`maximumCharacterCount`	Integer	Maximum number of alphanumeric characters that can be entered for attributes of type number and text in run time.	Small, 60.0	60.0
`maximumValue`	String	Maximum value that can be entered for attributes of type number, currency, and percent in run time.	Small, 60.0	60.0
`minimumCharacterCount`	Integer	Minimum number of alphanumeric characters that can be entered for attributes of type number and text in run time. The minimum character count must be less than or equal to the maximum character count.	Small, 60.0	60.0
`minimumValue`	String	Minimum value that can be entered for attributes of type number, currency, and percent in run time. The minimum value must be less than or equal to the maximum value.	Small, 60.0	60.0
`name`	String	Name of the attribute.	Small, 60.0	60.0
`picklist`	Attribute Picklist	ID of the attribute picklist that provides the valid values for the attribute.	Small, 60.0	60.0
`sequence`	Integer	Order in which the attribute values appear in the attribute definition when the product is configured at run time.	Small, 60.0	60.0
`status`	String	Lifecycle state of the attribute picklist. Valid values are `Active`, `Draft`, or `Inactive`.	Small, 60.0	60.0
`stepValue`	String	Reserved for future use.	Small, 60.0	60.0
`valueDecoder`	String	Reserved for future use.	Small, 60.0	60.0
`valueDescription`	String	Description of the value assigned to the attribute.	Small, 60.0	60.0