Catalogs (Partial Update)
Description
Creates or updates a catalog identified by the uuid or externalId in the request body.
If the identifier matches an existing catalog, it is updated. If not, a new catalog 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_catalogs_partialupdate_2026-04_<optionalSuffix>.csv
importType:partialupdateapiVersion:2026-04
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 | |
disabled | Defines if catalog is enabled or disabled that can be expressed using a value as defined in its types. | boolean | No | |
localizedData | A collection of Localizations of the catalog 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 code of localization that can be expressed using a value as defined in its types. | string | Yes | |
localizedData[0].name | Localized catalog name that can be expressed using a value as defined in its types. | string | No | |
localizedData[0].description | Localized catalog description that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
categories | A collection of categories that can be expressed using “SET_AS_NULL” (to reset all existing values), uuids or external ids. | array | No | |
categories[0] | Array element | mixed | No | |
rootCategories | A collection of rootCategories that can be expressed using “SET_AS_NULL” (to reset all existing values), uuids or expanded objects of the accepted type. | array | No | |
rootCategories[0] | Array element | mixed | No | |
rootCategories[0].category | UUID or external ID of a Category used as a root category that can be expressed using a structure of {“uuid”: “string”, “externalId”: “string”} (to provide a more expressive identifier) or a value as defined in its types. | string | No | |
rootCategories[0].category.uuid | UUID of the resource | array | No | |
rootCategories[0].category.uuid[0] | Array element | string | No | |
rootCategories[0].category.externalId | External ID of the resource | array | No | |
rootCategories[0].category.externalId[0] | Array element | string | No | |
rootCategories[0].sortOrder | Sort order used when sorting against other root categories that can be expressed using a value as defined in its types. | integer | No |
Sample CSV
See the following catalogs 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.