Actions5
Overview
The node "FieldProxy" interacts with the FieldProxy API to manage work orders, custom fields, and messages related to those work orders. Specifically, the "Get Custom Field" operation retrieves the value or details of a particular custom field associated with a specified work order. This is useful in scenarios where users need to programmatically access custom metadata or additional information stored on work orders within the FieldProxy system.
Practical examples include:
- Fetching a specific custom attribute (e.g., priority level, client notes) for a work order to display or process further.
- Integrating FieldProxy data into other systems by extracting custom field values dynamically.
- Automating workflows that depend on custom field data from work orders.
Properties
| Name | Meaning |
|---|---|
| Work Order ID | The unique identifier of the work order from which to retrieve the custom field. |
| Custom Field ID | The unique identifier of the custom field to fetch from the specified work order. |
Output
The node outputs JSON data representing the retrieved custom field's details or value. The exact structure depends on the FieldProxy API response but typically includes identifiers, field name, value, and possibly metadata about the custom field.
If the node supports binary data output, it would represent any file or media content linked to the custom field, but based on the provided code and properties, this operation primarily deals with JSON data.
Dependencies
- Requires an API key credential for authenticating with the FieldProxy API.
- Needs the base URL of the FieldProxy API configured in the credentials.
- The node uses HTTP requests to communicate with the FieldProxy API endpoints.
Troubleshooting
- Missing or invalid Work Order ID or Custom Field ID: Ensure these required fields are correctly set; otherwise, the API call will fail or return no data.
- Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
- API endpoint issues: Confirm the base URL is correct and accessible from your environment.
- Unexpected API responses: Check if the custom field exists on the specified work order and that the IDs are accurate.
Common error messages might include authentication failures, 404 not found for invalid IDs, or network timeouts. Resolving these involves verifying credentials, input parameters, and network connectivity.
Links and References
- FieldProxy API Documentation (example placeholder link)
- n8n documentation on Creating Custom Nodes