AvantGuard - ConnectSecure icon

AvantGuard - ConnectSecure

AvantGuard - ConnectSecure
Join our community

Actions223

Overview

This node interacts with a compliance-related API to retrieve records based on specified criteria. It is designed to fetch compliance data filtered by asset and company identifiers, along with optional query parameters for more refined control such as conditions, pagination, and sorting.

Typical use cases include:

  • Fetching compliance records for a specific asset within a company.
  • Retrieving paginated compliance data with custom filtering conditions.
  • Sorting compliance records according to specific fields.

For example, a user might want to get all compliance records related to a particular asset in their organization, skip the first 10 records, limit the results to 50, and order them by date.

Properties

Name Meaning
Asset Id The unique identifier of the asset for which compliance records are requested (number).
Company Id The unique identifier of the company owning the asset (number).
X USER ID User identifier sent as a header to authenticate or track the request (string).
Additional Query Parameters Optional parameters to refine the query:
- Condition A string representing query conditions or filters to apply.
- Skip Number of records to skip (for pagination).
- Limit Maximum number of records to return.
- Order By Field(s) by which to order the returned records.

Output

The node outputs JSON data containing the retrieved compliance records matching the query parameters. Each item in the output corresponds to a compliance record with its associated fields as returned by the API.

If the API supports binary data, it is not indicated here; thus, the output is expected to be purely JSON structured data representing compliance information.

Dependencies

  • Requires an API key credential for authentication with the AvantGuard ConnectSecure service.
  • Needs the base URL of the API configured in credentials.
  • Relies on the @avantguardllc/n8n-openapi-node package for building properties and handling requests.
  • The node sends HTTP requests with appropriate headers including X-USER-ID.

Troubleshooting

  • Missing Required Fields: Ensure that Asset Id, Company Id, and X USER ID are provided; otherwise, the API call will fail.
  • Authentication Errors: Verify that the API key credential is correctly set up and has necessary permissions.
  • Invalid Query Parameters: Incorrect values in additional query parameters like condition or order_by may cause the API to reject the request.
  • Pagination Issues: Setting skip or limit incorrectly could result in empty responses or incomplete data.
  • Network or API Endpoint Issues: Confirm the base URL is correct and the API service is reachable.

Links and References

Discussion