OptionalautoThe type of datapack to export, this is used to determine the export definition to use and is also used as the folder name of the exported datapack.
OptionaldependentWhen true, the export of this object is dependent on the export of another object. This means that this object is only exported when it is referenced by another exported object and is not exported as a top level object in the datapack.
OptionalembeddedList of objects that should be embedded in this datapack. The key is the name under which embedded records are exported.
OptionalfieldsOptional object with specific export settings for fields in the object.
OptionalfilterWhere condition to filter the object data to export by.
Can be a string or an object. When an object, the key is the
field name and the value is the value to filter by. Accessing fields from the parent
datapack using bracket syntax {} is supported:
filter:
AccountId: $parent.Id
IsActive: true
When defined as a string, the string is used as the where condition and interpolated this allows for more complex where conditions:
filter: "AccountId = '{parent.Id}' AND IsActive = 'true'"
OptionalignoreList of fields to exclude from the export.
OptionallimitOptional maximum number of records to return when querying this object.
OptionalmatchingList of fields which uniquely identify the object and are used for matching the object when importing and for generating the external lookup reference.
Name format of the datapack, used to create the folder name of the datapack, when a filename is not set this is also used as the file name.
When this is a string the string is parsed as format and values between brackets are replace by field values from the object to export, i.e {Name}.
When this is defined as an array each value in the array is evaluated as a field value expression and constants need to be prixed with a _:
name:
- Name
- _constantValue
# OR
name: "{Name}_constantValue"
Type of SObject to which this filter applies
OptionalrelatedList of related objects that are exported as separate datapacks but are related to this object and should be included in the export.
When true the matching key is auto-generated random number instead of a value based on the object data. autogenerated matching keys only work for none-lookup fields.