Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• Quick Start
• Use Cases
  • Receive Events
  • Update the Travel Time of Activities
  • Configure a Custom Map Layer by Using the Metadata API
  • Create a Shapefile
  • Resolve Conflicts When Creating Work Zones
  • Create Alternating Work Schedules
  • Enable Restricted Access Control Using Access Tokens with Dynamic Scope
  • Download Daily Extract Files
• Learn More
  • Authenticate and Authorize
  • Configure OAuth 2.0 Authentication
    • Configure OAuth2.0 Authentication for Fusion Field Service
    • Configure OAuth 2.0 Authentication for Oracle Field Service
  • Work with your REST Client
  • Manage Collections
  • Configure Cross-Origin Resource Sharing
  • Access Metadata
  • Access REST API Using Node.js File
• Reference
  • About Shapefiles
  • Error Message Data Model
  • Resource Types
  • SOAP APIs to REST APIs Mapping
  • Status Codes
  • Supported Data Types
  • Supported Events
    • Activity Events
    • Activity Link Events
    • Collaboration Events
    • Inventory Events
    • Required Inventory Events
    • Resource Events
    • Resource Preference Events
    • Route Events
    • Routing Events
    • Service Request Events
    • Support of Forms
    • User Events
  • Supported HTTP Header Fields
  • Supported HTTP Methods
  • Supported Language Codes
  • Supported Media Types
  • Supported Tasks
    • Activities: List of Tasks
    • Activity Types: List of Tasks
    • Applications: List of Tasks
    • Chats: List of Tasks
    • Daily Extracts: List of Tasks
    • Events: List of Tasks
    • Forms: List of Tasks
    • Inventories: List of Tasks
    • Inventory Types: List of Tasks
    • Languages: List of Tasks
    • Map Layers: List of Tasks
    • Non-working Reasons: List of Tasks
    • Properties: List of Tasks
    • Parts Catalog: List of Tasks
    • Resources: List of Tasks
    • Resource Types: List of Tasks
    • Service Requests: List of Tasks
    • Statistics: List of Tasks
    • Time Slots: List of Tasks
    • Users: List of Tasks
    • Work Skill Conditions: List of Tasks
    • Work Skill Groups: List of Tasks
    • Work Skills: List of Tasks
    • Work Zones: List of Tasks
  • Supported Time Zones
  • Terminology
• Deprecated Paths and Endpoints
• Change History

Tasks

• Capacity
  • Available Capacity
    • Get available capacity
  • Booking
    • Booking Fields Dependencies
    • Get activity booking options
    • Show booking grid
  • Booking Closing Schedule
    • Create or update booking closing schedules
    • Get booking closing schedule
    • Get booking statuses
    • Update booking statuses
  • Quota
    • v1
      • Create or update quota
      • Get quota
    • v2
      • Create or update quota
      • Get quota
• Collaboration
  • Address Book
    • Get address book
  • Chats
    • Get messages
    • Get participants
    • Invite a participant
    • Leave a chat
    • Send a message
    • Start a new chat
• Core
  • Activities
    • Bulk update activities
    • Create an activity
    • Get activities
    • Get an activity
    • Get capacity categories of activity
    • Get individual segments of a segmentable activity
    • Search for activities
    • Update an activity
    • Where is my technician
    • Activity Actions
      • Cancel an activity
      • Change activity status from enroute to pending
      • Complete an activity
      • Delay an activity
      • Delete an activity
      • Move an activity
      • Reopen an activity
      • Start an activity
      • Start prework
      • Suspend an activity
      • Update the activity status to enroute
      • Update the activity status to notdone
    • Activity File Properties
      • Delete a file property
      • Get a file property
      • Set a file property
    • Activity Inventories
      • Create a customer inventory
      • Get customer inventories
      • Get deinstalled inventories
      • Get installed inventories
    • Activity Links
      • Create an activity link
      • Delete all activity links
      • Delete an activity link
      • Get activity link details
      • Get activity links
      • Replace an activity link
    • Activity Required Inventories
      • Delete required inventories of an activity
      • Get required inventories of an activity
      • Set required inventories for an activity
    • Activity Resource Preferences
      • Delete resource preferences of an activity
      • Get resource preferences of an activity
      • Set resource preferences of an activity
    • Submitted Forms
      • Get associated submitted forms
  • Events
    • Create a subscription
    • Delete a subscription
    • Get events
    • Get subscription details
    • Get subscriptions
  • Extracts
    • Daily Extracts
      • Get a daily extract file
      • Get a list of daily extract files for a date
      • Get daily extract dates
  • Inventories
    • Create inventories
    • Deinstall an inventory
    • Delete a file property
    • Delete an Inventory
    • Get a file property
    • Get an inventory
    • Install an inventory
    • Set a file property
    • Undo deinstall an inventory
    • Undo install an inventory
    • Update an inventory
  • Resources
    • Bulk update resource inventories
    • Bulk update resource work schedules
    • Bulk update resource work skills
    • Bulk update resource work zones
    • Create a resource
    • Create a resource inventory
    • Find matching resources
    • Find nearby activities
    • Find resources for urgent assignment
    • Get a list of assistants
    • Get a resource
    • Get child resources
    • Get resource descendants
    • Get resource inventories
    • Get resources
    • Install an inventory
    • Update a resource
    • Resource Assigned Users
      • Get resource users
      • Set users
      • Unset users
    • Resource File Properties
      • Delete a file property
      • Get a file property
      • Set a file property
    • Resource Locations
      • Create a resource location
      • Delete a resource location
      • Delete assigned locations
      • Get a resource location
      • Get assigned locations
      • Get resource locations
      • Set assigned locations
      • Update a resource location
      • Update assigned locations
    • Resource Positions
      • Get last known positions of resources
      • Get position history of a resource
      • Get resources in area
      • Set positions for resources
    • Resource Routes
      • Activate a resource route
      • Deactivate a resource route
      • Get a resource route
    • Resource Work Plans
      • Create work plan for a resource
      • Delete work plan for a resource
      • Get work plans for a resource
    • Resource Work Schedules
      • Delete a work schedule item
      • Get a calendar
      • Get calendars
      • Get work schedules
      • Set a work schedule
    • Resource Work Skills
      • Delete a work skill
      • Get work skills
      • Set work skills
    • Resource Work Zones
      • Delete a resource work zone item
      • Get resource work zones
      • Set a resource work zone
  • Service Requests
    • Create a service request
    • Get a file property
    • Get a service request
  • Users
    • Create a user
    • Delete a user
    • Get a user
    • Get users
    • Update a user
    • User Collaboration Groups
      • Add collaboration groups
      • Delete collaboration groups
      • Get collaboration groups
    • User File Properties
      • Delete a file property
      • Get a file property
      • Set a file property
