All REST Endpoints

Capacity/Available Capacity
The available capacity resource is used to view the actual available capacity. The available capacity is the total number of resource-hours dedicated to customer work for a particular day.
Get available capacity
Method: get
Path: /rest/ofscCapacity/v1/capacity
Capacity/Booking
The booking resource is used to view the available booking options for an activity. Booking is a process of creating an appointment for customer work, finding time periods with enough quota and capacity, and helping booking managers find qualified resources for the work.
Get activity booking options
Method: get
Path: /rest/ofscCapacity/v1/activityBookingOptions
Capacity/Booking Closing Schedule
The booking closing schedule resource is used to view and update the closing schedules and statuses of bookings. The booking statuses allow you to open, close, or update bookings for capacity areas, workzones, and timeslots/time intervals.
Create or update booking closing schedules
Method: patch
Path: /rest/ofscCapacity/v1/bookingClosingSchedule
Get booking closing schedule
Method: get
Path: /rest/ofscCapacity/v1/bookingClosingSchedule
Get booking statuses
Method: get
Path: /rest/ofscCapacity/v1/bookingStatuses
Update booking statuses
Method: patch
Path: /rest/ofscCapacity/v1/bookingStatuses
Capacity/Quota
The quota resource is used to view and update quota for capacity areas. Updating quota lets you allocate time values to the different types of work that is performed in your organization.
Create or update quota
Method: patch
Path: /rest/ofscCapacity/v1/quota
Get quota
Method: get
Path: /rest/ofscCapacity/v1/quota
Collaboration/Chats
The chats resource is used to start or leave a chat, invite or view chat participants, or send a message on an existing chat. Real-time messages can be sent and received using chats.
Get participants
Method: get
Path: /rest/ofscCollaboration/v1/chats/{chatId}/participants
Invite a participant
Method: post
Path: /rest/ofscCollaboration/v1/chats/{chatId}/participants/invite
Leave a chat
Method: post
Path: /rest/ofscCollaboration/v1/chats/{chatId}/leave
Send a message
Method: post
Path: /rest/ofscCollaboration/v1/chats/{chatId}/messages
Start a new chat
Method: post
Path: /rest/ofscCollaboration/v1/chats
Core/Activities
The activities resource is used to view, create, or update activities. It is also used to search for activities based on a specified criteria, view individual segments of segmentable activities, and retrieve activity status and technician information. An activity is any time-consuming task done by a resource. For example, installation, trouble call, lunch, team meeting, and so on.
Bulk update activities
Method: post
Path: /rest/ofscCore/v1/activities/custom-actions/bulkUpdate
Create an activity
Method: post
Path: /rest/ofscCore/v1/activities
Get activities
Method: get
Path: /rest/ofscCore/v1/activities
Get an activity
Method: get
Path: /rest/ofscCore/v1/activities/{activityId}
Get individual segments of a segmentable activity
Method: get
Path: /rest/ofscCore/v1/activities/{activityId}/multidaySegments
Search for activities
Method: get
Path: /rest/ofscCore/v1/activities/custom-actions/search
Update an activity
Method: patch
Path: /rest/ofscCore/v1/activities/{activityId}
Where is my technician
Method: get
Path: /rest/ofscCore/v1/whereIsMyTech
Core/Activities/Activity Actions
The activity actions resource is used to perform various actions on activities such as start activity, delay activity, move activity, complete activity, and so on.
Cancel an activity
Method: post
Path: /rest/ofscCore/v1/activities/{activityId}/custom-actions/cancel
Complete an activity
Method: post
Path: /rest/ofscCore/v1/activities/{activityId}/custom-actions/complete
Delay an activity
Method: post
Path: /rest/ofscCore/v1/activities/{activityId}/custom-actions/delay
Delete an activity
Method: delete
Path: /rest/ofscCore/v1/activities/{activityId}
Move an activity
Method: post
Path: /rest/ofscCore/v1/activities/{activityId}/custom-actions/move
Reopen an activity
Method: post
Path: /rest/ofscCore/v1/activities/{activityId}/custom-actions/reopen
Start an activity
Method: post
Path: /rest/ofscCore/v1/activities/{activityId}/custom-actions/start
Start prework
Method: post
Path: /rest/ofscCore/v1/activities/{activityId}/custom-actions/startPrework
Suspend an activity
Method: post
Path: /rest/ofscCore/v1/activities/{activityId}/custom-actions/suspend
Update the activity status to notdone
Method: post
Path: /rest/ofscCore/v1/activities/{activityId}/custom-actions/notDone
Core/Activities/Activity File Properties
The activity file properties resource is used to view, create, or delete a file property for a specific activity. The file property may be used to transfer files such as documents, photos, signatures, and so on.
Delete a file property
Method: delete
Path: /rest/ofscCore/v1/activities/{activityId}/{propertyLabel}
Get a file property
Method: get
Path: /rest/ofscCore/v1/activities/{activityId}/{propertyLabel}
Set a file property
Method: put
Path: /rest/ofscCore/v1/activities/{activityId}/{propertyLabel}
Core/Activities/Activity Inventories
The activity inventories resource is used to view or create customer inventories for a specific activity and view installed and deinstalled inventories for a specific activity. Activity inventories are the inventories assigned to perform an activity.
Create a customer inventory
Method: post
Path: /rest/ofscCore/v1/activities/{activityId}/customerInventories
Get customer inventories
Method: get
Path: /rest/ofscCore/v1/activities/{activityId}/customerInventories
Get deinstalled inventories
Method: get
Path: /rest/ofscCore/v1/activities/{activityId}/deinstalledInventories
Get installed inventories
Method: get
Path: /rest/ofscCore/v1/activities/{activityId}/installedInventories
Core/Activities/Activity Links
The activity links resource is used to view, create, update, or delete links associated with the specific activity. Links are used to identify dependencies between activities. For example, Activity A must be complete before Activity B can start.
Create an activity link
Method: post
Path: /rest/ofscCore/v1/activities/{activityId}/linkedActivities
Delete all activity links
Method: delete
Path: /rest/ofscCore/v1/activities/{activityId}/linkedActivities
Delete an activity link
Method: delete
Path: /rest/ofscCore/v1/activities/{activityId}/linkedActivities/{linkedActivityId}/linkTypes/{linkType}
Get activity link details
Method: get
Path: /rest/ofscCore/v1/activities/{activityId}/linkedActivities/{linkedActivityId}/linkTypes/{linkType}
Get activity links
Method: get
Path: /rest/ofscCore/v1/activities/{activityId}/linkedActivities
Replace an activity link
Method: put
Path: /rest/ofscCore/v1/activities/{activityId}/linkedActivities/{linkedActivityId}/linkTypes/{linkType}
Core/Activities/Activity Required Inventories
The activity required inventories resource is used to view, create, update, or delete required inventories for a specific activity. Activity inventories are the inventories required to perform an activity.
Delete required inventories of an activity
Method: delete
Path: /rest/ofscCore/v1/activities/{activityId}/requiredInventories
Get required inventories of an activity
Method: get
Path: /rest/ofscCore/v1/activities/{activityId}/requiredInventories
Set required inventories for an activity
Method: put
Path: /rest/ofscCore/v1/activities/{activityId}/requiredInventories
Core/Activities/Activity Resource Preferences
The activity resource preferences resource is used to view, create, update, or delete resource preferences for a specific activity. Resource preferences identify whether certain resources are preferred, required, or forbidden from being assigned to the activity.
Delete resource preferences of an activity
Method: delete
Path: /rest/ofscCore/v1/activities/{activityId}/resourcePreferences
Get resource preferences of an activity
Method: get
Path: /rest/ofscCore/v1/activities/{activityId}/resourcePreferences
Set resource preferences of an activity
Method: put
Path: /rest/ofscCore/v1/activities/{activityId}/resourcePreferences
Core/Daily Extracts
The daily extract resource is used to view the dates for which daily extract files are available, view the daily extract files available for download on a specified date, and download the daily extract files for a specified date. Daily Extract is used to report on entities, such as activities, inventory, and messages for storage and further analysis. Extracted data is stored in the Daily Extract Database as a package of XML files.
Get a daily extract file
Method: get
Path: /rest/ofscCore/v1/folders/dailyExtract/folders/{dailyExtractDate}/files/{dailyExtractFilename}
Get a list of daily extract files for a date
Method: get
Path: /rest/ofscCore/v1/folders/dailyExtract/folders/{dailyExtractDate}/files
Get daily extract dates
Method: get
Path: /rest/ofscCore/v1/folders/dailyExtract/folders
Core/Events
The events resource is used to create, view, or delete a subscription. It is also used to view a list of events. The events resource is used to subscribe to events in Oracle Field Service Cloud and to get notifications about the events.
Create a subscription
Method: post
Path: /rest/ofscCore/v1/events/subscriptions
Delete a subscription
Method: delete
Path: /rest/ofscCore/v1/events/subscriptions/{subscriptionId}
Get events
Method: get
Path: /rest/ofscCore/v1/events
Get subscription details
Method: get
Path: /rest/ofscCore/v1/events/subscriptions/{subscriptionId}
Get subscriptions
Method: get
Path: /rest/ofscCore/v1/events/subscriptions
Core/Inventories
The inventories resource is used to view, create, update, or delete an inventory. It is also used to create or retrieve the file property for a specific inventory. Actions such as install inventory, deinstall inventory, and so on are also supported on this resource.
Create inventories
Method: post
Path: /rest/ofscCore/v1/inventories
Deinstall an inventory
Method: post
Path: /rest/ofscCore/v1/inventories/{inventoryId}/custom-actions/deinstall
Delete a file property
Method: delete
Path: /rest/ofscCore/v1/inventories/{inventoryId}/{propertyLabel}
Delete an Inventory
Method: delete
Path: /rest/ofscCore/v1/inventories/{inventoryId}
Get a file property
Method: get
Path: /rest/ofscCore/v1/inventories/{inventoryId}/{propertyLabel}
Get an inventory
Method: get
Path: /rest/ofscCore/v1/inventories/{inventoryId}
Install an inventory
Method: post
Path: /rest/ofscCore/v1/inventories/{inventoryId}/custom-actions/install
Set a file property
Method: put
Path: /rest/ofscCore/v1/inventories/{inventoryId}/{propertyLabel}
Undo deinstall an inventory
Method: post
Path: /rest/ofscCore/v1/inventories/{inventoryId}/custom-actions/undoDeinstall
Undo install an inventory
Method: post
Path: /rest/ofscCore/v1/inventories/{inventoryId}/custom-actions/undoInstall
Update an inventory
Method: patch
Path: /rest/ofscCore/v1/inventories/{inventoryId}
Core/Resources
The resources resource is used to view, create, or update a resource. It is also used to view child resources, view or create resource inventories, and so on. Actions such as bulk update and find matching resources are also supported on this resource. A resource is a defined company asset or an individual who performs an activity.
Bulk update resource inventories
Method: post
Path: /rest/ofscCore/v1/resources/custom-actions/bulkUpdateInventories
Bulk update resource work schedules
Method: post
Path: /rest/ofscCore/v1/resources/custom-actions/bulkUpdateWorkSchedules
Bulk update resource work skills
Method: post
Path: /rest/ofscCore/v1/resources/custom-actions/bulkUpdateWorkSkills
Bulk update resource work zones
Method: post
Path: /rest/ofscCore/v1/resources/custom-actions/bulkUpdateWorkZones
Create a resource
Method: put
Path: /rest/ofscCore/v1/resources/{resourceId}
Create a resource inventory
Method: post
Path: /rest/ofscCore/v1/resources/{resourceId}/inventories
Find matching resources
Method: post
Path: /rest/ofscCore/v1/resources/custom-actions/findMatchingResources
Find nearby activities
Method: get
Path: /rest/ofscCore/v1/resources/{resourceId}/findNearbyActivities
Find resources for urgent assignment
Method: post
Path: /rest/ofscCore/v1/resources/custom-actions/findResourcesForUrgentAssignment
Get a resource
Method: get
Path: /rest/ofscCore/v1/resources/{resourceId}
Get child resources
Method: get
Path: /rest/ofscCore/v1/resources/{resourceId}/children
Get resource descendants
Method: get
Path: /rest/ofscCore/v1/resources/{resourceId}/descendants
Get resource inventories
Method: get
Path: /rest/ofscCore/v1/resources/{resourceId}/inventories
Get resources
Method: get
Path: /rest/ofscCore/v1/resources
Install an inventory
Method: post
Path: /rest/ofscCore/v1/resources/{resourceId}/inventories/{inventoryId}/custom-actions/install
Update a resource
Method: patch
Path: /rest/ofscCore/v1/resources/{resourceId}
Core/Resources/Resource Assigned Users
The resource assigned users resource is used to assign and unassign users to resources.
Get resource users
Method: get
Path: /rest/ofscCore/v1/resources/{resourceId}/users
Set users
Method: put
Path: /rest/ofscCore/v1/resources/{resourceId}/users
Unset users
Method: delete
Path: /rest/ofscCore/v1/resources/{resourceId}/users
Core/Resources/Resource File Properties
The resource file properties resource is used to view, create, or delete file property for a specific resource. The file property may be used to transfer files such as documents, photos, signatures, and so on.
Delete a file property
Method: delete
Path: /rest/ofscCore/v1/resources/{resourceId}/{propertyLabel}
Get a file property
Method: get
Path: /rest/ofscCore/v1/resources/{resourceId}/{propertyLabel}
Set a file property
Method: put
Path: /rest/ofscCore/v1/resources/{resourceId}/{propertyLabel}
Core/Resources/Resource Locations
The resource locations resource is used to view, create, or delete locations for a specific resource. It is also used to create or update the location assignment. Location assignment means assigning the location as 'start', 'end', or 'home zone center' for the resource.
Create a resource location
Method: post
Path: /rest/ofscCore/v1/resources/{resourceId}/locations
Delete a resource location
Method: delete
Path: /rest/ofscCore/v1/resources/{resourceId}/locations/{locationId}
Delete assigned locations
Method: delete
Path: /rest/ofscCore/v1/resources/{resourceId}/assignedLocations/{date}
Get a resource location
Method: get
Path: /rest/ofscCore/v1/resources/{resourceId}/locations/{locationId}
Get assigned locations
Method: get
Path: /rest/ofscCore/v1/resources/{resourceId}/assignedLocations
Get resource locations
Method: get
Path: /rest/ofscCore/v1/resources/{resourceId}/locations
Set assigned locations
Method: put
Path: /rest/ofscCore/v1/resources/{resourceId}/assignedLocations
Update a resource location
Method: patch
Path: /rest/ofscCore/v1/resources/{resourceId}/locations/{locationId}
Update assigned locations
Method: patch
Path: /rest/ofscCore/v1/resources/{resourceId}/assignedLocations
Core/Resources/Resource Positions
The resource positions resource is used to create positions for resources, view last known positions of resources, view resources for specific areas, and view position history of a specific resource.
Get last known positions of resources
Method: get
Path: /rest/ofscCore/v1/resources/custom-actions/lastKnownPositions
Get position history of a resource
Method: get
Path: /rest/ofscCore/v1/resources/{resourceId}/positionHistory
Get resources in area
Method: get
Path: /rest/ofscCore/v1/resources/custom-actions/resourcesInArea
Set positions for resources
Method: post
Path: /rest/ofscCore/v1/resources/custom-actions/setPositions
Core/Resources/Resource Routes
The resource routes resource is used to view, activate, or deactivate a resource route. A route is a list of scheduled or non-scheduled activities assigned to a resource for a specific date.
Activate a resource route
Method: post
Path: /rest/ofscCore/v1/resources/{resourceId}/routes/{date}/custom-actions/activate
Deactivate a resource route
Method: post
Path: /rest/ofscCore/v1/resources/{resourceId}/routes/{date}/custom-actions/deactivate
Get a resource route
Method: get
Path: /rest/ofscCore/v1/resources/{resourceId}/routes/{date}
Core/Resources/Resource Work Plans
he resource work plans resource is used to view, create, or delete a work plan for a specific resource. Work plans may be used by a field manager in Oracle Field Service Cloud Mobility application to measure a planned amount of working time for a group resource for each day.
Create work plan for a resource
Method: post
Path: /rest/ofscCore/v1/resources/{resourceId}/plans
Delete work plan for a resource
Method: delete
Path: /rest/ofscCore/v1/resources/{resourceId}/plans
Get work plans for a resource
Method: get
Path: /rest/ofscCore/v1/resources/{resourceId}/plans
Core/Resources/Resource Work Schedules
The resource work schedules resource is used to view, create, or delete work schedules for a specific resource. Work schedule is a representation of the resource's work calendar, which includes working hours, working and non-working days, reasons for absence, and so on.
Delete a work schedule item
Method: delete
Path: /rest/ofscCore/v1/resources/{resourceId}/workSchedules/{scheduleItemId}
Get a calendar
Method: get
Path: /rest/ofscCore/v1/resources/{resourceId}/workSchedules/calendarView
Get calendars
Method: get
Path: /rest/ofscCore/v1/calendars
Get work schedules
Method: get
Path: /rest/ofscCore/v1/resources/{resourceId}/workSchedules
Set a work schedule
Method: post
Path: /rest/ofscCore/v1/resources/{resourceId}/workSchedules
Core/Resources/Resource Work Skills
The resource work skills resource is used to view, create, or delete work skills for a specific resource. The work skills functionality helps correlate the skill requirement for an incoming activity to the skills specified for each resource. This ensures that a resource is able to perform the activities assigned to it.
Delete a work skill
Method: delete
Path: /rest/ofscCore/v1/resources/{resourceId}/workSkills/{workSkill}
Get work skills
Method: get
Path: /rest/ofscCore/v1/resources/{resourceId}/workSkills
Set work skills
Method: post
Path: /rest/ofscCore/v1/resources/{resourceId}/workSkills
Core/Resources/Resource Work Zones
The resource work zones resource is used to view, create, or delete work zones for a specific resource. Work zones define the regional areas in which resources are permitted to work.
Delete a work zone item
Method: delete
Path: /rest/ofscCore/v1/resources/{resourceId}/workZones/{workZoneItemId}
Get work zones
Method: get
Path: /rest/ofscCore/v1/resources/{resourceId}/workZones
Set a work zone
Method: post
Path: /rest/ofscCore/v1/resources/{resourceId}/workZones
Core/Service Requests
The service requests resource is used to view and create service requests. A service request is a data container, which can be used to collect information about activities, resources, or inventories when used by integrated systems.
Create a service request
Method: post
Path: /rest/ofscCore/v1/serviceRequests
Get a service request
Method: get
Path: /rest/ofscCore/v1/serviceRequests/{requestId}
Core/Users
The users resource is used to view, create, update, or delete a specific user and view a list of users. A user is a person who uses Oracle Field Service Cloud or an entity that allows people or external software to access Oracle Field Service Cloud.
Create a user
Method: put
Path: /rest/ofscCore/v1/users/{login}
Delete a user
Method: delete
Path: /rest/ofscCore/v1/users/{login}
Get a user
Method: get
Path: /rest/ofscCore/v1/users/{login}
Get users
Method: get
Path: /rest/ofscCore/v1/users
Update a user
Method: patch
Path: /rest/ofscCore/v1/users/{login}
Core/Users/User Collaboration Groups
The user collaboration groups resource is used to view, create, or delete collaboration groups for a specific user. A user can be simultaneously associated with multiple collaboration groups.
Add collaboration groups
Method: post
Path: /rest/ofscCore/v1/users/{login}/collaborationGroups
Delete collaboration groups
Method: delete
Path: /rest/ofscCore/v1/users/{login}/collaborationGroups
Get collaboration groups
Method: get
Path: /rest/ofscCore/v1/users/{login}/collaborationGroups
Core/Users/User File Properties
The user file properties resource is used to view, create, or delete file property for a specified user. The file property may be used to transfer files such as documents, photos, signatures, and so on.
Delete a file property
Method: delete
Path: /rest/ofscCore/v1/users/{login}/{propertyLabel}
Get a file property
Method: get
Path: /rest/ofscCore/v1/users/{login}/{propertyLabel}
Set a file property
Method: put
Path: /rest/ofscCore/v1/users/{login}/{propertyLabel}
Metadata/Activity Type Groups
The group of activity types. Every activity type related to one group. For example, customer, internal, and so on.
Create or replace an activity type group
Method: put
Path: /rest/ofscMetadata/v1/activityTypeGroups/{label}
Get activity type groups
Method: get
Path: /rest/ofscMetadata/v1/activityTypeGroups
Get an activity type group
Method: get
Path: /rest/ofscMetadata/v1/activityTypeGroups/{label}
Metadata/Activity Types
The activity types resource is used to view the activity types. Every activity has a type which defines specific activity parameters. For example, installation, trouble call, lunch, team meeting, and so on.
Create or update an activity type
Method: put
Path: /rest/ofscMetadata/v1/activityTypes/{label}
Get activity types
Method: get
Path: /rest/ofscMetadata/v1/activityTypes
Get an activity type
Method: get
Path: /rest/ofscMetadata/v1/activityTypes/{label}
Metadata/Applications

