Skip to main content

Oracle Field Service Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to an Oracle Field Service location.
oracle_field_service_api.png

Oracle Field Service

Create an Oracle Field Service Destination

  1. Click the + icon on the Nexset that will be sent to the Oracle Field Service destination, and select the Send to Destination option from the menu.

  2. Select the Oracle Field Service connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Oracle Field Service organization, and click Next; or, create a new Oracle Field Service credential for use in this flow.

  3. In Nexla, Oracle Field Service destinations can be created using pre-built endpoint templates, which expedite destination setup for common Oracle Field Service endpoints. Each template is designed specifically for the corresponding Oracle Field Service endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    Oracle Field Service destinations can also be configured manually, allowing you to send data to Oracle Field Service endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Oracle Field Service endpoints. Each template is designed specifically for the corresponding Oracle Field Service endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Create Activity

    Creates a new activity in the Oracle Field Service system. Use this endpoint when you need to automatically generate field service tasks from external systems — for example, creating activities from CRM service requests, IoT alerts, or customer support tickets.

    • This endpoint uses an HTTP POST method and accepts a JSON body containing the activity fields to be created. The Nexset data will be sent as the request body in JSON format.
    • Ensure that the Nexset records include all required Oracle Field Service activity fields before sending to this destination. At minimum, Oracle Field Service activities typically require fields such as activity type, customer information, and a scheduled date. Refer to the Oracle Field Service Create Activity API documentation for a full list of accepted and required fields.

    The activity will be created in an unscheduled state unless scheduling fields are provided. Oracle Field Service's AI-powered scheduling engine can be used to assign activities to resources after creation.

    Update Activity

    Updates an existing Oracle Field Service activity by its unique activity ID. Use this endpoint to modify activity details — such as updating status, customer information, scheduled time, or custom field values — based on changes in upstream systems.

    • Enter the unique identifier of the activity to update in the Activity ID field. This is a required field. The activity ID must correspond to an existing activity in Oracle Field Service. Activity IDs can be obtained from the List Activities or Search Activities source endpoints.

    • This endpoint uses an HTTP PATCH method, which means only the fields included in the Nexset record will be updated — fields not present in the payload will retain their existing values in Oracle Field Service. Refer to the Oracle Field Service Update Activity API documentation for a full list of updatable fields.

    Complete Activity

    Marks an existing Oracle Field Service activity as complete. Use this endpoint to programmatically close out field service tasks — for example, when a connected system (such as an ERP or billing platform) confirms that the work has been completed and invoiced.

    • Enter the unique identifier of the activity to complete in the Activity ID field. This is a required field. The activity must be in an active or in-progress state for the completion action to succeed. Refer to the Oracle Field Service Complete Activity API documentation for accepted body fields and completion requirements.

    • Optionally include completion details such as completion notes, time spent, or inventory consumed in the Nexset record body. These fields will be passed to Oracle Field Service as part of the completion request.

    :::warning Important Completing an activity is a state transition that cannot be easily reversed in Oracle Field Service. Ensure the correct activity ID is being passed before activating this destination flow. :::

    Create Resource

    Creates or fully replaces an Oracle Field Service resource by its unique resource ID. Use this endpoint to provision new field technicians, vehicles, or equipment in Oracle Field Service — for example, when onboarding new staff from an HR system or syncing resource records from an external workforce management platform.

    • Enter the unique identifier for the resource to create or replace in the Resource ID field. This is a required field. If a resource with this ID already exists, it will be fully replaced with the data in the Nexset record (HTTP PUT semantics). If no resource exists with this ID, a new resource will be created.

    • Ensure the Nexset record includes all required Oracle Field Service resource fields, such as resource type and name. Refer to the Oracle Field Service Create Resource API documentation for required and optional fields.

    Because this endpoint uses HTTP PUT, omitting optional fields from the Nexset record will clear those fields on the resource in Oracle Field Service. Use the Update Resource endpoint (PATCH) if you only need to modify specific fields without affecting others.

    Update Resource

    Updates specific fields on an existing Oracle Field Service resource by its unique resource ID. Use this endpoint to make partial updates to technician or equipment records — for example, updating work schedules, skill assignments, contact information, or custom field values — without overwriting the entire resource record.

    • Enter the unique identifier of the resource to update in the Resource ID field. This is a required field. The resource must already exist in Oracle Field Service. Resource IDs can be obtained from the List Resources source endpoint.

    • This endpoint uses an HTTP PATCH method, meaning only the fields included in the Nexset record will be updated. Fields not present in the payload will retain their current values. Refer to the Oracle Field Service Update Resource API documentation for a full list of updatable fields.

    Create Service Request

    Creates a new service request in Oracle Field Service. Use this endpoint to automatically generate service requests from external systems such as CRMs, customer portals, IoT platforms, or call center tools — enabling seamless integration between customer-facing systems and field service dispatch.

    • This endpoint uses an HTTP POST method and accepts a JSON body containing the service request fields. The Nexset data will be sent as the request body.
    • Ensure the Nexset records include all required Oracle Field Service service request fields before sending to this destination. Refer to the Oracle Field Service Create Service Request API documentation for required and optional request fields.

    Create User

    Creates a new Oracle Field Service user with a specified login name. Use this endpoint to provision users programmatically — for example, when automating onboarding workflows from an HR system or an identity management platform.

    • Enter the login name for the new user in the Login field. This is a required field and must be unique within your Oracle Field Service instance. The login name is used by the user to sign in to Oracle Field Service.

    • This endpoint uses an HTTP PUT method and will create or replace the user record associated with the specified login. Ensure the Nexset record includes all required user fields such as name and role assignments. Refer to the Oracle Field Service Create User API documentation for required and optional fields.

    Create or Update Inventory Type

    Creates a new inventory type or fully replaces an existing inventory type by its label in Oracle Field Service metadata. Use this endpoint to manage the catalog of parts, materials, and equipment types used in field service operations — for example, syncing inventory type definitions from a parts management system or ERP.

    • Enter the label for the inventory type in the Label field. This is a required field and uniquely identifies the inventory type in Oracle Field Service. If an inventory type with this label already exists, it will be fully replaced. If it does not exist, a new inventory type will be created.

    • This endpoint uses an HTTP PUT method, meaning the entire inventory type record will be replaced with the data in the Nexset. Ensure all required fields are present. Refer to the Oracle Field Service Metadata API documentation for required and optional inventory type fields.

