Connect Secure icon

Connect Secure

Consume Connect Secure API

Actions222

Overview

This node operation, Retrieve Asset Compliance Report Card, is designed to fetch compliance report card data related to assets from an external API. It allows users to query asset compliance information with customizable filtering, pagination, and sorting options. This can be particularly useful in scenarios where organizations need to monitor asset compliance status, generate reports for audits, or integrate compliance data into workflows for further processing or alerting.

Practical examples include:

  • Retrieving a filtered list of asset compliance records based on specific conditions.
  • Paginating through large sets of compliance data by skipping and limiting the number of records returned.
  • Sorting the compliance report cards by specified fields to prioritize or organize the output.

Properties

Name Meaning
X USER ID User identifier required for authentication or tracking purposes; sent as a request header X-USER-ID.
Condition Query condition string to filter the compliance report cards based on specific criteria.
Skip Number of records to skip, used for pagination to offset the starting point of results.
Limit Maximum number of records to return, controlling the size of the result set.
Order By Field(s) by which to order the results, allowing sorting of the compliance report cards.

Output

The node outputs JSON data representing the retrieved asset compliance report cards. Each item in the output corresponds to a compliance record matching the query parameters. The structure typically includes details about the asset's compliance status, relevant metadata, and any other fields provided by the API response.

If binary data were involved (e.g., file attachments), it would be included in a separate binary property, but this operation focuses on JSON data retrieval only.

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to authorize requests to the Connect Secure API.
  • Depends on the external Connect Secure API endpoint that provides asset compliance report card data.
  • No additional environment variables are explicitly required beyond standard API authentication setup.

Troubleshooting

  • Missing or invalid X USER ID: Since the user ID is sent as a header and marked required, omitting it or providing an incorrect value will likely cause authentication or authorization errors. Ensure the correct user ID is supplied.
  • Invalid query conditions: Malformed or unsupported query strings in the "Condition" property may lead to API errors or empty results. Validate the syntax and semantics of the query condition.
  • Pagination issues: Setting "Skip" or "Limit" to inappropriate values (e.g., negative numbers) might cause unexpected behavior or errors. Use non-negative integers.
  • Ordering errors: Specifying invalid fields in "Order By" could result in API errors or default ordering. Confirm valid sortable fields with the API documentation.
  • API connectivity problems: Network issues or incorrect API credentials will prevent successful data retrieval. Verify network access and credential correctness.

Links and References

Discussion