Connect Secure icon

Connect Secure

Consume Connect Secure API

Actions222

Overview

This node operation, Retrieve Job Details, is designed to fetch detailed information about jobs from the Connect Secure API. It allows users to query job records with various filtering and pagination options, making it useful for workflows that need to monitor, audit, or process job-related data programmatically.

Common scenarios:

  • Retrieving a list of jobs matching specific conditions for reporting or analysis.
  • Paginating through large sets of job records by skipping and limiting results.
  • Sorting job details based on specified fields.
  • Integrating job status or metadata into automated workflows.

Practical example:
A user wants to retrieve all jobs created by a particular user (identified by their User ID), filter them by a certain condition (e.g., jobs in "completed" status), skip the first 10 records, limit the output to 20 jobs, and order the results by creation date.

Properties

Name Meaning
X USER ID The User ID header value required to authenticate or identify the user making the request.
Condition A query string to filter jobs based on specific criteria (e.g., status, type).
Skip Number of job records to skip, useful for pagination.
Limit Maximum number of job records to return.
Order By Field name(s) to sort the returned job records by (e.g., creation date, priority).

Output

The node outputs JSON data containing the retrieved job details as returned by the Connect Secure API. Each item in the output corresponds to a job record matching the query parameters.

  • The json field contains an array of job objects with their respective properties.
  • No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Connect Secure API.
  • The node depends on the Connect Secure API being accessible and properly configured.
  • No additional environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

  • Missing or invalid User ID: The operation requires the X USER ID header; omitting or providing an incorrect value may cause authentication errors.
  • Invalid query parameters: Incorrectly formatted condition, skip, limit, or order_by values might result in API errors or empty responses.
  • API connectivity issues: Network problems or misconfigured credentials can lead to failed requests.
  • Pagination mistakes: Setting skip or limit improperly could cause unexpected subsets of data or no data returned.

To resolve these:

  • Ensure the X USER ID is correctly set and valid.
  • Validate query parameter formats according to the API documentation.
  • Check network connectivity and API key validity.
  • Use sensible values for pagination parameters.

Links and References

Discussion