RetrieveRequest

The RetrieveRequest object retrieves data from the system.

Properties

Name Data Type Description
ClientIDs Array of ClientID objects Specifies accounts and sub-accounts, including Enterprise 2.0, On-Your-Behalf, and Lock & Publish accounts, from which to retrieve data.
ContinueRequest String Represents the RequestID that identifies a previous Retrieve requestto continue processing (returns the next available batch of data for that request).
Filter FilterPart Specifies filter to apply to retrieve.
ObjectType String Specifies whether the object is a List, Subscriber, Email, or other type of object.
Options RetrieveOptions Options associated with a request. For a Configure call, options include CREATE or DELETE.
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.
Properties ArrayOfString Specifies an array of property definitions available for an object type. You can retrieve allowed properties using the Describe method.
QueryAllAccounts Boolean Queries all accounts, including parent and all children, regarding an event (ignores specified ClientIDs).
RepeatLastResult Boolean Used with RetrieveAllSinceLastBatch option to repeat returning a date-based request.
RespondTo Array of AsyncResponse objects Not used.
RetrieveAllSinceLastBatch Boolean Retrieve all data since last retrieve context. Works with added and modified data. You must include the same properties and filters as the previous request.
Retrieves Array of Request objects Not used.

Related Items