SugarCRM icon

SugarCRM

Interact with SugarCRM API
Join our community

Actions40

Overview

This node interacts with the SugarCRM API to perform various operations on CRM resources, including the "Meter" resource. Specifically, the "Get Many" operation retrieves multiple Meter records from SugarCRM. It supports filtering and pagination through query parameters and can optionally send a JSON body with the request.

Common scenarios for this node include:

  • Fetching a list of Meter records for reporting or analysis.
  • Retrieving filtered subsets of Meters based on dynamic query parameters.
  • Integrating SugarCRM Meter data into workflows for automation or synchronization.

For example, you might use this node to get all Meter records related to a specific customer or within a certain date range by specifying appropriate query parameters.

Properties

Name Meaning
Send Query Parameters Whether to include query parameters in the request to filter or modify the results.
Specify Query Parameters How to specify query parameters: either using individual fields or as a raw JSON object.
Query Parameters A collection of name-value pairs representing individual query parameters (used if "Using Fields Below").
Query Parameters (JSON) Raw JSON object representing query parameters (used if "JSON" option is selected).
Send JSON Body Whether to send a JSON body with the GET request (uncommon but supported).
JSON Body The JSON body content to send with the request if enabled.
Return All Whether to return all matching records or limit the number of results.
Limit Maximum number of records to return if not returning all. Minimum value is 1.

Output

The output is an array of JSON objects, each representing a Meter record retrieved from SugarCRM. Each object contains the fields as returned by the SugarCRM API for the Meter resource.

If multiple records are returned, they are combined into a single output array. The node does not output binary data.

Example output structure (simplified):

[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "...": "other Meter fields"
  },
  ...
]

Dependencies

  • Requires an API key credential for SugarCRM with access to the REST API.
  • Needs the base URL and authentication credentials (username, password, client ID, client secret) configured in the node's credential settings.
  • Uses OAuth2 password grant flow to obtain an access token before making API requests.

Troubleshooting

  • No records found or unexpected API response structure: This error occurs if the API returns no records or the response format is not as expected. Check your query parameters and ensure the Meter resource has data matching your criteria.
  • Authentication errors: If the node fails to authenticate, verify that the API credentials are correct and have sufficient permissions.
  • Invalid JSON in query parameters or JSON body: When specifying JSON manually, ensure it is valid JSON syntax to avoid parsing errors.
  • Limit and Return All conflicts: If "Return All" is false but the limit is set too low, you may receive fewer records than expected.

Links and References

Discussion