All REST Endpoints

Capacity/Available Capacity
Available Capacity operations
Get available capacity
Method: get
Path: /rest/ofscCapacity/v1/capacity
Capacity/Booking
Booking operations
Get activity booking options
Method: get
Path: /rest/ofscCapacity/v1/activityBookingOptions
Capacity/Booking Closing Schedule
Booking Closing Schedule operations
Get booking closing schedule
Method: get
Path: /rest/ofscCapacity/v1/bookingClosingSchedule
Get booking status
Method: get
Path: /rest/ofscCapacity/v1/bookingStatuses
Update/Set booking closing schedule
Method: patch
Path: /rest/ofscCapacity/v1/bookingClosingSchedule
Update/Set booking status
Method: patch
Path: /rest/ofscCapacity/v1/bookingStatuses
Capacity/Quota
Quota operations
Create/Update quota
Method: patch
Path: /rest/ofscCapacity/v1/quota
Get quota
Method: get
Path: /rest/ofscCapacity/v1/quota
Core/Activities
Activity operations
Bulk update activities
Method: post
Path: /rest/ofscCore/v1/activities/custom-actions/bulkUpdate
Create new activity
Method: post
Path: /rest/ofscCore/v1/activities
Get activities
Method: get
Path: /rest/ofscCore/v1/activities
Get activity
Method: get
Path: /rest/ofscCore/v1/activities/{activityId}
Get segments of multiday activity
Method: get
Path: /rest/ofscCore/v1/activities/{activityId}/multidaySegments
Search for activities
Method: get
Path: /rest/ofscCore/v1/activities/custom-actions/search
Update activity
Method: patch
Path: /rest/ofscCore/v1/activities/{activityId}
Where is my technician
Method: get
Path: /rest/ofscCore/v1/whereIsMyTech
Core/Activities/Activity actions
Activity actions
Cancel activity
Method: post
Path: /rest/ofscCore/v1/activities/{activityId}/custom-actions/cancel
Complete activity
Method: post
Path: /rest/ofscCore/v1/activities/{activityId}/custom-actions/complete
Delay activity
Method: post
Path: /rest/ofscCore/v1/activities/{activityId}/custom-actions/delay
Delete activity
Method: delete
Path: /rest/ofscCore/v1/activities/{activityId}
Move activity
Method: post
Path: /rest/ofscCore/v1/activities/{activityId}/custom-actions/move
NotDone activity
Method: post
Path: /rest/ofscCore/v1/activities/{activityId}/custom-actions/notDone
Reopen activity
Method: post
Path: /rest/ofscCore/v1/activities/{activityId}/custom-actions/reopen
Start 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 activity
Method: post
Path: /rest/ofscCore/v1/activities/{activityId}/custom-actions/suspend
Core/Activities/Activity file properties
Activity file properties
Delete file property
Method: delete
Path: /rest/ofscCore/v1/activities/{activityId}/{propertyLabel}
Get file property
Method: get
Path: /rest/ofscCore/v1/activities/{activityId}/{propertyLabel}
Set file property
Method: put
Path: /rest/ofscCore/v1/activities/{activityId}/{propertyLabel}
Core/Activities/Activity inventories
Activity inventories
Create 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
Activity links
Create activity link
Method: post
Path: /rest/ofscCore/v1/activities/{activityId}/linkedActivities
Delete activity link
Method: delete
Path: /rest/ofscCore/v1/activities/{activityId}/linkedActivities/{linkedActivityId}/linkTypes/{linkType}
Delete all activity links
Method: delete
Path: /rest/ofscCore/v1/activities/{activityId}/linkedActivities
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 activity link
Method: put
Path: /rest/ofscCore/v1/activities/{activityId}/linkedActivities/{linkedActivityId}/linkTypes/{linkType}
Core/Activities/Activity required inventories
Activity required inventories
Delete Required Inventories of activity
Method: delete
Path: /rest/ofscCore/v1/activities/{activityId}/requiredInventories
Get Required Inventories of activity
Method: get
Path: /rest/ofscCore/v1/activities/{activityId}/requiredInventories
Set Required Inventories of activity
Method: put
Path: /rest/ofscCore/v1/activities/{activityId}/requiredInventories
Core/Activities/Activity resource preferences
Activity resource preferences
Delete Resource Preferences of activity
Method: delete
Path: /rest/ofscCore/v1/activities/{activityId}/resourcePreferences
Get Resource Preferences of activity
Method: get
Path: /rest/ofscCore/v1/activities/{activityId}/resourcePreferences
Set Resource Preferences of activity
Method: put
Path: /rest/ofscCore/v1/activities/{activityId}/resourcePreferences
Core/Daily Extracts
The operations from the Core/Daily Extracts category.
Download daily extract file
Method: get
Path: /rest/ofscCore/v1/folders/dailyExtract/folders/{dailyExtractDate}/files/{dailyExtractFilename}
Get daily extract dates
Method: get
Path: /rest/ofscCore/v1/folders/dailyExtract/folders
Get list of daily extract files for a date
Method: get
Path: /rest/ofscCore/v1/folders/dailyExtract/folders/{dailyExtractDate}/files
Core/Events
Operations that let client subscribe to Field Service Cloud Service events, and get notifications these events occur
Create subscription
Method: post
Path: /rest/ofscCore/v1/events/subscriptions
Delete subscription
Method: delete
Path: /rest/ofscCore/v1/events/subscriptions/{subscriptionId}
Get events
Method: get
Path: /rest/ofscCore/v1/events
Get list of subscriptions
Method: get
Path: /rest/ofscCore/v1/events/subscriptions
Get subscription
Method: get
Path: /rest/ofscCore/v1/events/subscriptions/{subscriptionId}
Core/Inventories
Inventory operations
Create Inventory
Method: post
Path: /rest/ofscCore/v1/inventories
Deinstall Inventory
Method: post
Path: /rest/ofscCore/v1/inventories/{inventoryId}/custom-actions/deinstall
Delete file property
Method: delete
Path: /rest/ofscCore/v1/inventories/{inventoryId}/{propertyLabel}
Delete Inventory
Method: delete
Path: /rest/ofscCore/v1/inventories/{inventoryId}
Get file property
Method: get
Path: /rest/ofscCore/v1/inventories/{inventoryId}/{propertyLabel}
Get Inventory
Method: get
Path: /rest/ofscCore/v1/inventories/{inventoryId}
Install Inventory
Method: post
Path: /rest/ofscCore/v1/inventories/{inventoryId}/custom-actions/install
Set file property
Method: put
Path: /rest/ofscCore/v1/inventories/{inventoryId}/{propertyLabel}
Undo Deinstall Inventory
Method: post
Path: /rest/ofscCore/v1/inventories/{inventoryId}/custom-actions/undoDeinstall
Undo Install Inventory
Method: post
Path: /rest/ofscCore/v1/inventories/{inventoryId}/custom-actions/undoInstall
Update Inventory
Method: patch
Path: /rest/ofscCore/v1/inventories/{inventoryId}
Core/Resources
Resource operations
Create resource
Method: put
Path: /rest/ofscCore/v1/resources/{resourceId}
Create resource inventory
Method: post
Path: /rest/ofscCore/v1/resources/{resourceId}/inventories
Find matching resources
Method: post
Path: /rest/ofscCore/v1/resources/custom-actions/findMatchingResources
Get resource
Method: get
Path: /rest/ofscCore/v1/resources/{resourceId}
Get resource children
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 inventory
Method: post
Path: /rest/ofscCore/v1/resources/{resourceId}/inventories/{inventoryId}/custom-actions/install
Update resource
Method: patch
Path: /rest/ofscCore/v1/resources/{resourceId}
Core/Resources/Resource assigned users
Resource assigned users
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
Resource file properties
Delete file property
Method: delete
Path: /rest/ofscCore/v1/resources/{resourceId}/{propertyLabel}
Get file property
Method: get
Path: /rest/ofscCore/v1/resources/{resourceId}/{propertyLabel}
Set file property
Method: put
Path: /rest/ofscCore/v1/resources/{resourceId}/{propertyLabel}
Core/Resources/Resource locations
Resource locations
Create resource location
Method: post
Path: /rest/ofscCore/v1/resources/{resourceId}/locations
Delete resource location
Method: delete
Path: /rest/ofscCore/v1/resources/{resourceId}/locations/{locationId}
Get assigned locations
Method: get
Path: /rest/ofscCore/v1/resources/{resourceId}/assignedLocations
Get resource location
Method: get
Path: /rest/ofscCore/v1/resources/{resourceId}/locations/{locationId}
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 resource location
Method: patch
Path: /rest/ofscCore/v1/resources/{resourceId}/locations/{locationId}
Core/Resources/Resource routes
Resource routes
Activate resource route
Method: post
Path: /rest/ofscCore/v1/resources/{resourceId}/routes/{date}/custom-actions/activate
Deactivate resource route
Method: post
Path: /rest/ofscCore/v1/resources/{resourceId}/routes/{date}/custom-actions/deactivate
Get resource route
Method: get
Path: /rest/ofscCore/v1/resources/{resourceId}/routes/{date}
Core/Resources/Resource work plans
Resource work plans
Create work plan for resource
Method: post
Path: /rest/ofscCore/v1/resources/{resourceId}/plans
Delete work plan for resource
Method: delete
Path: /rest/ofscCore/v1/resources/{resourceId}/plans
Get work plans for resource
Method: get
Path: /rest/ofscCore/v1/resources/{resourceId}/plans
Core/Resources/Resource work schedules
Resource work schedules
Delete work schedule item
Method: delete
Path: /rest/ofscCore/v1/resources/{resourceId}/workSchedules/{scheduleItemId}
Get calendar
Method: get
Path: /rest/ofscCore/v1/resources/{resourceId}/workSchedules/calendarView
Get work schedules
Method: get
Path: /rest/ofscCore/v1/resources/{resourceId}/workSchedules
Set work schedule
Method: post
Path: /rest/ofscCore/v1/resources/{resourceId}/workSchedules
Core/Resources/Resource work skills
Resource work skills
Delete 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
Resource work zones
Delete 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 work zone
Method: post
Path: /rest/ofscCore/v1/resources/{resourceId}/workZones
Core/Users
User operations
Create user
Method: put
Path: /rest/ofscCore/v1/users/{login}
Delete user
Method: delete
Path: /rest/ofscCore/v1/users/{login}
Get user
Method: get
Path: /rest/ofscCore/v1/users/{login}
Get users
Method: get
Path: /rest/ofscCore/v1/users
Update user
Method: patch
Path: /rest/ofscCore/v1/users/{login}
Core/Users/User collaboration groups
User 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
User file properties
Delete file property
Method: delete
Path: /rest/ofscCore/v1/users/{login}/{propertyLabel}
Get file property
Method: get
Path: /rest/ofscCore/v1/users/{login}/{propertyLabel}
Set file property
Method: put
Path: /rest/ofscCore/v1/users/{login}/{propertyLabel}
Metadata/Capacity Areas
Metadata/Capacity Areas
Get 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
Metadata/Capacity Areas/Capacity Categories
Get capacity categories of area
Method: get
Path: /rest/ofscMetadata/v1/capacityAreas/{label}/capacityCategories
Metadata/Capacity Areas/Organizations
Metadata/Capacity Areas/Organizations
Get Organizations of area
Method: get
Path: /rest/ofscMetadata/v1/capacityAreas/{label}/organizations
Metadata/Capacity Areas/Time Intervals
Metadata/Capacity Areas/Time Intervals
Get children of area
Method: get
Path: /rest/ofscMetadata/v1/capacityAreas/{label}/children
Get time intervals of area
Method: get
Path: /rest/ofscMetadata/v1/capacityAreas/{label}/timeIntervals
Metadata/Capacity Areas/Time Slots
Metadata/Capacity Areas/Time Slots
Get time slots of area
Method: get
Path: /rest/ofscMetadata/v1/capacityAreas/{label}/timeSlots
Metadata/Capacity Areas/Work Zones
Metadata/Capacity Areas/Work Zones
Get capacity work zones of area
Method: get
Path: /rest/ofscMetadata/v1/capacityAreas/{label}/workZones
Metadata/Capacity Categories
Metadata/Capacity Categories
Create/Update capacity category
Method: put
Path: /rest/ofscMetadata/v1/capacityCategories/{label}
Delete capacity category
Method: delete
Path: /rest/ofscMetadata/v1/capacityCategories/{label}
Get capacity categories
Method: get
Path: /rest/ofscMetadata/v1/capacityCategories
Get capacity category
Method: get
Path: /rest/ofscMetadata/v1/capacityCategories/{label}
Metadata/Languages
Metadata/Languages
Get Languages
Method: get
Path: /rest/ofscMetadata/v1/languages
Metadata/Map Layers
Metadata/Map Layers
Check custom map layer population status
Method: get
Path: /rest/ofscMetadata/v1/mapLayers/custom-actions/populateLayers/{downloadId}
Create custom map layer
Method: post
Path: /rest/ofscMetadata/v1/mapLayers
Get custom map layer
Method: get
Path: /rest/ofscMetadata/v1/mapLayers/{label}
Get custom map layers
Method: get
Path: /rest/ofscMetadata/v1/mapLayers
Populate custom map layer
Method: post
Path: /rest/ofscMetadata/v1/mapLayers/custom-actions/populateLayers
Replace custom map layer
Method: put
Path: /rest/ofscMetadata/v1/mapLayers/{label}
Metadata/Organizations
Metadata/Organizations
Get Organization
Method: get
Path: /rest/ofscMetadata/v1/organizations/{label}
Get Organizations
Method: get
Path: /rest/ofscMetadata/v1/organizations
Metadata/Properties
Metadata/Properties
Create/Replace property
Method: put
Path: /rest/ofscMetadata/v1/properties/{label}
Get properties
Method: get
Path: /rest/ofscMetadata/v1/properties
Get property
Method: get
Path: /rest/ofscMetadata/v1/properties/{label}
Get property's enumerations
Method: get
Path: /rest/ofscMetadata/v1/properties/{label}/enumerationList
Update property
Method: patch
Path: /rest/ofscMetadata/v1/properties/{label}
Update/Replace property's enumerations
Method: put
Path: /rest/ofscMetadata/v1/properties/{label}/enumerationList
Metadata/Work Skills
Metadata/Work Skills
Create/Replace work skill
Method: put
Path: /rest/ofscMetadata/v1/workSkills/{label}
Get 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
Metadata/Work Skills/Work Skill Conditions
Get work skill conditions
Method: get
Path: /rest/ofscMetadata/v1/workSkillConditions
Replace work skill conditions (All)
Method: put
Path: /rest/ofscMetadata/v1/workSkillConditions
Metadata/Work Skills/Work Skill Groups
Metadata/Work Skills/Work Skill Groups
Create/Replace work skill group
Method: put
Path: /rest/ofscMetadata/v1/workSkillGroups/{label}
Get work skill group
Method: get
Path: /rest/ofscMetadata/v1/workSkillGroups/{label}
Get work skill groups
Method: get
Path: /rest/ofscMetadata/v1/workSkillGroups
Metadata/Work Zones
Metadata/Work Zones
Bulk replace work zones
Method: put
Path: /rest/ofscMetadata/v1/workZones
Bulk update work zones
Method: patch
Path: /rest/ofscMetadata/v1/workZones
Create work zone
Method: post
Path: /rest/ofscMetadata/v1/workZones
Get work zone
Method: get
Path: /rest/ofscMetadata/v1/workZones/{label}
Get work zones
Method: get
Path: /rest/ofscMetadata/v1/workZones
Replace work zone
Method: put
Path: /rest/ofscMetadata/v1/workZones/{label}
Metadata/Work Zones/Work Zone Shapes
Metadata/Work Zones/Work Zone Shapes
Get shapes populating status
Method: get
Path: /rest/ofscMetadata/v1/workZones/custom-actions/populateShapes/{downloadId}
Start shape population process
Method: post
Path: /rest/ofscMetadata/v1/workZones/custom-actions/populateShapes
OAuth2/Token Service
OAuth2 token service
Get access token
Method: post
Path: /rest/oauthTokenService/v1/token