Available Oracle Field Service Cloud APIs

Tanisha Ray

Updated November 22, 2024 17:18

When you configure an export, import, or other type of flow step using the prebuilt Oracle Field Service Cloud connector, you can select any of the API operations listed below*, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Oracle Field Service Cloud API documentation. *You can also create a composite endpoint for this application in HTTP mode.

Resource	API endpoint	Export	Import
Capacity available capacity	Get available capacity	X
Capacity booking	Get activity booking options	X
Capacity booking	Show booking gr ID		X
Capacity booking closing schedule	Get booking closing schedule	X
	Create or update booking closing schedules		X
	Get booking statuses	X
	Update booking statuses		X
Capacity quota V1	Get quota	X
Capacity quota V1	Create or update quota		X
Capacity quota V2	Get quota	X
Capacity quota V2	Create or update quota		X
Collaboration address book	Get address book	X
Collaboration chats	Start a new chat		X
	Leave a chat		X
	Get messages	X
	Send a message		X
	Get participants	X
	Invite a participant		X
Core activities	Get activities	X
	Create an activity		X
	Get an activity	X
	Update an activity		X
	Get individual segments of a segmentable activity	X
	Get capacity categories of activity	X
	Search for activities	X
	Bulk update activities		X
	Where is my technician	X
Core activities: Activity actions	Delete an activity		X
	Start prework		X
	Reopen an activity		X
	Delay an activity		X
	Cancel an activity		X
	Start an activity		X
	Update the activity status to enroute		X
	Change activity status from enroute to pending		X
	Suspend an activity		X
	Move an activity		X
	Complete an activity		X
	Update the activity status to notdone		X
Core activities: Activity file properties	Get a file property	X
	Set a file property		X
	Delete a file property		X
Core activities: Activity inventories	Get customer inventories	X
	Create a customer inventory		X
	Get installed inventories	X
	Get deinstalled inventories	X
Core activities: Activity links	Get activity links	X
	Create an activity link		X
	Delete all activity links		X
	Get activity link details	X
	Replace an activity link		X
	Delete an activity link		X
Core activities: Activity required inventories	Get required inventories of an activity	X
	Set required inventories for an activity		X
	Delete required inventories of an activity		X
	Get resource preferences of an activity	X
	Set resource preferences of an activity		X
	Delete resource preferences of an activity		X
Core activities submitted forms	Get associated submitted forms	X
Core events	Get subscription details	X
	Delete a subscription		X
	Get subscriptions	X
	Create a subscription		X
	Get events	X
Core extracts daily extracts	Get daily extract dates	X
	Get a list of daily extract files for a date	X
	Get a daily extract file	X
Core inventories	Create inventories		X
	Get an inventory	X
	Delete an inventory		X
	Update an inventory		X
	Get a file property	X
	Set a file property		X
	Delete a file property		X
	Undo install an inventory		X
	Undo deinstall an inventory		X
	Install an inventory		X
	Deinstall an inventory		X
Core Resources	Get resources	X
	Get child resources	X
	Get resource descendants	X
	Get a list of assistants	X
	Get a resource	X
	Create a resource		X
	Update a resource		X
	Get resource inventories	X
	Create a resource inventory		X
	Install an inventory		X
	Find nearby activities	X
	Bulk update resource work schedules		X
	Bulk update resource work skills		X
	Bulk update resource work zones		X
	Bulk update resource inventories		X
	Find matching resources		X
	Find resources for urgent assignment		X
Core Resources: Resource assigned users	Get resource users	X
	Set users		X
	Unset users		X
Core Resources: Resource file properties	Get a file property	X
	Set a file property		X
	Delete a file property		X
Core Resources: Resource locations	Get resource locations	X
	Create a resource location		X
	Get a resource location	X
	Delete a resource location		X
	Update a resource location		X
	Get assigned locations	X
	Set assigned locations		X
	Update assigned locations		X
	Delete assigned locations		X
	Get position history of a resource	X
	Set positions for resources		X
	Get last known positions of resources	X
	Get resources in area	X
Core Resources: Resource routes	Get a resource route	X
	Activate a resource route		X
	Deactivate a resource route		X
Core Resources: Resource work plans	Get work plans for a resource	X
	Create work plan for a resource		X
	Delete work plan for a resource		X
