Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Screen Layout → List Of Screen Layout

AI-generated

Overview

This node integrates with the Halo PSA API to perform various operations on different resources. Specifically, for the Screen Layout resource and the List Of Screen Layout operation, it retrieves a list of screen layouts filtered optionally by a typeid query parameter.

Common scenarios where this node is beneficial include:

  • Automating retrieval of screen layout configurations from Halo PSA for reporting or synchronization.
  • Integrating screen layout data into workflows that require dynamic UI adjustments or audits.
  • Fetching specific types of screen layouts by providing a type identifier to narrow down results.

Example use case: A user wants to fetch all screen layouts of a certain type to display them in a dashboard or to update another system with the current layout configurations.

Properties

Name Meaning
Typeid Optional query parameter to filter the list of screen layouts by their type identifier.

Output

The node outputs an array of JSON objects, each representing a screen layout retrieved from the Halo PSA API. The structure of each JSON object corresponds directly to the API response for screen layouts.

If the operation encounters errors and "Continue On Fail" is enabled, the output will contain JSON objects with an error field describing the issue for the respective input item.

No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for the Halo PSA API, including base URL, tenant ID, client ID, and client secret.
  • The node uses these credentials to authenticate API requests via custom headers.
  • No additional external dependencies beyond the Halo PSA API and n8n's HTTP request helper.

Troubleshooting

  • No credentials returned!
    This error occurs if the node cannot retrieve the required API credentials. Ensure that the API key credential is properly configured in n8n.

  • Resource or Operation not found
    If the specified resource or operation does not exist, verify that the correct resource ("Screen Layout") and operation ("List Of Screen Layout") names are used.

  • API request failures
    Network issues, invalid credentials, or incorrect parameters can cause request errors. Check the error message returned in the output JSON for details.

  • JSON parsing errors
    If using JSON parameters (not applicable here since no JSON body is sent), ensure that JSON strings are well-formed.

Links and References

Note: The node dynamically constructs the API endpoint and method based on the selected resource and operation. For the "List Of Screen Layout" operation, it performs a GET request to the appropriate endpoint, optionally including the typeid as a query parameter.

Discussion