Connect Secure icon

Connect Secure

Consume Connect Secure API

Actions222

Overview

This node operation, Retrieve Asset Processes Running, is designed to fetch information about currently running processes related to assets from an external system via its API. It allows users to query and filter asset process data dynamically, which can be useful for monitoring, auditing, or managing asset workflows in real-time.

Common scenarios where this node is beneficial:

  • Monitoring active processes on specific assets to track their status.
  • Retrieving filtered lists of running asset processes based on custom conditions.
  • Paginating through large sets of running processes using skip and limit parameters.
  • Sorting the results by specified fields to prioritize or organize output.

Practical example:
A user wants to get a list of all running processes for assets that meet certain criteria (e.g., processes started after a specific date) and only retrieve the first 50 records sorted by start time. This node operation enables such queries with flexible filtering, pagination, and ordering.

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 running asset processes (e.g., SQL-like or API-specific query syntax).
Skip Number of records to skip in the result set, used for pagination.
Limit Maximum number of records to return, used to limit the size of the response.
Order By Field(s) by which to order the returned results (e.g., "startTime desc").

Output

The node outputs JSON data representing the list of running asset processes retrieved from the API. The structure typically includes details about each process such as process ID, status, start time, associated asset information, and other metadata depending on the API's response schema.

If the API supports binary data for any part of the response (not indicated here), it would be included accordingly, but this operation primarily deals with JSON data.

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to access the external Connect Secure API.
  • The node depends on the external Connect Secure API endpoint that provides asset process information.
  • Proper network connectivity and permissions to call the API are necessary.

Troubleshooting

  • Missing or invalid X USER ID: The API may reject requests without a valid user ID header. Ensure the "X USER ID" property is correctly set.
  • Invalid query condition syntax: If the "Condition" parameter is malformed or unsupported by the API, the request may fail or return no results. Validate the query syntax according to the API documentation.
  • Pagination issues: Setting "Skip" or "Limit" incorrectly (e.g., negative numbers) might cause errors or unexpected results.
  • API authentication errors: Ensure the API key or authentication token is valid and has sufficient permissions.
  • Network or connectivity problems: Verify that the n8n instance can reach the external API endpoint.

Links and References

  • Refer to the official Connect Secure API documentation for detailed information on query syntax, available fields, and authentication requirements.
  • n8n documentation on how to configure API credentials and use HTTP request nodes for custom integrations.

Discussion