Using the Insightly Retrieve All Objects Activity

Use the Retrieve All Objects activity to fetch the details of objects from Insightly.

About this task

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

  1. Right click the Orchestrations section and select new orchestration.
  2. Drag the newly created Insightly endpoint to the orchestration and select Retrieve All Objects activity. The Retrieve All Objects activity will be added to the orchestration. Select the activity. The Insightly Retrieve All Objects Checklist is displayed.
  3. In the Checklist, click Configure.
  4. Click Browse to select the object type. The Browse Insightly window is displayed.
  5. In Browse Insightly, you can select the object type from the object type list. Click OK.
  6. 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.
  7. In the Checklist, click Retry. Review the default settings and make the required changes.
  8. 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.
  9. 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.
  10. Create a map between the output parameters and orchestration variables.

    Query Parameter

    Below are the query parameters of the Retrieve All objects:

    Table 1. Common Query parameters for all the Retrieve All Objects
    Field Name Description
    top (n) To fetch just the top n number of records.
    skip (n) To skip the first n number of records and fetch the rest of records.
    filter To fetch specific record/records based on the parameters: field_name, operator and value.
    field_name The standard field name to be used in the filter should be specified.
    operator The operator to be applied. (For e.g., the valid operators are eq, ne, gt, lt etc.)
    value The value for the field based on which result will be displayed.
    orderby The response can be displayed in ascending or descending order by defining field name and order.
    field_name The standard field name to be used to display the fields in order.
    order The order are ASC and DESC.

Results

You have configured the Insightly Retrieve All 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.




Feedback | Notices


Timestamp icon Last updated: Tuesday, 27 September 2016


https://www.ibm.com/support/knowledgecenter/en/SS3LC4_7.5.3/com.ibm.wci.doc/Insightly_retrieve_all_objects_activity.html