AvantGuard - ConnectSecure icon

AvantGuard - ConnectSecure

AvantGuard - ConnectSecure

Actions223

Overview

This node operation, "Get Retrieve Scheduler," is designed to fetch scheduler data from an external service. It allows users to retrieve scheduler records with optional filtering, pagination, and sorting capabilities. This is useful in scenarios where you need to programmatically access scheduled tasks or events managed by the connected system, for example, to monitor upcoming jobs, audit schedules, or integrate scheduling information into workflows.

Practical examples include:

  • Retrieving all scheduled jobs for a specific user.
  • Fetching a limited number of scheduler entries sorted by creation date.
  • Applying query conditions to filter schedulers based on status or other criteria.

Properties

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

Output

The output of this node operation is JSON data representing the retrieved scheduler records. Each item in the output corresponds to a scheduler entry fetched according to the specified query parameters. The structure typically includes scheduler details such as IDs, timestamps, statuses, and any other metadata provided by the external API.

If the external service supports binary data related to schedulers (e.g., attached files or logs), the node would handle it accordingly, but based on the provided code and properties, the primary output is JSON-formatted scheduler data.

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to authorize requests to the external scheduler service.
  • The base URL for the API must be set in the node credentials.
  • The node depends on the external service's API endpoint that supports retrieving scheduler data with query parameters.

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 authorization errors or empty responses. Ensure the correct user ID is supplied.
  • Invalid query parameters: Providing malformed or unsupported query conditions may result in API errors or no data returned. Validate query syntax and parameter values.
  • API connectivity issues: Network problems or incorrect base URL configuration can lead to request failures. Verify network access and credential settings.
  • Empty results: If no scheduler records match the query, the output will be empty. Adjust filters or pagination parameters accordingly.

Links and References

  • Refer to the external scheduler service API documentation for detailed information on supported query parameters and response formats.
  • n8n documentation on HTTP Request nodes and custom node development for understanding how headers and query parameters are routed.

Discussion