Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Std Request → List Of Std Request

AI-generated

Overview

This node integrates with the Halo PSA API to perform various operations on different resources. Specifically, the "List Of Std Request" operation under the "Std Request" resource retrieves a filtered and optionally paginated list of standard requests (reports) from the Halo PSA system. It allows users to query reports based on multiple criteria such as access control level, client, agent, department, ticket type, and more.

Common scenarios for this node include:

  • Fetching a customized list of service requests or reports for further processing or reporting.
  • Automating workflows that require retrieving specific tickets or reports matching certain filters.
  • Integrating Halo PSA data into other systems by extracting relevant report information.

Practical example:

  • A user wants to retrieve all open standard requests assigned to a particular team and order them by creation date descending, including only those visible to anonymous users. This node can be configured with appropriate filters and ordering parameters to return exactly that dataset.

Properties

Name Meaning
Access Control Level Filters response based on the access control level (string).
Action Id Filter by the specified action (integer).
Agent Id Filter by reports with permissions to a particular agent id (integer).
Anonanduser Filter on reports that can be viewed by anonymous users (boolean).
Asset Id Filter by asset id (integer).
Client Id Filter by the specified client (integer).
Department Id Filter by reports with permissions to a particular department id (integer).
Domain Filter on ticket areas: 'reqs' (requests), 'opps' (opportunities), or 'prjs' (projects) (string).
Group Id Filter by group id (integer).
Include Ticket Id Filter by the specified ticket (integer).
Includeclients Include which clients have access to the reports (boolean).
Includenames Include which agents/teams/organisations have access to the reports (boolean).
Itil Ticket Type Id Filter by ITIL ticket type id (integer).
Itil Type Filter by ITIL type (integer).
Order The name of the field to order by first (string).
Order 2 The name of the field to order by second (string).
Order 3 The name of the field to order by third (string).
Order 4 The name of the field to order by fourth (string).
Order 5 The name of the field to order by fifth (string).
Orderdesc Whether to order ascending or descending on first order (boolean).
Orderdesc 2 Whether to order ascending or descending on second order (boolean).
Orderdesc 3 Whether to order ascending or descending on third order (boolean).
Orderdesc 4 Whether to order ascending or descending on fourth order (boolean).
Orderdesc 5 Whether to order ascending or descending on fifth order (boolean).
Page No When using pagination, the page number to return (integer).
Page Size When using pagination, the size of the page (integer).
Pageinate Whether to use pagination in the response (boolean).
Parent Template Id Filter by reports with permissions to a particular parent template id (integer).
Report Id Filter by report id (integer).
Search Filters response based on the search string (string).
Showall Admin override to return all reports (boolean).
Team Id Filter by reports with permissions to a particular team id (integer).
Ticket Type Id Filter by the specified ticket type (integer).
Todo Client Id Filters response based on the to-do client id (string).
Todo Only Include only reports that are 'to-do' in the response (boolean).
Type Filters response based on the report type (integer).
Types Return reports of these report types, comma separated (string).

Output

The node outputs an array of JSON objects representing the list of standard requests (reports) retrieved from the Halo PSA API according to the applied filters and pagination settings.

Each item in the output json corresponds to one report object returned by the API. The exact structure depends on the Halo PSA API response but typically includes fields like report ID, title, status, assigned agent/team, creation date, and other metadata.

No binary data is output 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 HTTP requests to communicate with the Halo PSA REST API endpoints.
  • Proper configuration of the API credentials within n8n is necessary for successful authentication and data retrieval.

Troubleshooting

  • No credentials returned!
    This error occurs if the node cannot find or access the required API credentials. Ensure that the Halo PSA API credentials are correctly set up and linked to the node.

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

  • API request errors
    Network issues, invalid filters, or permission problems may cause API request failures. Check the error message returned in the output JSON for details. Using the "continue on fail" option can help handle partial failures gracefully.

  • Invalid filter values
    Providing incorrect data types or unsupported filter values may result in empty responses or errors. Validate input parameters before execution.

Links and References

Discussion