OptionValues (Partial Update)
Description
See the Aerial Spec for more details.
File Naming Convention
TGEN_optionValues_partialupdate_2025-12_<optionalSuffix>.csv
importType:partialupdateapiVersion:2025-12
Columns
| 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 | array | No | |
type.uuid[0] | Array element | string | No | |
type.externalId | External ID of the resource | array | No | |
type.externalId[0] | Array element | 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. | array | No | |
localizedData[0] | Array element | mixed | No | |
localizedData[0].languageCode | Language this localization pertains to, follows a pattern of 2 letters and can then have multiple other groups of 2 letters or more. Each block separated by an hyphen. | Pattern: ^[a-z]{2}(-[a-z]{2,})*$ | 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. | 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. | array | No | |
optionValueCategories[0].localizedData[0] | Array element | mixed | No | |
optionValueCategories[0].localizedData[0].languageCode | Language this localization pertains to, follows a pattern of 2 letters and can then have multiple other groups of 2 letters or more. Each block separated by an hyphen. | Pattern: ^[a-z]{2}(-[a-z]{2,})*$ | 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 | array | No | |
optionValueCategories[0].parentCategory.uuid[0] | Array element | string | No | |
optionValueCategories[0].parentCategory.externalId | External ID of the resource | array | No | |
optionValueCategories[0].parentCategory.externalId[0] | Array element | 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.