Connect Secure icon

Connect Secure

Consume Connect Secure API

Actions222

Overview

This node operation, Retrieve Report Jobs View, is designed to fetch a list or view of report jobs from the Connect Secure API. It allows users to query report job data with flexible filtering, pagination, and sorting options. This is useful in scenarios where you need to monitor, audit, or analyze report generation jobs programmatically within an automation workflow.

Practical examples include:

  • Retrieving recent report jobs for a specific user.
  • Filtering report jobs based on custom conditions (e.g., status, date range).
  • Paginating through large sets of report jobs.
  • Sorting report jobs by creation date or other fields.

Properties

Name Meaning
X USER ID User Id header value to identify the user making the request.
Condition Query condition string to filter report jobs based on specific criteria.
Skip Number of records to skip for pagination purposes.
Limit Maximum number of records to return.
Order By Field(s) to order the results by, e.g., "createdAt desc" or "status asc".

Output

The node outputs JSON data representing the retrieved report jobs view. The structure typically includes an array of report job objects matching the query parameters. Each object contains details about individual report jobs such as job id, status, timestamps, and other metadata relevant to the report job.

If the API supports binary data for reports or attachments, this node would handle it accordingly, but based on the provided code and properties, the output focuses on JSON data describing report jobs.

Dependencies

  • Requires an API key credential for authenticating with the Connect Secure API.
  • The node depends on the Connect Secure API endpoint that provides report job views.
  • No additional external dependencies are indicated beyond the bundled OpenAPI client and lodash utility.

Troubleshooting

  • Missing or invalid X USER ID: The API requires a valid user ID header; ensure this is correctly set.
  • Invalid query condition syntax: If the condition string is malformed, the API may reject the request or return no results.
  • Pagination issues: Setting skip or limit incorrectly might result in empty responses or incomplete data.
  • Order By errors: Using unsupported fields in the order_by parameter can cause API errors.
  • Authentication failures: Ensure the API key credential is valid and has sufficient permissions.

Common error messages will likely relate to HTTP 4xx or 5xx responses indicating authentication failure, bad requests due to invalid parameters, or server errors. Checking the exact API response message will help diagnose these issues.

Links and References

  • Connect Secure API documentation (refer to your organization's API docs for detailed usage)
  • n8n documentation on creating and using custom nodes with OpenAPI integration
  • General REST API best practices for filtering, pagination, and sorting

Discussion