Connect Secure icon

Connect Secure

Consume Connect Secure API

Actions222

Overview

This node interacts with the Connect Secure API to retrieve asset-related service data. Specifically, for the "Asset" resource and the "Retrieve Asset Services" operation, it fetches a list of asset services based on user-defined query parameters such as filtering conditions, pagination controls, and sorting preferences.

Common scenarios where this node is beneficial include:

  • Fetching a filtered list of asset services for reporting or monitoring.
  • Integrating asset service data into workflows that require dynamic querying.
  • Automating asset service retrieval with specific conditions and limits.

For example, a user might want to retrieve all asset services related to a particular user ID, skip the first 10 records, limit the results to 50, and order them by creation date.

Properties

Name Meaning
X USER ID User Id header value required for authentication or identification in the API request.
Condition Query condition string to filter the asset services returned by the API.
Skip Number of records to skip (offset) in the result set for pagination purposes.
Limit Maximum number of records to return from the API call.
Order By Field name(s) to order the results by, controlling the sort order of the returned data.

Output

The node outputs JSON data representing the retrieved asset services. The structure corresponds to the API response for asset services, typically an array of objects each describing an individual asset service with its properties.

If the API supports binary data for asset services (not indicated here), the node would also handle binary output accordingly, but based on the provided code and properties, the output is purely JSON.

Dependencies

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

Troubleshooting

  • Missing or invalid X USER ID: The API requires the X USER ID header; ensure it is provided and correct.
  • Invalid query parameters: Incorrect syntax in the Condition, or invalid values for Skip, Limit, or Order By may cause API errors.
  • API connectivity issues: Network problems or incorrect API credentials will prevent successful data retrieval.
  • Empty results: If no asset services match the query condition, the output will be empty; verify the condition string.

Links and References

Discussion