Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Dashboard Links → Get One Dashboard Links

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve information about dashboard links. Specifically, the "Get One Dashboard Links" operation fetches details of a single dashboard link by its unique identifier. This is useful in scenarios where you want to programmatically access or display specific dashboard link data within an automation workflow, such as embedding dashboard URLs, auditing dashboard configurations, or integrating dashboard metadata into reports.

Practical examples include:

  • Fetching a dashboard link to embed it in a custom portal.
  • Retrieving dashboard link details for monitoring or alerting purposes.
  • Using dashboard link metadata to customize user interfaces dynamically.

Properties

Name Meaning
Id The unique numeric identifier of the dashboard link to retrieve.
Getreporttoken Optional query parameter to request a report token associated with the dashboard link.
Includedetails Optional query parameter to specify whether to include detailed information in response.
Showall Optional query parameter to indicate if all related data should be shown.
Userid Optional query parameter to filter or specify the user context for the dashboard link.

Output

The node outputs JSON data representing the retrieved dashboard link object from the Halo PSA API. The structure typically includes properties describing the dashboard link's attributes, such as its ID, URL, name, and potentially additional metadata depending on the query parameters used (e.g., detailed info if Includedetails is set).

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node configuration must include valid credentials containing base URL, tenant identifier, client ID, and client secret.
  • Network connectivity to the Halo PSA API endpoint is necessary.

Troubleshooting

  • Missing Credentials Error: If no credentials are provided or they are invalid, the node will throw an error indicating missing credentials. Ensure that the API authentication token and other required fields are correctly configured.
  • Resource or Operation Not Found: Errors may occur if the specified resource or operation does not exist. Verify that "Dashboard Links" is selected as the resource and "Get One Dashboard Links" as the operation.
  • Invalid Id Parameter: Since the Id property is required and numeric, providing an invalid or missing ID will cause the request to fail. Double-check the ID value before execution.
  • API Request Failures: Network issues, incorrect query parameters, or insufficient permissions can cause API call failures. Review error messages returned in the JSON output for clues and verify API access rights.
  • JSON Parsing Issues: If using advanced JSON parameters (not typical for this operation), ensure JSON syntax is correct to avoid parsing errors.

Links and References

Discussion