Change History

Review what's new in this document.

February 2020

The following table lists changes introduced in this version of the document.

Change Type Description

Find nearby activities

New Endpoint

The 'Find nearby activities' operation retrieves the matching activities nearby its current location.

Get calendars

Updated Endpoint

The parameters 'limit' and 'offset' are added to the 'Get calendars' operation to retrieve the result by pages.

Create or update an activity type

Updated Endpoint

The 'Create or update an activity type' operation is updated to provide more flexibility for changing the Activity type features. Changing Activity feature types is allowed if it is safe from the perspective of data consistency.

November 2019

The following table lists changes introduced in this version of the document.

Change Type Description

Work Zone Key

New Resource

The 'Work Zone Key' resource is used to retrieve the work zone key configuration.

Activity Type Groups

New Resource

The 'Activity Type Groups' endpoints can be used to perform the following operations:

  • Create or replace an activity type group
  • Get activity type groups
  • Get an activity type group

Create or update an activity type

New Endpoint

The 'Create or update an activity type' operation creates or updates an activity type.

Get an activity type

New Endpoint

The 'Get an activity type' operation retrieves the details of the specified activity type.

Get activity types

Updated Endpoint

The 'Get activity types' operation is enhanced to return a collection of activity types along with all the information about each activity type.

Find matching resources

Updated Endpoint

The parameter 'estimatedCompleteDate' is added to the 'Find matching resources' operation to support segmentable activities. The 'estimatedCompleteDate' parameter returns the expected date for the last segment of the activity in case this activity is assigned to a particular resource. The 'estimatedCompleteDate' parameter is returned for each resource found in the response.

August 2019

The following table lists changes introduced in this version of the document.

Change Type Description

Get an access token

New Endpoint

The 'Get an access token' (/rest/oauthTokenService/v2/token) operation retrieves the access_token field in compliance with the RFC 6749 - The OAuth 2.0 Authorization Framework standard.

Get an access token (Deprecated)

Deprecated Endpoint

The 'Get an access token' (/rest/oauthTokenService/v1/token) operation is now deprecated.

Deprecated Paths and Endpoints

New Topic

This topic provides information on APIs that have been deprecated.

May 2019

The following table lists changes introduced in this version of the document.

Change Type Description

Forms

New Resource

The Forms API endpoints can be used to perform the following operations:

  • Create or Update a Form
  • Get Form Details
  • Get Forms
  • Delete a Form

Chats

New Resource

The Chats API endpoints can be used to perform the following operations:

  • Get participants of a chat
  • Invite a participant to chat
  • Leave a chat
  • Send messages to a chat
  • Start new chat

Create a resource location

Updated Endpoint

The 'Create a resource location' operation is enhanced to support custom properties in resource locations. The custom properties of type string, enumeration, and integer can be used in this operation.

Get a resource location

Updated Endpoint

The 'Get a resource location' operation is enhanced to support custom properties in resource locations. The custom properties of type string, enumeration, and integer can be used in this operation.

Get resource locations

Updated Endpoint

The 'Get resource locations' operation is enhanced to support custom properties in resource locations. The custom properties of type string, enumeration, and integer can be used in this operation.

Update a resource location

Updated Endpoint

The 'Update a resource location' operation is enhanced to support custom properties in resource locations. The custom properties of type string, enumeration, and integer can be used in this operation.

Bulk update resource inventories

Updated Endpoint

The parameter 'inventoryPropertiesUpdateMode' is added to the Bulk Update Resource Inventories operation. The value of this parameter indicates whether the existing inventory properties should be replaced or retained and updated with the new properties that are sent in the request.

Bulk update activities

Updated Endpoint

The parameter 'inventoryPropertiesUpdateMode' is added to the Bulk Update Activities operation. The value of this parameter indicates whether the existing inventory properties should be replaced or retained and updated with the new properties that are sent in the request.

February 2019

The following table lists changes introduced in this version of the document.

Change Type Description

Parts catalog

New Resource

The Parts Catalog API endpoints can be used to perform the following operations:

  • Create a Catalog
  • Create or update a catalog item
  • Remove a catalog item

Support of forms

New Topic

The formSubmitted event contains information about the form values and the entity values that are submitted with the form.

Configure for CORS

New Topic

CORS is a set of rules that defines the way a server and a browser talk to each other and whether or not it's safe to do so across different domains. As a specification, CORS provides a standard way to implement cross-domain requests that can be used in all browsers.

