AvantGuard - ConnectSecure icon

AvantGuard - ConnectSecure

AvantGuard - ConnectSecure

Actions223

Overview

This node operation "Get Retrieve Integration Rules" under the "Integration" resource is designed to fetch integration rules from an external service. It allows users to retrieve a list of integration rules with optional filtering, pagination, and sorting capabilities. This can be useful in scenarios where you need to programmatically access and manage integration rules for automation workflows, compliance checks, or system monitoring.

For example, a user might want to retrieve all integration rules that meet certain conditions, skip a number of records for pagination, limit the number of results returned, or order the results by a specific field.

Properties

Name Meaning
X USER ID User Id - a required string header used to identify the user making the request.
Additional Query Parameters Optional query parameters to refine the retrieval:
- Condition: Query condition to filter the integration rules.
- Skip: Number of records to skip (for pagination).
- Limit: Maximum number of records to return.
- Order By: Field name(s) to order the results by.

Output

The output of this node operation will be JSON data representing the retrieved integration rules. Each item in the output JSON array corresponds to an integration rule matching the query parameters provided.

If the node supports binary data output, it is not indicated in the provided code or properties, so the output is expected to be purely JSON structured data.

Dependencies

  • Requires an API key credential for authentication to the external service.
  • The base URL for the API must be configured in the node credentials.
  • The node sends HTTP requests with headers including X-USER-ID and expects JSON responses.

Troubleshooting

  • Missing or invalid X USER ID: Since the X USER ID header is required, omitting it or providing an incorrect value may result in authentication or authorization errors.
  • Invalid query parameters: Providing unsupported or malformed query parameters (e.g., non-numeric values for skip or limit) could cause the API to reject the request.
  • API connectivity issues: Network problems or incorrect base URL configuration can lead to request failures.
  • Empty results: If the condition filters are too restrictive, the response may contain no integration rules.

To resolve these issues:

  • Ensure the X USER ID is correctly set.
  • Validate query parameter types and values.
  • Verify network connectivity and correct API endpoint configuration.
  • Adjust query conditions to broaden the search if needed.

Links and References

  • No direct links were found in the source code. For more information, consult the API documentation of the external service providing the integration rules.

Discussion