Using the SugarCRM REST API Search activity

Use the SugarCRM REST API Search activity to search for objects from specified records. This activity searches for details based on a query.

About this task

Use this task to search for objects from specified records. 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 SugarCRM REST API folder contents.
  2. Drag the Search activity icon onto the orchestration. The SugarCRM REST API Search 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 SugarCRM REST API 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.
    Note: For more information, see Creating and editing a SugarCRM REST API endpoint.
  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. Select the Map Inputs in the Checklist. The XML Schemas generated from the selected object of the Search activity are displayed as nodes under the request input parameter in the To Activity panel.
  10. 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.
  11. 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.
  12. Create a map between the output parameters and orchestration variables.

Results

You have configured the SugarCRM REST API Search activity.



Feedback | Notices


Timestamp icon Last updated: Wednesday, 15 June 2016


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