Octave icon

Octave

Interact with the Octave V2 API

Actions26

Overview

This node interacts with the Octave V2 API to list products based on various filtering and pagination options. It is useful for scenarios where you need to retrieve product data from Octave, such as integrating product catalogs into workflows, syncing product information, or performing searches within product datasets.

Practical examples include:

  • Fetching all products available in an account.
  • Retrieving a limited number of products with pagination support.
  • Searching products by text query.
  • Filtering products by ownership scope (all, team, or only those owned by the authenticated user).
  • Filtering by a specific product identifier.

Properties

Name Meaning
Return All Whether to return all results or only up to a given limit.
Limit Max number of results to return (used if "Return All" is false).
Offset Offset of the results to return, used for pagination.
Text Search Text search query string to filter products by matching text.
Query Type Type of query to perform:
- All: Retrieve all products.
- Team: Products belonging to the team.
- Mine: Products owned by the authenticated user.
Product OID (Filter) Filter list by a specific Product OId (optional).

Output

The node outputs an array of JSON objects representing products retrieved from the Octave API. Each object corresponds to a product and contains its details as returned by the API.

If binary data were involved, it would be summarized here, but this operation deals solely with JSON product data.

Dependencies

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

Troubleshooting

  • Common issues:

    • Authentication failures due to invalid or missing API keys.
    • API rate limits or quota exceeded errors.
    • Invalid parameter values, e.g., negative offsets or limits outside allowed ranges.
    • Network connectivity problems preventing access to the Octave API.

  • Error messages:

    • Errors returned from the API will be captured and included in the output if "Continue On Fail" is enabled.
    • Parsing errors may occur if the API response body is malformed; these are reported with a parse error message.

  • Resolutions:

    • Verify that the API key credential is correctly set up and has necessary permissions.
    • Adjust limits and offsets to valid values.
    • Check network connectivity and API endpoint availability.
    • Enable "Continue On Fail" to handle partial failures gracefully.

Links and References

Discussion