Categories (Partial Update)
Description
Partially update resource
See the Aerial Spec for more details.
File Naming Convention
TGEN_categories_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 | |
status | Defines the status of the category that can be expressed using a value as defined in its types. | Allowed: disabled, enabled | string | No |
image | Image for this category that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
isHidden | Defines if this category should be hidden or visible that can be expressed using a value as defined in its types. | boolean | No | |
sortOrder | Sort order of the category against other sibling categories that can be expressed using a value as defined in its types. | integer | No | |
localizedData | A collection of Localizations of the category 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 category name that can be expressed using a value as defined in its types. | string | No | |
localizedData[0].description | Localized category description that can be expressed using a value as defined in its types. | string | No | |
attributes | A collection of Attributes of the category that can be expressed using “SET_AS_NULL” (to reset all existing values) or a value as defined in its types. | array | No | |
attributes[0] | Array element | mixed | No | |
attributes[0].name | Name of the attribute | string | Yes | |
attributes[0].languageExternalId | 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 | No |
attributes[0].value | Value of the attribute, this will be any type casted to string but supports all basic types that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
childCategories | A collection of childCategories that can be expressed using “SET_AS_NULL” (to reset all existing values), uuids or expanded objects of the accepted type. | array | No | |
childCategories[0] | Array element | mixed | No | |
childCategories[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 | |
childCategories[0].status | Defines the status of the category that can be expressed using a value as defined in its types. | Allowed: disabled, enabled | string | No |
childCategories[0].image | Image for this category that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
childCategories[0].isHidden | Defines if this category should be hidden or visible that can be expressed using a value as defined in its types. | boolean | No | |
childCategories[0].sortOrder | Sort order of the category against other sibling categories that can be expressed using a value as defined in its types. | integer | No | |
childCategories[0].localizedData | A collection of Localizations of the category that can be expressed using “SET_AS_NULL” (to reset all existing values) or a value as defined in its types. | array | No | |
childCategories[0].localizedData[0] | Array element | mixed | No | |
childCategories[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 |
childCategories[0].localizedData[0].name | Localized category name that can be expressed using a value as defined in its types. | string | No | |
childCategories[0].localizedData[0].description | Localized category description that can be expressed using a value as defined in its types. | string | No | |
childCategories[0].attributes | A collection of Attributes of the category that can be expressed using “SET_AS_NULL” (to reset all existing values) or a value as defined in its types. | array | No | |
childCategories[0].attributes[0] | Array element | mixed | No | |
childCategories[0].attributes[0].name | Name of the attribute | string | Yes | |
childCategories[0].attributes[0].languageExternalId | 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 | No |
childCategories[0].attributes[0].value | Value of the attribute, this will be any type casted to string but supports all basic types that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
childCategories[0].childCategories | A collection of childCategories that can be expressed using “SET_AS_NULL” (to reset all existing values), uuids or expanded objects of the accepted type. | array | No | |
childCategories[0].childCategories[0] | Array element | mixed | No | |
childCategories[0].childCategories[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 | |
childCategories[0].childCategories[0].status | Defines the status of the category that can be expressed using a value as defined in its types. | Allowed: disabled, enabled | string | No |
childCategories[0].childCategories[0].image | Image for this category that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
childCategories[0].childCategories[0].isHidden | Defines if this category should be hidden or visible that can be expressed using a value as defined in its types. | boolean | No | |
childCategories[0].childCategories[0].sortOrder | Sort order of the category against other sibling categories that can be expressed using a value as defined in its types. | integer | No | |
childCategories[0].childCategories[0].localizedData | A collection of Localizations of the category that can be expressed using “SET_AS_NULL” (to reset all existing values) or a value as defined in its types. | array | No | |
childCategories[0].childCategories[0].localizedData[0] | Array element | mixed | No | |
childCategories[0].childCategories[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 |
childCategories[0].childCategories[0].localizedData[0].name | Localized category name that can be expressed using a value as defined in its types. | string | No | |
childCategories[0].childCategories[0].localizedData[0].description | Localized category description that can be expressed using a value as defined in its types. | string | No | |
childCategories[0].childCategories[0].attributes | A collection of Attributes of the category that can be expressed using “SET_AS_NULL” (to reset all existing values) or a value as defined in its types. | array | No | |
childCategories[0].childCategories[0].attributes[0] | Array element | mixed | No | |
childCategories[0].childCategories[0].attributes[0].name | Name of the attribute | string | Yes | |
childCategories[0].childCategories[0].attributes[0].languageExternalId | 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 | No |
childCategories[0].childCategories[0].attributes[0].value | Value of the attribute, this will be any type casted to string but supports all basic types that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
childCategories[0].childCategories[0].childCategories | A collection of childCategories that can be expressed using “SET_AS_NULL” (to reset all existing values), uuids or expanded objects of the accepted type. | array | No | |
childCategories[0].childCategories[0].childCategories[0] | Array element | mixed | No | |
childCategories[0].childCategories[0].childCategories[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 | |
childCategories[0].childCategories[0].childCategories[0].status | Defines the status of the category that can be expressed using a value as defined in its types. | Allowed: disabled, enabled | string | No |
childCategories[0].childCategories[0].childCategories[0].image | Image for this category that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
childCategories[0].childCategories[0].childCategories[0].isHidden | Defines if this category should be hidden or visible that can be expressed using a value as defined in its types. | boolean | No | |
childCategories[0].childCategories[0].childCategories[0].sortOrder | Sort order of the category against other sibling categories that can be expressed using a value as defined in its types. | integer | No | |
childCategories[0].childCategories[0].childCategories[0].localizedData | A collection of Localizations of the category that can be expressed using “SET_AS_NULL” (to reset all existing values) or a value as defined in its types. | array | No | |
childCategories[0].childCategories[0].childCategories[0].localizedData[0] | Array element | mixed | No | |
childCategories[0].childCategories[0].childCategories[0].attributes | A collection of Attributes of the category that can be expressed using “SET_AS_NULL” (to reset all existing values) or a value as defined in its types. | array | No | |
childCategories[0].childCategories[0].childCategories[0].attributes[0] | Array element | mixed | No | |
childCategories[0].childCategories[0].childCategories[0].childCategories | A collection of childCategories that can be expressed using “SET_AS_NULL” (to reset all existing values), uuids or expanded objects of the accepted type. | array | No | |
childCategories[0].childCategories[0].childCategories[0].childCategories[0] | Array element | mixed | No |
Sample CSV
See the following categories CSV sample file.