The applications resource is used to create or update an application, update the API access of a specific application, view API access information for one or more applications, and view API configuration for one or more applications. An application is the third-party application that must be registered for making REST or SOAP API calls.

The application entities in Oracle Field Service Cloud are configured through Configuration, Applications. The application entities contain configuration settings for external system end-points and access level settings defined for different Oracle Field Service Cloud APIs.

Note: Certificate files and Client Secret values cannot be obtained or uploaded using the API and you need to manually configure the certificate files and client secret values for each application.

API permissions as a part of API Access entity can have different variants of structure for different APIs such as:

  • Access level based on Oracle Field Service Cloud entities, for example, Metadata API can be configured with Read-only access to Work Skill entity and Read-write access to Work Zone entity.
  • Access level based on API methods and field visibility layouts. For example, Activity Management API can be configured with access to specific methods or can have Read-Only or Read-Write access to specific activity fields.

Configuration: The application used to work with these methods should be set with appropriate permissions for Metadata API.

Important: The application should not have restrictions for Oracle Field Service Cloud resources and should have access to the company root resource.

Create or update an application
Method: put
Path: /rest/ofscMetadata/v1/applications/{label}
Get an application
Method: get
Path: /rest/ofscMetadata/v1/applications/{label}
Get API access for an application
Method: get
Path: /rest/ofscMetadata/v1/applications/{label}/apiAccess/{apiLabel}
Get API accesses for applications
Method: get
Path: /rest/ofscMetadata/v1/applications/{label}/apiAccess
Get applications
Method: get
Path: /rest/ofscMetadata/v1/applications
Update API access for applications
Method: patch
Path: /rest/ofscMetadata/v1/applications/{label}/apiAccess/{apiLabel}
Metadata/Capacity Areas
The capacity areas resource is used to view a specific capacity area or multiple capacity areas. A capacity area is a type of bucket used for capacity and quota management.
Get a capacity area
Method: get
Path: /rest/ofscMetadata/v1/capacityAreas/{label}
Get capacity areas
Method: get
Path: /rest/ofscMetadata/v1/capacityAreas
Metadata/Capacity Areas/Capacity Categories
The capacity categories resource is used to view a list of capacity categories. A capacity category is a combination of work skills and time slots used to estimate the time and skills required for a task.
Get capacity categories of a capacity area
Method: get
Path: /rest/ofscMetadata/v1/capacityAreas/{label}/capacityCategories
Metadata/Capacity Areas/Organizations
The organizations resource is used to view the organizations of the capacity area. An organization is an entity which aggregates field resources, tools, and vehicles to simplify management and reporting.
Get organizations of a capacity area
Method: get
Path: /rest/ofscMetadata/v1/capacityAreas/{label}/organizations
Metadata/Capacity Areas/Time Intervals
The time intervals resource is used to view the capacity areas of the specific capacity area group and the time intervals of the specific capacity area. The time interval is a customized time slot for booking activities. For example, instead of having a fixed timeslot from 8.00 am to 10 am, a time slot from 8.15 am to 9.20 am can be defined.
Get children of a capacity area group
Method: get
Path: /rest/ofscMetadata/v1/capacityAreas/{label}/children
Get time intervals of a capacity area
Method: get
Path: /rest/ofscMetadata/v1/capacityAreas/{label}/timeIntervals
Metadata/Capacity Areas/Time Slots
The time slots resource is used to view the time slots of the specific capacity area. The time slot is the amount of quota reserved for a capacity category at a specific time of the day.
Get time slots of a capacity area
Method: get
Path: /rest/ofscMetadata/v1/capacityAreas/{label}/timeSlots
Metadata/Capacity Areas/Work Zones
The work zones resource is used to view the work zones of the specific capacity area. A work zone is a defined geographical area in which a resource performs an activity.
Get work zones of a capacity area
Method: get
Path: /rest/ofscMetadata/v1/capacityAreas/{label}/workZones
Metadata/Capacity Categories
The capacity categories resource is used to create or update, view, and delete a specific capacity category or view a list of capacity categories. A capacity category is a combination of work skills and time slots used to estimate the time and skills required for a task.
Create or update a capacity category
Method: put
Path: /rest/ofscMetadata/v1/capacityCategories/{label}
Delete a capacity category
Method: delete
Path: /rest/ofscMetadata/v1/capacityCategories/{label}
Get a capacity category
Method: get
Path: /rest/ofscMetadata/v1/capacityCategories/{label}
Get capacity categories
Method: get
Path: /rest/ofscMetadata/v1/capacityCategories
Metadata/Forms
The forms resource is used to create or update, view, delete a specific form and view a list of forms in the Oracle Field Service Cloud application. A form is a screen that is configured using the data elements of the form.
Create or update a form
Method: put
Path: /rest/ofscMetadata/v1/forms/{label}
Delete a form
Method: delete
Path: /rest/ofscMetadata/v1/forms/{label}
Get a list of forms
Method: get
Path: /rest/ofscMetadata/v1/forms
Get form details
Method: get
Path: /rest/ofscMetadata/v1/forms/{label}
Metadata/Inventory Types
The inventory types resource is used to view the inventory types. The inventory type helps you distinguish between serialized and non-serialized inventory.
Get inventory types
Method: get
Path: /rest/ofscMetadata/v1/inventoryTypes
Metadata/Languages
The languages resource is used to view the languages. The available languages in the Oracle Field Service Cloud application are listed.
Get languages
Method: get
Path: /rest/ofscMetadata/v1/languages
Metadata/Map Layers
The map layers resource is used to view, create, populate, or replace a custom map layer. It is also used to view the import status of the custom map layer. The map layer displays additional elements overlaid on top of the map. For example, demographic information such as population density and the locations of gas stations, pipelines, and other geographical entities.
Check custom map layer population status
Method: get
Path: /rest/ofscMetadata/v1/mapLayers/custom-actions/populateLayers/{downloadId}
Create a custom map layer
Method: post
Path: /rest/ofscMetadata/v1/mapLayers
Get a custom map layer
Method: get
Path: /rest/ofscMetadata/v1/mapLayers/{label}
Get custom map layers
Method: get
Path: /rest/ofscMetadata/v1/mapLayers
Populate a custom map layer
Method: post
Path: /rest/ofscMetadata/v1/mapLayers/custom-actions/populateLayers
Replace a custom map layer
Method: put
Path: /rest/ofscMetadata/v1/mapLayers/{label}
Metadata/Non-working Reasons
The non-working reasons resource is used to view the non-working reasons. A non-working reason is a calendar setting used to indicate why a resource is or will be absent. Typical non-working reasons include illness, holiday, vacation, and bereavement.
Get non-working reasons
Method: get
Path: /rest/ofscMetadata/v1/nonWorkingReasons
Metadata/Organizations
The organizations resource is used to view a specific organization resource and a list of organization resources. An organization is either a main company, a subdivision of the main company, or a third-party company that has a contract with the main company.
Get an organization
Method: get
Path: /rest/ofscMetadata/v1/organizations/{label}
Get organizations
Method: get
Path: /rest/ofscMetadata/v1/organizations
Metadata/Properties
The properties resource is used to view, create, or update a property. It is also used to view and update enumeration values of a property. Properties define user interface fields such as field length, field type, and valid values.
Create or replace a property
Method: put
Path: /rest/ofscMetadata/v1/properties/{label}
Get a property
Method: get
Path: /rest/ofscMetadata/v1/properties/{label}
Get enumeration values of a property
Method: get
Path: /rest/ofscMetadata/v1/properties/{label}/enumerationList
Get properties
Method: get
Path: /rest/ofscMetadata/v1/properties
Update a property
Method: patch
Path: /rest/ofscMetadata/v1/properties/{label}
Update or replace enumeration values of a property
Method: put
Path: /rest/ofscMetadata/v1/properties/{label}/enumerationList
Metadata/Resource Types
The resource types resource is used to view the resource types. A resource type is a set of characteristics applied to a resource. The default resource types are group, bucket, and resource.
Get resource types
Method: get
Path: /rest/ofscMetadata/v1/resourceTypes
Metadata/Time Slots
The time slots resource is used to view the time slots. The time slot is an interval that defines when an activity has to be started.
Get time slots
Method: get
Path: /rest/ofscMetadata/v1/timeSlots
Metadata/Work Skills
The work skills resource is used to view, create, update, or delete a work skill. The work skill is a skill or competency of a resource that has to perform an activity.
Create or replace a work skill
Method: put
Path: /rest/ofscMetadata/v1/workSkills/{label}
Delete a work skill
Method: delete
Path: /rest/ofscMetadata/v1/workSkills/{label}
Get a work skill
Method: get
Path: /rest/ofscMetadata/v1/workSkills/{label}
Get work skills
Method: get
Path: /rest/ofscMetadata/v1/workSkills
Metadata/Work Skills/Work Skill Conditions
The work skill conditions resource is used to update or view the work skill conditions. The work skill condition is the data that Oracle Field Service Cloud uses to assign work skills to an activity.
Get work skill conditions
Method: get
Path: /rest/ofscMetadata/v1/workSkillConditions
Replace work skill conditions
Method: put
Path: /rest/ofscMetadata/v1/workSkillConditions
Metadata/Work Skills/Work Skill Groups
The work skill groups resource is used to view, create, update, or delete a work skill group. The work skill group is a collection of work skills used to assign skills to resources.
Create or replace a work skill group
Method: put
Path: /rest/ofscMetadata/v1/workSkillGroups/{label}
Delete a work skill group
Method: delete
Path: /rest/ofscMetadata/v1/workSkillGroups/{label}
Get a work skill group
Method: get
Path: /rest/ofscMetadata/v1/workSkillGroups/{label}
Get work skill groups
Method: get
Path: /rest/ofscMetadata/v1/workSkillGroups
Metadata/Work Zone Key
The work zones key resource is used to represent the OFSC configuration of the key which identifies activities work zones.
Get the work zone key
Method: get
Path: /rest/ofscMetadata/v1/workZoneKey
Metadata/Work Zones
The work zones resource is used to view, create, or update a work zone. It is also used to replace or update multiple work zones through a single request. The work zone is the region where a resource performs the activity.
Bulk replace work zones
Method: put
Path: /rest/ofscMetadata/v1/workZones
Bulk update work zones
Method: patch
Path: /rest/ofscMetadata/v1/workZones
Create a work zone
Method: post
Path: /rest/ofscMetadata/v1/workZones
Get a work zone
Method: get
Path: /rest/ofscMetadata/v1/workZones/{label}
Get work zones
Method: get
Path: /rest/ofscMetadata/v1/workZones
Replace a work zone
Method: put
Path: /rest/ofscMetadata/v1/workZones/{label}
Metadata/Work Zones/Work Zone Shapes
The work zone shapes resource is used to load the work zone shapefiles and view the status of the work zone shapefile import operation. The work zone shape is used as a visual representation of a work zone on the map and as a tool for subtle definition of work zones.
Get status of shape upload
Method: get
Path: /rest/ofscMetadata/v1/workZones/custom-actions/populateShapes/{downloadId}
Start shape upload
Method: post
Path: /rest/ofscMetadata/v1/workZones/custom-actions/populateShapes
OAuth2/Token Service
The token service resource is used to obtain the access token of the application. The OAuth2 token service issues access tokens that are used for authenticating REST API requests.
Get an access token
Method: post
Path: /rest/oauthTokenService/v2/token
Get an access token (Deprecated)
Method: post
Path: /rest/oauthTokenService/v1/token
Parts Catalog

