Use the Retrieve Objects activity to fetch the details of a Contact and Organisation from
Insightly.
About this task
Use this task to retrieve all objects based on ID in the Insightly 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
- Right click the Orchestrations section and select new orchestration.
- Drag the newly created Insightly endpoint to the orchestration and select Retrieve
Objects activity. The Retrieve Objects activity will be added to the orchestration.
Select the activity. The Insightly Retrieve Objects Checklist is
displayed.
- In the Checklist, click Configure.
- Click Browse to select the object type. The Browse Insightly window is displayed.
- In Browse Insightly, you can select the object type from the object type
list. Click OK.
- Select the Map Inputs in the Checklist. The XML
Schemas generated from the selected object of the Retrieve Objects activity
are displayed as nodes under the request input parameter in the To Activity
panel.
- In the Checklist, click Retry. Review the default settings and make the
required changes.
- 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.
- 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.
- Create a map between the output parameters and orchestration variables.
Results
You have configured the Insightly Retrieve Objects activity.
Note: You can add more than one object as input to this activity. To add more than one object as input,
right click the object in the To Activity pane of Map Inputs, and select Expand Occurrences. Only
multiple objects of the same type are supported.