The Salesforce Developers website will undergo maintenance on May 29, 2024 from 3:00 a.m. UTC to 10:00 a.m. UTC. The maintenance process may affect the availability of our documentation. Please plan accordingly.

ExtractDefinition

The ExtractDefinition object provides means to define and execute an extract request. This object does not support all extract types. Use ExtractRequest to handle all extract requests whenever possible.

NameData TypeDescription
ClientClientIDSpecifies the account ownership and context of an object.
ConfigurationPagexsdThe page displayed so that the user can configure the parameters to use when executing a data extract.
CorrelationIDxsdIdentifies correlation of objects across several requests.
CreatedDatexsdRead-only date and time of the object's creation.
CustomerKeyxsdUser-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object.
IDxsdRead-only identifier for an object. Some objects use the ObjectID property as a unique ID.
ModifiedDateNullable`1Indicates the last time object information was modified.
NamexsdName of the object or property.
ObjectIDxsdSystem-controlled, read-only text string identifier for object.
ObjectStatexsdReserved for future use.
OwnerOwnerDescribes account ownership of subscriber in an on-your-behalf account.
PackageKeyxsdSpecifies the key associated with an extract package.
ParametersExtractParameterDescription[]Container for key value pairs of parameters for objects.
PartnerKeyxsdUnique identifier provided by partner for an object. This property is accessible only via API.
PartnerPropertiesAPIProperty[]A collection of metadata supplied by the client and stored by the system. These properties are accessible only via API.
ValuesAPIProperty[]Specifies values associated with an extract definition.