Option Values (Partial Update)
Description
Creates or updates an option value identified by the uuid or externalId in the request body.
If the identifier matches an existing option value, it is updated. If not, a new option value is created (upsert behavior). Omitted fields are left unchanged on update, or set to their defaults on creation.
See the Aerial Spec for more details.
File Naming Convention
TGEN_optionValues_partialupdate_2026-08_<optionalSuffix>.csv
importType:partialupdateapiVersion:2026-08
Columns
Nested object fields are flattened into columns using dot notation (parent.child). Array fields are flattened using zero-based index notation, one element per column (field[0], field[1], and so on).
Note: A whole array cannot be passed in a single column: a literal value such as ['value-1','value-2'] will be rejected. To import multiple array elements, add one indexed column per element. Rows in the table below with type array describe the field as a whole and are not valid CSV column headers.
| Column Header | Description | Key Information | Type | Required |
|---|---|---|---|---|
uuid | UUID of the resource that can be expressed using a value as defined in its types. | string | No | |
externalId | External ID of the resource that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
type | UUID, External ID or object representation of a option type | string | No | |
type.uuid | UUID of the resource | string | No | |
type.externalId | External ID of the resource | string | No | |
sortOrder | Sort order of the value against other values of this type that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | integer | No | |
value | The value used to render the option, it can be a string or a code that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
localizedData | A collection of Localizations of the option value that can be expressed using “SET_AS_NULL” (to reset all existing values) or a value as defined in its types. | Not a CSV column header. Pass each array element in its own indexed column (localizedData[0], localizedData[1], and so on). | array | No |
localizedData[0] | Array element | mixed | No | |
localizedData[0].languageCode | Language code of localization that can be expressed using a value as defined in its types. | string | Yes | |
localizedData[0].name | Localized option value name that can be expressed using a value as defined in its types. | string | No | |
localizedData[0].presentation | Localized option value presentation string that can be expressed using a value as defined in its types. | string | No | |
optionValueCategories | A collection of optionValueCategories that can be expressed using “SET_AS_NULL” (to reset all existing values), uuids or expanded objects of the accepted type. | Not a CSV column header. Pass each array element in its own indexed column (optionValueCategories[0], optionValueCategories[1], and so on). | array | No |
optionValueCategories[0] | Array element | mixed | No | |
optionValueCategories[0].uuid | UUID of the resource that can be expressed using a value as defined in its types. | string | No | |
optionValueCategories[0].externalId | External ID of the resource that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
optionValueCategories[0].localizedData | A collection of Localizations of the option value category that can be expressed using “SET_AS_NULL” (to reset all existing values) or a value as defined in its types. | Not a CSV column header. Pass each array element in its own indexed column (optionValueCategories[0].localizedData[0], optionValueCategories[0].localizedData[1], and so on). | array | No |
optionValueCategories[0].localizedData[0] | Array element | mixed | No | |
optionValueCategories[0].localizedData[0].languageCode | Language code of localization that can be expressed using a value as defined in its types. | string | Yes | |
optionValueCategories[0].localizedData[0].name | Localized option value category name that can be expressed using a value as defined in its types. | string | No | |
optionValueCategories[0].parentCategory | UUID or external ID of a parent option value category that can be expressed using “SET_AS_NULL” (to reset the existing value) or a structure of {“uuid”: “string”, “externalId”: “string”} (to provide a more expressive identifier) or a value as defined in its types. | string | No | |
optionValueCategories[0].parentCategory.uuid | UUID of the resource | string | No | |
optionValueCategories[0].parentCategory.externalId | External ID of the resource | string | No |
Sample CSV
See the following optionValues CSV sample file.
Note: The sample CSV may contain sample ID fields which reference other resources that do not match the data in your environment. You may omit any non-required fields from the sample CSV, reference the table above for required fields.