Using the Marketo Retrieve All Objects Activity

Use the Retrieve All Objects activity to fetch details of object from Marketo.

About this task

Use this task to retrieve all object details in the Marketo 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

  1. In an active orchestration, open the Activities tab and expand the Marketo folder contents.
  2. Drag the Retrieve All Objects activity icon onto the orchestration. Select the activity. The Marketo Retrieve All Objects Checklist is displayed.
  3. In the checklist, click Summary.
  4. Review the contents of the Activity Name field, and make the required changes.
  5. In the checklist, click Pick Endpoint.
  6. Click Browse and use the Project Explorer dialog box to select the relevant Marketo endpoint.
  7. Optional: You can create the endpoint by clicking New and specifying the required connection details. Click OK to save and use the endpoint for this configuration.
  8. To make required changes to the selected endpoint configuration, click Edit to access the options in a separate window. Any changes you make globally affects all uses of the endpoint in active orchestrations.
  9. In the checklist, click Configure.
  10. Click Browse to select the object type. The Browse Marketo window is displayed.
  11. In the Browse Marketo window, you can select the object type from the object type list. Click OK.
  12. In the Checklist, click Retry. Review the default settings and make the required changes.

    The next two points (step 13 and 14) is not applicable for Activity Type Object as no input is required for this activity.

  13. Select the Map Inputs in the Checklist. The XML Schemas generated from the selected object of the Retrieve All Objects activity are displayed as nodes under the request input parameter in the To Activity panel.
  14. Create a map between the orchestration variables and the input parameter of the activity.
    Note: Values must be provided at run time for any mandatory elements of the input structure. A value can be provided by specifying a default value for element or by linking the element with an input node. During run time if no value is provided for a mandatory element, the activity throws an exception, which is reported by the Web Management Console. If a value is not provided at run time for an optional input parameter, no exception is thrown during run time.
  15. Select the Map Outputs in the Checklist. The XML Schema generated to hold the response of the activity is displayed as nodes under the response output parameter in the From Activity panel.
  16. Create a map between the output parameters and orchestration variables.
    Table 1. Mandatory Fields
    Object Name Field Description
    Folder Content FolderId Is mandatory
    Lead Object
    • retrieveBy
    • id
    • Possible values of retrieveBy are ListId and ProgramId
    • Value of ID will be ID of List or ID of Program whose leads details are required
    Lead Activity
    • ActivityTypeId
    • nextPageToken
    • Get Paging Token atomic activity can be used to get the value of nextPageToken.
    • Multiple activityTypeId can be provided in one request as it is unbounded.
    Segments SegmentationId Is mandatory
    Table 2. Common Parameters
    Object Name Field
    offset Where to begin when retrieving entries. Can be use used in conjunction with maxReturn parameter to page through large result sets. Default: 0
    maxReturn Max number of entities to be returned. Default: 20. Maximum: 200.
    batchSize The number of records to be returned in a single call (default and max depends on Marketo API. currently its 300)
    nextPageToken Used to paginate through large result sets

Results

You have configured the Marketo Retrieve All Objects activity.



Feedback | Notices


Timestamp icon Last updated: Tuesday, 27 September 2016


http://pic.dhe.ibm.com/infocenter/wci/v7r0m0/topic/com.ibm.wci.doc/Marketo_retrieve_all_objects_activity.html