mfr - Field Service Management icon

mfr - Field Service Management

Field service management app for scheduling technicians.

Actions19

Overview

This node interacts with a Field Service Management system via its API to retrieve multiple "Item Type" records. The "Get Many" operation under the "Item Type" resource fetches a list of item types, which are typically used to categorize or identify different products or materials managed within the field service environment.

Common scenarios for this node include:

  • Retrieving a catalog of item types for inventory management.
  • Filtering item types based on specific criteria to integrate with other systems.
  • Expanding related data fields (e.g., units) to get more detailed information about each item type.

Practical example:

  • A user wants to pull all item types related to electrical components and include their unit details to prepare a parts list for a technician's work order.

Properties

Name Meaning
Limit Maximum number of item type results to return. Must be at least 1.
Fetch All Results Boolean flag indicating whether to ignore the limit and fetch all available item types. If set to true, all item types will be retrieved regardless of the limit setting.
Filter ($filter) A string allowing OData filter expressions to narrow down the returned item types by conditions. For example, filtering by name or external ID. Documentation: https://www.odata.org/documentation/odata-version-3-0/url-conventions/
Expand ($expand) Allows expanding hidden or related fields in the response. Currently supports expanding the "Unit" field to include unit details associated with each item type. Documentation: https://documenter.getpostman.com/view/3999268/TVYCAzpK#odata-tools

Output

The output is a JSON array where each element represents an item type object retrieved from the API. Each item type includes its standard properties such as identifiers, names, descriptions, costs, prices, VAT, manufacture details, and optionally expanded related fields like Unit if requested.

No binary data is output by this operation.

Example structure snippet (simplified):

[
  {
    "Id": 123,
    "NameOrNumber": "Widget A",
    "ExternalId": "WIDG-A-001",
    "Costs": 10.5,
    "Price": 15.0,
    "VAT": 0.2,
    "Manufacture": "Acme Corp",
    "Description": "Standard widget",
    "GlobalTradeItemNr": "00012345678905",
    "Unit": {
      "Id": 1,
      "Name": "Piece"
    }
  },
  ...
]

Dependencies

  • Requires an API key credential for authenticating requests to the Field Service Management system's API.
  • The node uses OData-compliant endpoints exposed by the service at https://portal.mobilefieldreport.com/odata/ItemTypes.
  • No additional environment variables are required beyond the API authentication setup.

Troubleshooting

  • Empty results: Ensure that the $filter expression is correctly formatted and matches existing item types. Also verify that the API credentials have sufficient permissions.
  • Partial results despite setting Fetch All Results: Confirm that the "Fetch All Results" property is set to true; otherwise, the node respects the "Limit" property.
  • API request failures: Common errors may include authentication failures (check API key validity), network issues, or malformed query parameters. Review error messages for HTTP status codes and adjust accordingly.
  • Invalid expand options: Only "Unit" is supported for expansion. Using unsupported values in the $expand property may cause errors or ignored expansions.

Links and References

Discussion