Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Tag → Get One Tag

AI-generated

Overview

This node interacts with the Halo PSA API to retrieve detailed information about a specific Tag resource. The "Get One Tag" operation fetches data for a single tag identified by its unique ID. This is useful in scenarios where you need to access metadata or properties of a particular tag within your service management workflows, such as categorizing tickets, assets, or other entities.

Practical examples include:

  • Fetching tag details to display or log them in an automation workflow.
  • Using tag information to conditionally route or process tickets based on their tags.
  • Integrating tag data into reports or dashboards.

Properties

Name Meaning
Id The unique identifier (number) of the tag to retrieve.
Includedetails Optional query parameter to specify whether to include additional details in the response.

Output

The node outputs JSON data representing the retrieved tag object from the Halo PSA API. The structure typically includes all standard fields of a tag, such as its ID, name, description, and any other metadata provided by the API.

If the request fails and "Continue On Fail" is enabled, the output will contain an error message in the JSON under the error key.

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 HTTP headers.
  • No additional external dependencies are required beyond the configured API credentials.

Troubleshooting

  • Common issues:

    • Missing or invalid credentials will cause authentication failures.
    • Providing an invalid or non-existent tag 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 necessary API credentials. Ensure credentials are properly set up.
    • Errors containing "Resource Tag not found" or "Operation Get One Tag not found" indicate misconfiguration of resource or operation parameters.
    • API errors returned in the JSON error field usually reflect issues like invalid IDs or permission problems.

  • Resolutions:

    • Verify that the API credentials are correctly configured and have sufficient permissions.
    • Confirm the tag ID exists in the Halo PSA system.
    • Check network connectivity and API endpoint accessibility.

Links and References

Discussion