Create or update an application

Updated Endpoint

The 'Create or update an application' operation is enhanced to enable configuration of origin domains for cross-origin resource sharing (CORS).

Get an application

Updated Endpoint

The 'Get an application' operation is enhanced to enable configuration of origin domains for cross-origin resource sharing (CORS).

Get applications

Updated Endpoint

The 'Get applications' operation is enhanced to enable configuration of origin domains for cross-origin resource sharing (CORS).

November 2018

The following table lists changes introduced in this version of the document.

Change Type Description

Get Started section

Updates to topics

The topics in this section have been revised and reorganized to increase usability.

Delete assigned locations

New Endpoint

The 'Delete assigned locations' operation deletes the locations assigned to the specified resource.

Update assigned locations

New Endpoint

The 'Update assigned locations' operation creates or updates the temporary locations assigned to the specified resource.

Get assigned locations

Updated Endpoint

The 'Get assigned locations' operation is enhanced to return the details about the locations assigned to the resource for the specified date range.

Inventory types

New Resource

The 'Inventory types' resource is used to retrieve a collection of inventory types.

Resource types

New Resource

The 'Resource types' resource is used to retrieve a collection of resource types.

Time slots

New Resource

The 'Time slots' resource is used to retrieve a collection of time slots.

October 2018

The following table lists changes introduced in this version of the document.

Change Type Description

Title and Copyright Information

Layout

The layout has been revised to uptake the collapsible copyright section.

September 2018

The following table lists changes introduced in this version of the document.

Change Type Description

Get Started section

Updates to topics

The topics in this section have been revised and reorganized to increase usability.

August 2018

The following table lists changes introduced in this version of the document.

Change Type Description

Resource positions

New Resource

The Smart Location API endpoints can be used to perform the following operations:

  • Retrieve last known positions of resources
  • Retrieve position history for resource for certain date
  • Retrieve resources in area
  • Set positions for resources

Activity duration

New Resource

The 'Activity Duration' resource is used to perform the following operations:

  • Retrieve the activity duration statistics
  • Set or update the activity duration override for the activity duration key that is currently active

Activity travel

New Resource

The 'Activity Travel' resource is used to perform the following operations:

  • Retrieve activity travel statistics
  • Set or Update the travel duration override for the travel key that is currently active

Bulk update resource inventories

New Endpoint

The 'Bulk update resource inventories' operation creates or updates resource inventory in bulk for the specified resources with the inventory specified in the request.

Authenticate

Updated Topic

Oracle Field Service Cloud now supports Oracle Identity Cloud Service token service for OAuth 2.0 Authentication.

Service requests

New Resource

The Service Request resource can be used to perform the following operations:

  • Create service request

  • Get service request

Applications

New Resource

The Applications resource can be used to perform the following operations:

  • Create/Update application

  • Get application

  • Get applications

  • Update applications API access

  • Get applications API access

  • Get applications API accesses

Get calendars

New Endpoint

The 'Get calendars' operation returns a list of work schedules for the specified resources for the specified interval of days.

Bulk update resource work schedules

New Endpoint

The 'Bulk update resource work schedules' operation creates, updates, or deletes work schedules of multiple resources at once.

Bulk update resource work skills

New Endpoint

The 'Bulk update resource work skills' operation creates, updates, or deletes work skills of multiple resources at once.

Bulk update resource work zones

New Endpoint

The 'Bulk update resource work zones' operation creates, updates, or deletes work zones of multiple resources at once.

May 2018

The following table lists changes introduced in this version of the document.

Change Type Description

Activity types

New Resource

The 'Activity Types' resource is used to retrieve a collection of activity types.

Non-working reasons

New Resource

The 'Non-working Reasons' resource is used to retrieve a collection of non-working reasons.

Find resources for urgent assignment

New Endpoint

The 'Find resources for urgent assignment' API function retrieves possible urgent activity assignments for the nearest time, taking into consideration the estimation for distance and time.

Dynamic scope support for accessing APIs

New Topic

OFSC customers may need to grant OFSC Public API access to their own customers (end-customers) without creating specific accounts in OFSC or in other Oracle applications. This feature helps restrict the scope of the end-customer's access to specific requests, so that they cannot view data related to other customers in OFSC.

Routing events

New Topic

The 'routingRun' event type allows integrators to build flows depending on the routing execution stages and reduces the necessity to watch and monitor routing execution processes in the Manage interface.