Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Field Info → List Of Field Info

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve information about fields defined in the system. Specifically, the "Field Info" resource with the "List Of Field Info" operation allows users to query and list metadata about various fields, including their types, categories, access control levels, and other attributes.

Common scenarios for this node include:

  • Fetching detailed field metadata to dynamically build forms or interfaces.
  • Filtering fields based on specific criteria such as domain, type, or inclusion/exclusion rules.
  • Automating configuration or reporting tasks that depend on field definitions within Halo PSA.

For example, a user might want to list all custom fields of a certain type or exclude certain tables from the results to tailor data processing workflows.

Properties

Name Meaning
Access Control Level Filter fields by their access control level.
Domain Specify the domain to filter fields (string).
Excluderanges Exclude certain ranges from the results.
Excludetables Exclude specific tables from the results.
Excludetableself Exclude self-referencing tables.
Extratype Filter by extra type attribute.
Fieldtype Filter by the type of the field.
Fieldtypemultiple Filter by multiple field types (string).
Includecategories Include only specified categories.
Includedatefields Include date fields only.
Includejirafields Include Jira-related fields.
Includeremotefields Include remote fields.
Includevalues Include values associated with fields.
Inputtype Filter by input type.
Isapprovalstep Filter fields that are approval steps.
Isconfig Filter fields that are configuration related.
Iscustomfieldsetup Filter fields that are part of custom field setup.
Systemid Filter by system ID.
Typeid Filter by type ID.

All these properties are used as query parameters sent to the API to refine the list of field info returned.

Output

The node outputs an array of JSON objects, each representing a field's metadata as returned by the Halo PSA API. The structure includes details such as field identifiers, types, categories, access levels, and other attributes depending on the filters applied.

If the API supports binary data for any fields (not indicated here), it would be included accordingly, but this operation primarily returns JSON metadata.

Example output snippet (conceptual):

[
  {
    "fieldId": "123",
    "fieldName": "Priority",
    "fieldType": "Dropdown",
    "accessControlLevel": "ReadWrite",
    "category": "Issue Fields",
    ...
  },
  ...
]

Dependencies

  • Requires an active connection to the Halo PSA API.
  • Needs credentials providing base URL, tenant identifier, client ID, and client secret.
  • The node uses HTTP requests with appropriate headers for authentication.
  • No additional external dependencies beyond the n8n environment and the configured API credentials.

Troubleshooting

  • No credentials returned!
    This error indicates missing or misconfigured API credentials. Ensure that the required API key or authentication token is properly set up in n8n credentials.

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

  • API request failures
    Network issues, incorrect base URL, or invalid authentication can cause request errors. Check connectivity and credential validity.

  • JSON parsing errors
    If using advanced JSON parameters, ensure that JSON strings are well-formed.

  • Continue On Fail behavior
    When enabled, the node will return error messages in the output instead of stopping execution, useful for debugging.

Links and References

Discussion