Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Attachment → List Of Attachment

AI-generated

Overview

This node integrates with the Halo PSA API to list attachments related to tickets, actions, or other entities within the Halo PSA system. It allows users to retrieve detailed information about attachments by specifying various filtering and sorting parameters.

Common scenarios where this node is beneficial include:

  • Fetching all attachments linked to a specific ticket or action for auditing or processing.
  • Filtering attachments by file type or unique identifiers.
  • Sorting attachments based on multiple ordering criteria.
  • Retrieving metadata about attachments without downloading the actual files.

Practical examples:

  • Automatically retrieving all PDF attachments from a particular ticket to archive them externally.
  • Listing image attachments uploaded during a specific action for review.
  • Getting attachment IDs only to reference them in subsequent workflow steps.

Properties

Name Meaning
Action Id (int) Returns attachments associated with the specified action ID (requires ticket_id).
Domotzagents Filter parameter (meaning depends on API context, likely related to agent identification).
Filetype (string) Returns attachments of the specified file type (e.g., "pdf", "jpg").
Idonly Filter parameter to return only attachment IDs instead of full attachment data.
Isxlsimport Filter parameter indicating if the attachment is an Excel import (boolean or flag).
One Attachment Id Filter to return a single attachment by its ID.
Order Primary order field for sorting the returned attachments.
Order 2 Secondary order field for sorting.
Order 3 Tertiary order field for sorting.
Order 4 Fourth-level order field for sorting.
Order 5 Fifth-level order field for sorting.
Orderdesc Boolean or flag indicating descending order for primary order field.
Orderdesc 2 Descending order flag for secondary order field.
Orderdesc 3 Descending order flag for tertiary order field.
Orderdesc 4 Descending order flag for fourth-level order field.
Orderdesc 5 Descending order flag for fifth-level order field.
Portal Filter parameter possibly related to portal-specific attachments.
Ticket Id (int) Returns attachments associated with the specified ticket ID.
Token Authentication or session token parameter (usage depends on API requirements).
Type (int) Returns attachments of the specified type (likely a category or classification).
Unique Id (int) Returns an attachment with the specified unique ID.

Output

The node outputs an array of JSON objects representing the attachments retrieved from the Halo PSA API. Each object contains the attachment's metadata as returned by the API, which may include fields such as attachment ID, filename, file type, size, creation date, and related ticket or action references.

If the node supports binary data output (not explicitly shown here), it would typically provide the actual file content of attachments in a binary property. However, for the "List Of Attachment" operation, the output primarily consists of metadata rather than file binaries.

Dependencies

  • Requires connection to the Halo PSA API endpoint.
  • Needs an API authentication credential containing base URL, tenant identifier, client ID, and client secret.
  • The node uses HTTP requests with appropriate headers for authentication.
  • No additional external services are required beyond the Halo PSA API.

Troubleshooting

  • No credentials returned!
    This error occurs if the node cannot find or access the required API credentials. Ensure that valid credentials are configured in n8n before running the node.

  • Resource or Operation not found
    If the specified resource ("Attachment") or operation ("List Of Attachment") is not recognized, verify that the node configuration matches the supported resources and operations.

  • API request errors
    Errors returned from the Halo PSA API (e.g., authentication failures, invalid parameters) will be surfaced. Check the provided parameters for correctness and ensure the API credentials have sufficient permissions.

  • Empty results
    If no attachments are returned, confirm that the filter parameters (ticket_id, action_id, filetype, etc.) match existing data in the Halo PSA system.

Links and References

Discussion