Using the Eloqua ReST API Retrieve activity
Use the Retrieve activity to retrieve an Account, Campaign, Contact, Contact List, Contact Segment and Custom Object Data in Eloqua.
About this task
Use this task to retrieve all objects based on ID in the Eloqua REST instance. The call to this activity is a synchronous call where the input data is sent to the activity for processing and the response is sent back to the orchestration.
Procedure
Input XML
In the input XML of the Eloqua REST Retrieve Object, two options are provided to the user:
- RetrieveAll - It is a Boolean field. If the user wants to fetch all the records of a particular object type, then he should set this parameter as true.
- ID - If the user sets the RetrieveAll value as
false, then the user must specify the ID of the record to be fetched. This ID is
passed in the ID field. The user can provide multiple IDs to be fetched.Note: RetrieveAll and ID are not applicable for Custom object retrieve. If the user wants to fetch custom object then he/she should provide value in at least one of the searchURL parameters.
Field Name | Description |
---|---|
depth | The REST API can retrieve entities at three different levels of depth "Complete", "Minimal", and "Partial". |
count | Maximum number of entities to return. The value can be any whole number between 1 and 1000. |
page | Specifies which page of entities to return, and can be any positive whole number. The Count parameter determines the size (number of results) per page. |
orderBy | Specifies the name of the property to order the results by, The orderBy format is ASC | DESC. |
lastUpdatedAt | Filter the result based on the lastUpdatedAt value. |
id | Identifier for the entity on which to perform the operation. This value is actually part of the base URL, and not a URL parameter. |
Search | Specifies the search criteria used to retrieve entities. |
viewId | Filter the result based on the viewId value. |
Results
Note:
You can add more than one object as input to this activity. To add more than one object as input, right click the ID field in the object in the To Activity pane of Map Inputs, and select Expand Occurrences.