Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Release → Get Undefined

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve release information. Specifically, the "Release" resource with the "Get Undefined" operation allows users to query releases with various filtering, ordering, and pagination options. This is useful for scenarios where you want to fetch detailed release data from Halo PSA, such as listing product releases, filtering by version or product ID, or including additional related details.

Practical examples include:

  • Fetching a paginated list of software releases for a specific product.
  • Searching releases by keywords or version sequences.
  • Including or excluding certain release note groups or devops project details.
  • Ordering the results by multiple criteria in ascending or descending order.

Properties

Name Meaning
Count Number of releases to return.
Include Devops Project Whether to include associated DevOps project information.
Includenotecount Whether to include the count of release notes.
Order Primary field to order the results by (string).
Order 2 Secondary field to order the results by (string).
Order 3 Tertiary field to order the results by (string).
Order 4 Fourth-level field to order the results by (string).
Order 5 Fifth-level field to order the results by (string).
Orderdesc Whether to order descending on primary order field (boolean-like).
Orderdesc 2 Whether to order descending on secondary order field (boolean-like).
Orderdesc 3 Whether to order descending on tertiary order field (boolean-like).
Orderdesc 4 Whether to order descending on fourth-level order field (boolean-like).
Orderdesc 5 Whether to order descending on fifth-level order field (boolean-like).
Page No Page number for pagination.
Page Size Number of items per page for pagination.
Pageinate Whether to paginate results (boolean-like).
Product Id Filter releases by a specific product ID.
Restrictmyversion Restrict results to versions owned by the user (boolean-like).
Search Search string to filter releases by matching text.
Compare Version Seq Filter releases by comparing version sequence numbers.
Exclude Releasenote Group Id Exclude releases belonging to a specific release note group ID.
Includedetails Whether to include detailed release information (boolean-like).
Releasenote Group Id Filter releases by a specific release note group ID.

Output

The node outputs an array of JSON objects representing the retrieved releases. Each item corresponds to one release record returned by the API, containing all fields provided by the Halo PSA API response for releases. The exact structure depends on the API but typically includes release metadata such as version, product association, release notes, dates, and other relevant details.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node expects configuration of base URL, tenant identifier, client ID, and client secret for the Halo PSA service.
  • Network connectivity to the Halo PSA API endpoint is necessary.

Troubleshooting

  • No credentials returned!: Ensure that the API authentication credentials are properly configured in n8n before executing the node.
  • Resource or Operation not found: Verify that the selected resource ("Release") and operation ("Get Undefined") exist and are correctly spelled.
  • API request errors: Check network connectivity and API permissions. Review error messages returned in the output JSON under the error field if "Continue On Fail" is enabled.
  • Invalid parameter values: Make sure numeric parameters like counts and page numbers are valid integers and strings for ordering fields match expected API values.
  • Pagination issues: If no results are returned, verify pagination parameters and filters to ensure they match existing data.

Links and References

Discussion