Configure Manually

Oracle Field Service destinations can be manually configured to send data to any valid Oracle Field Service API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Oracle Field Service API after each call to a new Nexla webhook data source.

API Method

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Oracle Field Service API from the Method pulldown menu. Oracle Field Service uses the following HTTP methods:

    • POST: For creating new records (activities, service requests)
    • PUT: For creating or fully replacing records (resources, users, inventory types)
    • PATCH: For partially updating existing records (activities, resources)

Data Format

  1. Select the format in which the Nexset data will be sent to the Oracle Field Service API from the Content Format pulldown menu. Oracle Field Service REST APIs accept JSON format for all write operations — select JSON to ensure proper data formatting.

API Endpoint URL

  1. Enter the URL of the Oracle Field Service API endpoint to which you want to send the Nexset data in the URL field. For update operations (PATCH) or resource creation/replacement by ID (PUT), include the resource identifier at the end of the URL path.

    Oracle Field Service REST API write endpoints follow the base path pattern:

    • Core operations: https://{'{your_instance}'}.etadirect.com/rest/ofscCore/v1/
    • Metadata operations: https://{'{your_instance}'}.etadirect.com/rest/ofscMetadata/v1/

    For example, to create an activity, the endpoint URL would be https://yourinstance.etadirect.com/rest/ofscCore/v1/activities. To update a specific resource, the URL would include the resource ID: https://yourinstance.etadirect.com/rest/ofscCore/v1/resources/{resourceId}.

    Refer to the Oracle Field Service REST API reference for a full list of available write endpoints.

Request Headers

Optional
  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include the Authorization or Content-Type headers — these are automatically handled by Nexla based on your Oracle Field Service credential configuration and the selected content format.

Exclude Attributes from the Call

Optional
  • If any record attributes in the Nexset should be omitted when sending data to this Oracle Field Service destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching

Optional
  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

Response Webhook

Optional

Nexla can automatically send the response received from the Oracle Field Service API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call — such as the newly created activity ID or any validation errors returned by Oracle Field Service.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload

Sample request payloads containing a portion of the Nexset data that will be sent to the Oracle Field Service API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)

After all endpoint settings have been configured, Nexla can send a test payload to the Oracle Field Service API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Oracle Field Service API using the current settings.

Save & Activate the Destination

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to Oracle Field Service, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to Oracle Field Service until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.