Actions19
- Company Actions
- Appointment Actions
- Item Type Actions
- Service Object Actions
- Service Request Actions
- Document Actions
- User Actions
- Report Actions
Overview
This node interacts with a Field Service Management system via its OData API to retrieve multiple service objects. The "Get Many Service Objects" operation fetches a list of service objects, which represent physical or logical assets managed in the field service context (e.g., equipment, devices, or locations).
Common scenarios for this node include:
- Retrieving a list of all service objects for reporting or inventory purposes.
- Filtering service objects based on specific criteria such as location or status.
- Expanding related entities like contacts, company details, products, or tags linked to each service object.
Practical example:
- A technician wants to get all service objects assigned to a particular company and see their associated contacts and tags to prepare for a maintenance visit.
Properties
| Name | Meaning |
|---|---|
| Limit | Maximum number of service objects to return. Must be at least 1. |
| Fetch All Results | Boolean flag indicating whether to fetch all available service objects regardless of the limit. If true, the node ignores the Limit property and retrieves all matching records. |
Filter ($filter) |
An OData filter string to narrow down results by conditions. For example, filtering by name, status, or other fields. OData filters documentation |
Expand ($expand) |
List of related entities to expand and include in the response. Options are: Contacts, Company, Product, Tags. This allows retrieving linked data in one request. Expand docs |
Output
The output is a JSON array where each element represents a service object entity retrieved from the API. Each service object includes its standard fields plus any expanded related entities if requested.
Example structure snippet:
[
{
"Id": 123,
"Name": "Service Object A",
"Location": "Warehouse 1",
"CompanyId": 456,
"Contacts": [...], // Present if expanded
"Company": {...}, // Present if expanded
"Product": {...}, // Present if expanded
"Tags": [...] // Present if expanded
},
...
]
No binary data is output by this operation.
Dependencies
- Requires an API key credential for authenticating requests to the Field Service Management system's OData API.
- The node uses HTTP GET requests with query parameters to interact with the API endpoint
https://portal.mobilefieldreport.com/odata/ServiceObjects. - Proper configuration of the API credential in n8n is necessary for successful authentication.
Troubleshooting
- Empty results: Check the
$filterparameter syntax and values; incorrect filters may yield no data. - Authentication errors: Ensure the API key credential is valid and has sufficient permissions.
- API rate limits or timeouts: When fetching all results with large datasets, consider using the Limit property or pagination to avoid timeouts.
- Invalid expand options: Only the listed expand options (Contacts, Company, Product, Tags) are supported; others will cause errors.
- Malformed OData queries: Verify that
$filterand$expandstrings conform to OData v3 URL conventions.
Links and References
- OData Version 3 URL Conventions
- Expand Query Option Documentation
- Field Service Management API base URL:
https://portal.mobilefieldreport.com/odata/ServiceObjects
