Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

External Link → Get One External Link

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve data about external links. Specifically, the "Get One External Link" operation fetches details of a single external link by its unique identifier. This is useful in scenarios where you need to access or display detailed information about a specific external link stored in the Halo PSA system, such as for reporting, auditing, or further processing within an automation workflow.

Practical examples include:

  • Fetching metadata of an external link to display in a dashboard.
  • Retrieving link details before updating or associating it with other records.
  • Automating checks or validations on external links based on their properties.

Properties

Name Meaning
Id The unique numeric identifier of the external link to retrieve.
Includedetails Optional flag/query parameter to specify whether to include additional details in the response.

Output

The node outputs JSON data representing the external link object retrieved from the Halo PSA API. The structure corresponds to the API's response for a single external link, including all standard fields and optionally extended details if requested.

If the node encounters an error during the request, the output JSON will contain an error field with the error message.

No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for the Halo PSA API, including base URL, tenant identifier, client ID, and client secret.
  • The node uses these credentials to authenticate API requests via custom headers.
  • No additional environment variables are required beyond the configured credentials.

Troubleshooting

  • Common issues:

    • Missing or invalid credentials will cause authentication failures.
    • Providing an invalid or non-existent external link Id will result in an error from the API.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • "No credentials returned!": Indicates that the node could not find or load the required API credentials. Ensure credentials are properly set up.
    • Errors containing "Resource ... not found" or "Operation ... not found" indicate misconfiguration of resource or operation parameters.
    • API errors returned in the output's error field usually reflect issues like invalid Id or permission problems. Review the error message for specifics.

  • Resolution tips:

    • Verify that the API credentials are correctly configured and have necessary permissions.
    • Confirm the external link Id exists in the Halo PSA system.
    • Enable "Continue On Fail" option to handle errors gracefully within workflows.

Links and References

Discussion