Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Field Info → Get One Field Info

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve detailed information about a specific field within the system. The "Get One Field Info" operation under the "Field Info" resource fetches metadata and optionally additional details related to a single field identified by its ID.

Typical use cases include:

  • Fetching metadata about custom or standard fields in Halo PSA for dynamic form generation.
  • Retrieving lookup values associated with a field to populate dropdowns or selection lists.
  • Obtaining detailed descriptions or configurations of fields for reporting or automation purposes.

For example, a user might want to get all relevant information about a custom field on an entity to display it in a dashboard or validate input data before submission.

Properties

Name Meaning
Id The unique numeric identifier of the field to retrieve information for. (Required)
Entityid Optional query parameter specifying the entity ID related to the field.
Getlookupvalues Optional query parameter indicating whether to include lookup values associated with the field.
Includedetails Optional query parameter to specify if detailed information about the field should be included.
Livecustomfields Optional string query parameter, possibly used to specify live custom fields to consider.
Userid Optional query parameter specifying the user ID context for the request.

Output

The node outputs a JSON object containing the response from the Halo PSA API for the requested field. This typically includes:

  • Field metadata such as name, type, label, and configuration.
  • Lookup values if requested, which are possible selectable options for the field.
  • Additional details depending on the parameters set, like validation rules or dependencies.

If the API returns binary data (not indicated here), it would be provided in the binary output; however, this operation appears to return only JSON data.

Example output structure (simplified):

{
  "id": 123,
  "name": "CustomField1",
  "type": "string",
  "label": "Custom Field 1",
  "lookupValues": [
    {"id": 1, "value": "Option A"},
    {"id": 2, "value": "Option B"}
  ],
  "details": {
    "description": "Detailed info about the field",
    "required": true
  }
}

Dependencies

  • Requires an active connection to the Halo PSA API via an API key credential.
  • The node expects credentials providing base URL, tenant identifier, client ID, and client secret for authentication.
  • No other external services or environment variables are explicitly required.

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 or operation is invalid or misspelled, the node will throw an error. Verify that "Field Info" and "Get One Field Info" are correctly selected.

  • API request errors
    Network issues, incorrect parameters, or insufficient permissions can cause API request failures. Check the error message returned in the node output for details. Enabling "Continue On Fail" allows processing subsequent items despite errors.

  • Invalid or missing required parameters
    The "Id" property is mandatory. Omitting it or providing an invalid value will result in errors.

Links and References

This summary is based solely on static analysis of the provided source code and property definitions.

Discussion