AvantGuard - ConnectSecure icon

AvantGuard - ConnectSecure

AvantGuard - ConnectSecure

Actions223

Overview

This node interacts with the "Company" resource to retrieve a view of jobs using the "Get Retrieve Jobs View" operation. It is designed to fetch job-related data from an external service, allowing users to specify filtering, pagination, and sorting options through query parameters.

Common scenarios where this node is beneficial include:

  • Fetching a filtered list of job postings or job views for a specific user.
  • Retrieving paginated job data to display in dashboards or reports.
  • Sorting job listings based on certain criteria such as date or relevance.

For example, a user might want to get all active jobs assigned to them, skip the first 10 records, limit the results to 20, and order them by creation date.

Properties

Name Meaning
X USER ID User Id (string). This header identifies the user making the request.
Additional Query Parameters Optional query parameters that can be added to customize the request:
- Condition (string): Query condition to filter the jobs.
- Skip (number): Number of records to skip (for pagination).
- Limit (number): Maximum number of records to return.
- Order By (string): Field name(s) to order the results by.

Output

The node outputs JSON data representing the retrieved jobs view. The structure of the json output field corresponds to the response from the external API and typically includes details about each job record matching the query parameters.

If the external API supports binary data for jobs (e.g., attachments), it would be included in the binary output; however, based on the provided code and properties, this node primarily returns JSON data.

Dependencies

  • Requires an API key credential for authentication with the external service.
  • The base URL for the API must be configured in the node credentials.
  • The node uses HTTP headers and query parameters to communicate with the API endpoint.

Troubleshooting

  • Missing or invalid X USER ID: Since the X USER ID header is required, omitting it or providing an incorrect value will likely cause authentication or authorization errors. Ensure the correct user ID is supplied.
  • Invalid query parameters: Providing unsupported or malformed query conditions may result in API errors or empty responses. Validate query syntax and parameter types.
  • API connectivity issues: Network problems or incorrect base URL configuration can cause request failures. Verify network access and credential settings.
  • Pagination misconfiguration: Setting skip or limit to inappropriate values (e.g., negative numbers) may lead to unexpected results or errors.

Links and References

  • Refer to the external API documentation for detailed information on the "Company" resource and the "Get Retrieve Jobs View" operation, including supported query parameters and response schema.
  • n8n documentation on creating and configuring HTTP request nodes and handling API credentials.

Discussion