• Metadata
  • Activity Type Groups
    • Create or replace an activity type group
    • Get activity type groups
    • Get an activity type group
  • Activity Types
    • Create or update an activity type
    • Get activity types
    • Get an activity type
  • Applications
    • Create or update an application
    • Generate client secret for applications
    • Get an application
    • Get API access for an application
    • Get API accesses for applications
    • Get applications
    • Update API access for applications
  • Capacity Areas
    • Get a capacity area
    • Get capacity areas
    • Capacity Categories
      • Get capacity categories of a capacity area
    • Organizations
      • Get organizations of a capacity area
    • Time Intervals
      • Get children of a capacity area group
      • Get time intervals of a capacity area
    • Time Slots
      • Get time slots of a capacity area
    • Work Zones
      • Get work zones of a capacity area
      • Get work zones of a capacity area (Deprecated)
  • Capacity Categories
    • Create or update a capacity category
    • Delete a capacity category
    • Get a capacity category
    • Get capacity categories
  • Forms
    • Create or update a form
    • Delete a form
    • Get a list of forms
    • Get form details
  • Inventory Types
    • Create or update an inventory type
    • Get an inventory type
    • Get inventory types
  • Languages
    • Get languages
  • Link Templates
    • Create a link template
    • Get a link template
    • Get link templates
    • Update a link template
  • Map Layers
    • Check custom map layer population status
    • Create a custom map layer
    • Get a custom map layer
    • Get custom map layers
    • Populate a custom map layer
    • Replace a custom map layer
  • Non-working Reasons
    • Get non-working reasons
  • Organizations
    • Get an organization
    • Get organizations
  • Plugins
    • Import Plugins
    • Install Standard Plugin
  • Properties
    • Create or replace a property
    • Get a property
    • Get enumeration values of a property
    • Get properties
    • Update a property
    • Update or replace enumeration values of a property
  • Resource Types
    • Get resource types
  • Routing Profiles
    • Add a routing plan
    • Force add a routing plan
    • Get a routing plan
    • Get routing plans labels
    • Get routing profiles labels
    • Start routing plan
  • Shifts
    • Create or update a shift
    • Delete a shift
    • Get a shift
    • Get shifts
  • Time Slots
    • Get time slots
  • Work Skills
    • Create or replace a work skill
    • Delete a work skill
    • Get a work skill
    • Get work skills
    • Work Skill Conditions
      • Get work skill conditions
      • Replace work skill conditions
    • Work Skill Groups
      • Create or replace a work skill group
      • Delete a work skill group
      • Get a work skill group
      • Get work skill groups
  • Work Zone Key
    • Get the work zone key
  • Work Zones
    • Bulk replace work zones
    • Bulk update work zones
    • Create a work zone
    • Get a work zone
    • Get work zones
    • Replace a work zone
    • Work Zone Shapes
      • Get status of shape upload
      • Start shape upload
• OAuth2
  • Token Service
    • Get an access token
    • Get an access token (Deprecated)
• Parts Catalog
  • Create a catalog
  • Create or update a catalog item
  • Remove a catalog item
• Statistics
  • Activity Duration
    • Get activity duration statistics
    • Update activity duration statistics
  • Activity Travel
    • Get activity travel statistics
    • Update activity travel statistics
  • Airline Distance Based Travel
    • Get airline distance based travel
    • Update airline distance based travel