mfr - Field Service Management icon

mfr - Field Service Management

Field service management app for scheduling technicians.

Service Request → Get One

AI-generated

Overview

This node operation retrieves a single Service Request from the Field Service Management system. It allows fetching the Service Request either by its internal ID or by an External ID. Additionally, users can specify fields to expand in the response to include related entities such as Appointments, Contacts, Customer, Items, Reports, Service Objects, Steps, and Stock Movements. This operation is useful for scenarios where detailed information about a specific Service Request is needed, for example, to review its status, associated customer, or related service activities.

Use Case Examples

  1. Fetch a Service Request by its internal ID to get detailed information including related appointments and customer data.
  2. Retrieve a Service Request using an External ID when the internal ID is not known, expanding related comments and reports for comprehensive insight.

Properties

Name Meaning
Search Service Request Allows searching for the Service Request either from a list or by specifying its ID. The list mode supports searching by External ID or other identifiers.
Additional Fields Optional fields to customize the request, including expanding related entities and searching by External ID.

Output

JSON

  • json - The JSON response containing the Service Request data, including any expanded related entities as specified in the input.

Dependencies

Troubleshooting

  • If the Service Request is not found, verify that the provided ID or External ID is correct and exists in the system.
  • Ensure that the API key credential is valid and has the necessary permissions to access Service Request data.
  • If expansions are specified but not returned, check that the related entities exist and that the $expand parameter is correctly formatted.

Links

  • Expand documentation - Documentation on how to use the $expand parameter to include related entities in the response.

Discussion