Connect Secure icon

Connect Secure

Consume Connect Secure API

Actions222

Overview

This node interacts with the "Connect Secure" API to retrieve information about asset shares. Specifically, the "Retrieve Asset Shares" operation fetches a list of shared assets based on user-defined query parameters such as filtering conditions, pagination controls, and sorting preferences.

Typical use cases include:

  • Fetching shared asset data for a specific user in an automated workflow.
  • Integrating asset sharing information into reporting or monitoring dashboards.
  • Filtering and retrieving subsets of asset shares based on custom conditions.

For example, a user might want to retrieve all asset shares where the asset type matches a certain category, skip the first 10 records, limit the results to 50, and order them by creation date.

Properties

Name Meaning
X USER ID The User ID header value identifying the user making the request.
Condition A query string to filter the asset shares based on specified conditions.
Skip Number of records to skip (for pagination).
Limit Maximum number of records to return.
Order By Field(s) by which to order the returned asset shares.

Output

The node outputs JSON data representing the retrieved asset shares. Each item in the output corresponds to an individual asset share record matching the query parameters.

If the API supports binary data related to asset shares (e.g., files or attachments), the node would handle it accordingly, but based on the provided code and properties, the output is primarily structured JSON data.

Dependencies

  • Requires an API key credential for authenticating with the Connect Secure API.
  • The node depends on the external Connect Secure service endpoint defined in its OpenAPI specification.
  • No additional environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

  • Missing or invalid User ID: Since the X USER ID header is mandatory, omitting it or providing an incorrect value will likely cause authentication or authorization errors.
  • Invalid query condition syntax: If the Condition parameter contains malformed queries, the API may return errors or empty results.
  • Pagination issues: Setting Skip or Limit to inappropriate values (e.g., negative numbers) could lead to unexpected behavior or errors.
  • Ordering errors: Providing invalid field names in Order By may result in API errors or default ordering.
  • API connectivity problems: Network issues or incorrect API credentials will prevent successful data retrieval.

To resolve these issues:

  • Ensure all required fields are correctly filled.
  • Validate query strings against the API's expected format.
  • Use sensible numeric values for pagination.
  • Confirm API credentials and network access.

Links and References

Discussion