Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Agent Image → Get One Uname

AI-generated

Overview

This node interacts with the Halo PSA API to retrieve detailed information about a specific "Agent Image" resource identified by a unique identifier. The "Get One Uname" operation fetches data for one agent image, optionally including additional details or configurations based on query parameters.

Typical use cases include:

  • Retrieving metadata and configuration of a particular agent image in an IT service management context.
  • Fetching extended details such as holiday allowance or designer signatures related to the agent image.
  • Integrating agent image data into workflows for reporting, auditing, or automation purposes.

For example, you might use this node to get the configuration and signature details of an agent image before deploying it or to verify its settings within a larger automated process.

Properties

Name Meaning
Id The unique identifier of the agent image to retrieve (required).
Clientidoverride Optional client ID override sent as a query parameter to customize the request.
Get Htmldesigner Signature Optional flag to include the HTML designer signature in the response (sent as query param).
Getholidayallowance Optional flag to include holiday allowance information in the response (sent as query param).
Includedetails Boolean flag to include extra objects/details in the response (sent as query param).
Isagentconfig Optional flag indicating if agent configuration details should be included (query param).
Loadcache Optional flag to control cache loading behavior (sent as query param).

All optional properties are sent as query parameters to the API endpoint to modify the returned data accordingly.

Output

The node outputs JSON data representing the retrieved agent image object. This includes all standard fields of the agent image plus any additional details requested via the optional query parameters.

The output structure corresponds directly to the API response for the "Get One Uname" operation on the Agent Image resource. It may contain nested objects if Includedetails or other flags are set.

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node expects the base URL, tenant identifier, client ID, and client secret to be configured in the credentials.
  • Network access 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 stating "No credentials returned!". Ensure that valid API authentication details are configured.
  • Resource or Operation Not Found: Errors like "Resource Agent Image not found" or "Operation Get One Uname not found for resource Agent Image" indicate misconfiguration of resource or operation names.
  • Invalid Id Parameter: Since the Id property is required, omitting it or providing an incorrect value will cause the API call to fail.
  • API Request Failures: Network issues, invalid query parameters, or insufficient permissions can cause request errors. Enable "Continue On Fail" to handle these gracefully in workflows.
  • JSON Parsing Issues: If JSON parameters are malformed, the node may throw parsing errors. Validate JSON inputs carefully.

Links and References

Discussion