SOAP APIs to REST APIs Mapping
Note:
This page is provided only for historical reference. The content on this page is not applicable for this release, because the corresponding SOAP APIs were removed from release 20c and above.If you have already integrated Oracle Field Service using SOAP APIs, then you can use this mapping for Oracle Field Service integrations using REST APIs.
Activity Management API (V3)
This table lists the SOAP API methods and their corresponding REST API methods for Activity Management.
| SOAP API Method | REST API Method |
|---|---|
|
get_route |
GET /resources/{resourceId}/routes/{date} |
|
start_route |
POST /resources/{resourceId}/routes/{date}/custom-actions/activate |
|
end_route |
POST /resources/{resourceId}/routes/{date}/custom-actions/deactivate |
|
create_activity |
POST /activities |
|
get_activity |
GET /activities/{activityId} |
|
get_activity_work_skills |
GET /activities/{activityId}/workSkills |
|
get_activities |
GET /rest/ofscCore/v1/activities |
|
get_multiday_activities |
GET /resources/{resourceId}/routes/multiday |
|
get_multiday_activity_parts |
GET /activities/{activityId}/multidaySegments |
|
update_activity |
PATCH /activities/{activityId} |
|
reopen_activity |
POST /activities/{activityId}/custom-actions/reopen |
|
search_activities |
GET /activities/{activityId}/custom-actions/search |
|
set_resource_preferences |
PUT /activities/{activityId}/resourcePreferences |
|
get_resource_preferences |
GET /activities/{activityId}/resourcePreferences |
|
delay_activity |
POST /activities/{activityId}/custom-actions/delay |
|
start_activity |
POST /activities/{activityId}/custom-actions/start |
|
complete_activity |
POST /activities/{activityId}/custom-actions/complete |
|
cancel_activity |
POST /activities/{activityId}/custom-actions/cancel |
|
suspend_activity |
POST /activities/{activityId}/custom-actions/suspend |
|
prework_activity |
POST /activities/{activityId}/custom-actions/startPrework |
|
get_activity_links |
GET /activities/{activityId}/linkedActivities/{activityId2}/linkTypes/{link_type} |
|
link_activities |
PUT /activities/{activityId}/linkedActivities/{activityId2}/linkTypes/{link_type} |
|
unlink_activities |
DELETE /activities/{activityId}/linkedActivities/{activityId2} |
|
set_file |
PUT /activities/{activityId}/{fileproperty} |
|
get_file |
GET /activities/{activityId}/{fileproperty} |
|
delete_file |
DELETE /activities/{activityId}/{fileproperty} |
|
set_required_inventories |
PUT /activities/{activityId}/requiredInventories |
|
get_required_inventories |
GET /activities/{activityId}/requiredInventories |
|
create_customer_inventory |
POST /activities/{activityId}/customerInventories |
|
get_customer_inventory_list |
GET /activities/{activityId}/customerInventories |
|
get_resource_inventory_list |
GET /resources/{resourceId}/inventories |
|
get_inventory |
GET /inventories |
|
install_inventory |
POST /inventories/{inventoryId}/custom-actions/install |
|
exchange_inventory |
Planned for a future release. |
|
delete_inventory |
DELETE /inventories/{inventoryId} |
|
update_inventory |
PATCH /inventories/{inventoryId} |
|
undo_install_inventory |
POST /inventories/{inventoryId}/custom-actions/undoInstall |
|
deinstall_inventory |
POST /inventories/{inventoryId}/custom-actions/deinstall |
|
undo_deinstall_inventory |
POST /inventories/{inventoryId}/custom-actions/undoDeinstall |
|
create_resource_inventory |
To create an inventory: POST /inventories To specifically create resource inventories: POST /resources/{resourceId}/inventories |
|
create_resource_request |
POST /rest/ofscCore/v1/serviceRequests |
|
get_resource_request |
GET /rest/ofscCore/v1/serviceRequests/{requestId} |
|
create_customer_request |
POST /rest/ofscCore/v1/serviceRequests |
|
get_customer_request_list |
GET /rest/ofscCore/v1/serviceRequests/{requestId} |
|
create_inventory_request |
POST /rest/ofscCore/v1/serviceRequests |
|
get_inventory_request_list |
GET /rest/ofscCore/v1/serviceRequests/{requestId} |
|
get_request |
GET /rest/ofscCore/v1/serviceRequests/{requestId} |
This table lists the SOAP API Activity parameters and their corresponding REST API Activity parameters.
| SOAP API Parameter | REST API Parameter |
|---|---|
|
id |
activityId |
|
appt_number |
apptNumber |
|
resource_id |
resourceId |
|
type |
recordType |
|
status |
status |
|
worktype |
activityType |
|
workzone |
workZone |
|
duration |
duration |
|
time_slot |
timeSlot |
|
service_window_start |
serviceWindowStart |
|
service_window_end |
serviceWindowEnd |
|
delivery_window_start |
deliveryWindowStart |
|
delivery_window_end |
deliveryWindowEnd |
|
sla_window_start |
slaWindowStart |
|
sla_window_end |
slaWindowEnd |
|
name |
customerName |
|
customer_number |
customerNumber |
|
phone |
customerPhone |
|
|
customerEmail |
|
cell |
customerCell |
|
address |
streetAddress |
|
city |
city |
|
zip |
postalCode |
|
state |
stateProvince |
|
language |
language |
|
reminder_time |
reminderTime |
|
time_zone |
timeZone |
|
coord_status |
This parameter is not supported in REST API |
|
coordx |
latitude |
|
coordy |
longitude |
|
start_time |
startTime |
|
end_time |
endTime |
|
date |
date |
|
team_id |
teamResourceId |
|
position_in_route |
positionInRoute |
Resource Management API (V3)
This table lists the SOAP API methods and their corresponding REST API methods for Resource Management.
| SOAP API Method | REST API Method |
|---|---|
|
insert_user |
PUT /users/{login} |
|
update_user |
PATCH /users/{login} |
|
delete_user |
DELETE /users/{login} |
|
get_user |
GET /users/{login} |
|
get_users_list |
GET /users |
|
insert_resource |
PUT /resources/{resourceId} |
|
update_resource |
PUT /resources/{resourceId} |
|
get_resource |
GET /resources/{resourceId} |
|
get_resources_list |
GET /resources |
|
set_resources_calendars |
POST /resources/{resourceId}/workSchedules |
|
get_resources_calendars |
GET /resources/{resourceId}/workSchedules |
|
set_resources_zones |
POST /resources/{resourceId}/workZones |
|
get_resources_zones |
GET /resources/{resourceId}/workZones |
|
set_resources_skills |
POST /resources/{resourceId}/workSkills |
|
get_resources_skills |
GET /resources/{resourceId}/workSkills |
|
update_locations |
To update an existing location: PATCH /resources/{resourceId}/locations/{locationId} To create a new location: POST /resources/{resourceId}/locations |
|
delete_locations |
DELETE /resources/{resourceId}/locations/{locationId} |
|
get_locations |
GET /resources/{resourceId}/locations |
|
get_resources_locations |
GET /resources/{resourceId}/assignedLocations |
|
set_resources_locations |
To add or update resource locations: PUT /resources/{resourceId}/assignedLocations To delete resource locations: DELETE /resources/{resourceId}/assignedLocations |
This table lists the SOAP API Resource parameters and their corresponding REST API Resource parameters.
| SOAP API Parameter | REST API Parameter |
|---|---|
|
id |
resourceId |
|
status |
status |
|
parent_id |
parentResourceId |
|
type |
resourceType |
|
name |
name |
|
language |
language |
|
|
|
|
phone |
phone |
|
time_zone |
timeZone |
|
date_format |
dateFormat |
|
time_format |
timeFormat |