Core Resources: Resource work schedules	Get work schedules	X
	Set a work schedule		X
	Delete a work schedule item		X
	Get a calendar	X
	Get calendars	X
Core Resources: Resource work skills	Get work skills	X
	Set work skills		X
	Delete a work skill		X
Core Resources: Resource work zones	Get resource work zones	X
	Set a resource work zone		X
	Delete a resource work zone item		X
Core service requests	Get a service request	X
	Create a service request		X
	Get a file property	X
Core users	Get users	X
	Get a user	X
	Create a user		X
	Delete a user		X
	Update a user		X
Core users: User collaboration groups	Get collaboration groups	X
	Add collaboration groups		X
	Delete collaboration groups		X
Core users: User file properties	Get a file property	X
	Set a file property		X
	Delete a file property		X
Metadata activity type groups	Get activity type groups	X
	Get an activity type group	X
	Create or replace an activity type group		X
Metadata activity types	Get activity types	X
	Get an activity type	X
	Create or update an activity type		X
Metadata applications	Get applications	X
	Get an application	X
	Create or update an application		X
	Get api accesses for applications	X
	Get api access for an application	X
	Update api access for applications		X
	Generate client secret for applications		X
Metadata capacity areas	Get capacity areas	X
Metadata capacity areas	Get a capacity area	X
Metadata capacity areas capacity categories	Get capacity categories of a capacity area	X
Metadata capacity areas organizations	Get organizations of a capacity area	X
Metadata capacity areas time intervals	Get time intervals of a capacity area	X
Metadata capacity areas time intervals	Get children of a capacity area group	X
Metadata capacity areas time slots	Get time slots of a capacity area	X
Metadata capacity areas work zones	Get work zones of a capacity area	X
Metadata capacity areas work zones	Get work zones of a capacity area (deprecated)	X
Metadata capacity categories	Get capacity categories	X
	Get a capacity category	X
	Create or update a capacity category		X
	Delete a capacity category		X
Metadata forms	Get a list of forms	X
	Get form details	X
	Create or update a form		X
	Delete a form		X
Metadata inventory types	Get inventory types	X
	Get an inventory type	X
	Create or update an inventory type		X
Metadata languages	Get languages	X
Metadata link templates	Get link templates	X
	Get a link template	X
	Create a link template		X
	Update a link template		X
Metadata map layers	Get custom map layers	X
	Create a custom map layer		X
	Get a custom map layer	X
	Replace a custom map layer		X
	Check custom map layer population status	X
	Populate a custom map layer		X
Metadata non: Working reasons	Get non-working reasons	X
Metadata organizations	Get organizations	X
Metadata organizations	Get an organization	X
Metadata plugins	Import plugins		X
Metadata plugins	Install standard plugin		X
Metadata properties	Get properties	X
	Get a property	X
	Create or replace a property		X
	Update a property		X
	Get enumeration values of a property	X
	Update or replace enumeration values of a property		X
Metadata resource types	Get resource types	X
Metadata routing profiles	Get routing profiles labels	X
	Get routing plans labels	X
	Get a routing plan	X
	Add a routing plan		X
	Force add a routing plan		X
	Start routing plan		X
Metadata time slots	Get time slots	X
Metadata work skills	Get work skills	X
	Get a work skill	X
	Create or replace a work skill		X
	Delete a work skill		X
Metadata work skills work skill conditions	Get work skill conditions	X
Metadata work skills work skill conditions	Replace work skill conditions		X
Metadata work skills work skill groups	Get work skill groups	X
	Get a work skill group	X
	Create or replace a work skill group		X
	Delete a work skill group		X
Metadata work zone key	Get the work zone key	X
Metadata work zones	Get work zones	X
	Bulk replace work zones		X
	Create a work zone		X
	Bulk update work zones		X
	Get a work zone	X
	Replace a work zone		X
Metadata work zones work zone shapes	Get status of shape upload	X
Metadata work zones work zone shapes	Start shape upload		X
Parts catalog	Create a catalog		X
	Create or update a catalog item		X
	Remove a catalog item		X
Statistics activity duration	Get activity duration statistics	X
Statistics activity duration	Update activity duration statistics		X
Statistics activity travel	Get activity travel statistics	X
Statistics activity travel	Update activity travel statistics		X
Statistics airline distance based travel	Get airline distance based travel	X
Statistics airline distance based travel	Update airline distance based travel		X