Octave icon

Octave

Interact with the Octave V2 API

Actions26

Overview

This node integrates with the Octave V2 API to perform various operations on different resources, including "Use Case". Specifically, the List Use Case operation retrieves a list of use cases from the Octave platform. It supports filtering, pagination, and text search, making it useful for scenarios where you want to fetch and process multiple use cases programmatically.

Practical examples include:

  • Fetching all use cases related to a specific product or playbook.
  • Retrieving only your own or your team's use cases.
  • Searching use cases by keywords to find relevant entries quickly.

Properties

Name Meaning
Return All Whether to return all results or limit the number of returned use cases.
Limit Maximum number of use cases to return (effective only if Return All is false).
Offset Number of use cases to skip before starting to collect the result set (for pagination).
Text Search A text query string to filter use cases by matching content.
Query Type Type of query to perform:
- All: Retrieve all use cases.
- Team: Use cases from your team.
- Mine: Only your use cases.
Product OID (Filter) Filter use cases by a specific Product OID (optional).
Playbook OID (Filter) Filter use cases by a specific Playbook OID (optional).

Output

The node outputs an array of JSON objects representing use cases retrieved from the Octave API. Each item corresponds to a use case with its associated data fields as provided by the API.

If the node supports binary data output (not indicated in the provided code or properties), it would typically represent attachments or files related to use cases, but this is not applicable here.

Dependencies

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

Troubleshooting

  • Common issues:

    • Authentication failures due to invalid or missing API credentials.
    • API rate limits or quota exceeded errors.
    • Incorrect filter values (e.g., invalid Product OID or Playbook OID) resulting in empty responses.
    • Network connectivity problems preventing access to the Octave API.

  • Error messages:

    • Errors thrown during execution will include the error message and may contain API response details if available.
    • Parsing errors might occur if the API returns malformed JSON; these are caught and included in the error context.

  • Resolutions:

    • Verify that the API key credential is correctly set up and has necessary permissions.
    • Check the validity of filter parameters.
    • Ensure network connectivity and API endpoint availability.
    • Use the "Continue On Fail" option to handle errors gracefully and inspect error details in output.

Links and References

Discussion