ExtractDefinition

An object that’s used to define and execute an extract request. This object doesn’t support all extract types. Use ExtractRequest to handle all extract request types.

Name	Data Type	Description
`Client`	ClientID object	Specifies the account ownership and context of an object.
`ConfigurationPage`	String	The page displayed so that the user can configure the parameters to use when executing a data extract.
`CorrelationID`	String	Identifies correlation of objects across several requests.
`CreatedDate`	DateTime	The date and time when the object was created.
`CustomerKey`	String	User-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object.
`ID`	Int	Read-only identifier for an object. Some objects use the ObjectID property as a unique ID.
`ModifiedDate`	DateTime	The date and time when the object was last modified.
`Name`	String	Name of the object or property.
`ObjectID`	String	System-controlled, read-only text string identifier for object.
`ObjectState`	String	Not used.
`Owner`	Owner object	Describes account ownership of subscriber in an on-your-behalf account.
`PackageKey`	String	Specifies the key associated with an extract package.
`Parameters`	Array of ExtractParameterDescription objects	Container for key value pairs of parameters for objects.
`PartnerKey`	String	Unique identifier provided by partner for an object. This property is accessible only via API.
`PartnerProperties`	Array of APIProperty objects	A collection of metadata supplied by the client and stored by the system. These properties are accessible only via API.
`Values`	Array of APIProperty objects	Specifies values associated with an extract definition.