The parts catalog resource is used to create a catalog, create or update a catalog item, and delete a catalog item. This helps to synchronize the catalog from an external data source using the Oracle Integration Cloud (OIC) adapter. The parts catalog is typically used to search for spare parts in the catalog.

Configuration: The permissions to the Parts Catalog API from the Configuration, Applications (API Access) screen must be granted. Since the Parts Catalog API is not related to a resource in Oracle Field Service Cloud (OFSC), the Allow access only to certain resources parameter can be ignored.

The Parts Catalog service is modified to manage the updates internally so that it does not cause constant catalog redistribution to the technician devices. All the incremental updates to the catalog are collected and applied after a certain period of time, which could take up to 4 hours.

Create a catalog
Method: put
Path: /rest/ofscPartsCatalog/v1/catalogs/{catalog}/{language}
Create or update a catalog item
Method: put
Path: /rest/ofscPartsCatalog/v1/catalogs/{catalog}/{language}/{itemLabel}
Remove a catalog item
Method: delete
Path: /rest/ofscPartsCatalog/v1/catalogs/{catalog}/{language}/{itemLabel}
Statistics/Activity Duration
The activity duration resource is used to view and modify the activity durations in Oracle Field Service Cloud. There might be scenarios where the customer has a specific activity duration they want to use to achieve some business objective. In such cases, they can use this operation to view and override the system estimated durations.
Get activity duration statistics
Method: get
Path: /rest/ofscStatistics/v1/activityDurationStats
Update activity duration statistics
Method: patch
Path: /rest/ofscStatistics/v1/activityDurationStats
Statistics/Activity Travel
The activity travel resource is used to obtain and modify the travel durations in Oracle Field Service Cloud. There might be scenarios where the customer has a specific travel duration they want to use to achieve some business objective. In such cases, they can use this operation to view and override the system estimated durations.
Get activity travel statistics
Method: get
Path: /rest/ofscStatistics/v1/activityTravelStats
Update activity travel statistics
Method: patch
Path: /rest/ofscStatistics/v1/activityTravelStats