Retrieve Fields Needed for Booking

With the 25D update, a new REST operation called bookingFieldsDependencies is introduced for Oracle Fusion Field Service. This service provides a complete list of activity fields and configured properties that must be supplied before the showBookingGrid API operation can calculate and display valid booking options. It ensures that integrations always know which data points are required, so that booking requests return accurate and successful results.

The value of this feature lies in its ability to adapt automatically to configuration changes. In the past, when administrators updated which fields or properties were used to estimate durations, travel times, or work zones, integrations had to be manually updated to send the newly required data. If this was missed, bookings could fail or produce incorrect results. With bookingFieldsDependencies, integrations no longer need manual adjustments. The service dynamically detects configuration changes and returns the current set of fields and properties required for validation. By consuming this response, integrations can always send the correct data and obtain a successful booking response without additional maintenance.

For example, if Activity Type and Service Level were originally required to estimate duration, and later a new property named Asset Type is added, the API automatically includes it in its response. The integration then provides Asset Type in booking requests, ensuring accurate results without requiring any code changes.

API Request and Response

Request Information

  • Method: GET
  • Endpoint: /rest/ofscCapacity/v1/bookingFieldsDependencies
  • Parameters: None
  • Body: None

Response Structure
The response is a JSON object containing five arrays, each listing the fields or properties required for one aspect of the booking calculation:

  • commonDependencies: Mandatory activity fields always required by showBookingGrid.
  • durationDependencies: Fields/properties used to calculate activity duration (based on Duration Keys).
  • travelTimeDependencies: Fields/properties used for travel time estimation (based on Travel Keys).
  • workZoneDependencies: Fields/properties identifying the correct capacity area (based on Work Zone Key, for example, city or postal code).
  • workSkillDependencies: Fields/properties confirming skills or qualifications required for the work (based on work skill conditions configuration).

Each dependency includes:

  • label: The descriptive name of the field or property.
  • apiParameterName: The parameter name expected by showBookingGrid.

Request Response Example

GET https://frontend.ofss.com/rest/ofscCapacity/v1/bookingFieldsDependencies HTTP/1.1
Accept: application/json
Content-Type: application/json
HTTP/2 200
server: nginx/1.20.1
date: Tue, 23 Sep 2025 17:37:13 GMT
content-type: application/json; charset=utf-8
cache-control: no-store, no-cache
strict-transport-security: max-age=31536000
{
  "commonDependencies": [
    {
      "label": "aworktype",
      "apiParameterName": "activityType"
    }
  ],
  "durationDependencies": [
    {
      "label": "aworktype",
      "apiParameterName": "activityType"
    },
    {
      "label": "BookingStatisticProperty_1",
      "apiParameterName": "BookingStatisticProperty_1"
    },
    {
      "label": "BookingStatisticProperty_2",
      "apiParameterName": "BookingStatisticProperty_2"
    }
  ],
  "travelTimeDependencies": [
    {
      "label": "BookingStatisticProperty_3",
      "apiParameterName": "BookingStatisticProperty_3"
    },
    {
      "label": "BookingStatisticProperty_4",
      "apiParameterName": "BookingStatisticProperty_4"
    }
  ],
  "workZoneDependencies": [
    {
      "label": "WorkOrder.City",
      "apiParameterName": "city"
    },
    {
      "label": "WorkOrder.PostalCode",
      "apiParameterName": "postalCode"
    }
  ],
  "workSkillDependencies": [
    {
      "label": "aworktype",
      "apiParameterName": "activityType"
    },
    {
      "label": "XA_PROPERTY_1",
      "apiParameterName": "XA_PROPERTY_1"
    },
    {
      "label": "XA_PROPERTY_2",
      "apiParameterName": "XA_PROPERTY_2"
    },
    {
      "label": "XA_PROPERTY_3",
      "apiParameterName": "XA_PROPERTY_3"
    },
    {
      "label": "XA_PROPERTY_4",
      "apiParameterName": "XA_PROPERTY_4"
    },
    {
      "label": "XA_PROPERTY_5",
      "apiParameterName": "XA_PROPERTY_5"
    }
  ]
}

Business Benefits

  • Ensures integrations always send the correct data for successful booking calls.
  • Adapts automatically to configuration changes, avoiding manual integration updates.
  • Minimizes maintenance effort and prevents errors from overlooked changes.
  • Provides consistent, accurate booking results across evolving business rules.

Steps to Enable

You don't need to do anything to enable this feature.

Tips And Considerations

  • Fields under commonDependencies are always required.
  • A field or property may appear in multiple categories.
  • Always consume the response dynamically (do not hard code field names).
  • Treat this service as a validation checkpoint before booking.