Resources: List of Tasks

You can perform the following tasks using the Resources resource:

Task Task Type URI Description

Get resources

GET

/rest/ofscCore/v1/resources

This operation returns a list of resources that are visible to the API user.

The resource visibility is determined by the users resource tree association.

For example, if the user can see only a single bucket, the response will only be for that portion of the resource tree. If the user has access to the entire resource tree, the response returns all the resources.

Create resource

PUT

/rest/ofscCore/v1/resources/{resourceId}

This operation creates a new resource.

The resource must be assigned to one or more users in the application.

Get resource

GET

/rest/ofscCore/v1/resources/{resourceId}

This operation returns information about the specified resource.

Update resource

PATCH

/rest/ofscCore/v1/resources/{resourceId}

This operation updates the properties of the specified resource.

Delete file property

DELETE

/rest/ofscCore/v1/resources/{resourceId}/{propertyLabel}

This operation deletes the specified 'file' property for the specific resource.

Get file property

GET

/rest/ofscCore/v1/resources/{resourceId}/{propertyLabel}

This operation gets the specified 'file' property for the specific resource.

It's possible to resume an incomplete download by identifying the offset in the range header.

For example, "Range: bytes=1000-" means that downloading starts from offset 1000 bytes up to the end of the file.

Set file property

PUT

/rest/ofscCore/v1/resources/{resourceId}/{propertyLabel}

This operation creates the specified 'file' property for the specific resource.

Get assigned locations

GET

/rest/ofscCore/v1/resources/{resourceId}/assignedLocations

This operation returns the details about the locations assigned to the specified resource for the specified date range.

This includes the 'start', 'end' and 'home zone center' locations.

Update assigned locations

PATCH

/rest/ofscCore/v1/resources/{resourceId}/assignedLocations

This operation creates or updates the temporary locations assigned to the specified resource.

Delete assigned locations

DELETE

/rest/ofscCore/v1/resources/{resourceId}/assignedLocations/{date}

This operation deletes the locations assigned to the specified resource.

Set assigned locations

PUT

/rest/ofscCore/v1/resources/{resourceId}/assignedLocations

This operation creates or updates or removes locations for the specified resource.

This operation includes the 'start', 'end' and 'home zone center' locations.

When the location is specified in the request, the location is assigned to the resource.

When the location isn't specified or is empty in the request, the location is removed from the resource for the weekdays specified in the request.

Unset assigned locations

DELETE

/rest/ofscCore/v1/resources/{resourceId}/assignedLocations

This operation returns the list of currently assigned 'start', 'end', and 'home zone center' locations for the specified resource.

Get resource children

GET

/rest/ofscCore/v1/resources/{resourceId}/children

This operation returns the list of children of the specified resource.

These resources are located one level below the specified resource on a resource tree in Oracle Field Service Manage.

Get resource descendants

GET

/rest/ofscCore/v1/resources/{resourceId}/descendants

This operation returns a list of children of the specified resource and all their descendants.

These resources are located below the specified resource on a resource tree in Oracle Field Service Manage.

Create resource inventory

POST

/rest/ofscCore/v1/resources/{resourceId}/inventories

This operation fills the resource pool with inventories.

Find matching resources

POST

/rest/ofscCore/v1/resources/custom-actions/findMatchingResources

This operation returns a list of resources which can complete this activity based on the criteria in the request. Only resources that match all of the criteria specified in request will be returned in response.

Get resource inventories

GET

/rest/ofscCore/v1/resources/{resourceId}/inventories

This operation retrieves data on the resource pool inventories of the specified resource.

Install inventory

POST

/rest/ofscCore/v1/resources/{resourceId}/inventories/{inventoryId}/custom-actions/install

This operation performs the 'install' action on the specified inventory.

This operation changes the inventory's status to 'installed' and places it into the installed list of inventories for the specified activity.

Create resource location

POST

/rest/ofscCore/v1/resources/{resourceId}/locations

This operation creates a location for the specified resource.

After the location is created, the 'Set assignedlocation' operation must be used to assign the 'start', 'end', or 'home zone center' location.

Get resource locations

GET

/rest/ofscCore/v1/resources/{resourceId}/locations

This operation returns the locations assigned to the specified resource.

Delete resource location

DELETE

/rest/ofscCore/v1/resources/{resourceId}/locations/{locationId}

This operation deletes the specified location for the specified resource.

Get resource location

GET

/rest/ofscCore/v1/resources/{resourceId}/locations/{locationId}

This operation returns the details of the specified location object.

Update resource location

PATCH

/rest/ofscCore/v1/resources/{resourceId}/locations/{locationId}

This operation updates the details of the specified location object.

Delete work plan for resource

DELETE

/rest/ofscCore/v1/resources/{resourceId}/plans

This operation deletes the assigned work plan for a specified group resource for the specified date.

A field manager can use work plans in Oracle Field Service Mobile for Android and iOS to measure a planned amount of working time for a group for each particular day.

Get work plans for resource

GET

/rest/ofscCore/v1/resources/{resourceId}/plans

This operation returns the assigned work plan for a specified group resource for the specified date.

A field manager can use work plans in Oracle Field Service Mobile for Android and iOS to measure a planned amount of working time for a group for each particular day.

Create work plan for resource

POST

/rest/ofscCore/v1/resources/{resourceId}/plans

This operation creates the assigned work plan for a specified group resource for the specified date.

A field manager can use work plans in Oracle Field Service Mobile for Android and iOS to measure a planned amount of working time for a group for each particular day.

Get resource route

GET

/rest/ofscCore/v1/resources/{resourceId}/routes/{date}

This operation returns a list of the activities assigned to a specified resource for a specified date.

Activate resource route

POST

/rest/ofscCore/v1/resources/{resourceId}/routes/{date}/custom-actions/activate

This operation activates the specified resource's route.

Deactivate resource route

POST

/rest/ofscCore/v1/resources/{resourceId}/routes/{date}/custom-actions/deactivate

This operation deactivates the specified resource route when the 'date' is the current day; else, this operation fails. If 'Overtime work' is configured, it is possible to deactivate the route on the previous day.

Get resource users

GET

/rest/ofscCore/v1/resources/{resourceId}/users
This operation deactivates the specified resources route when the following conditions are met:

  • The date must be the current or next day if overnight is used. If not, then this operation fails.

  • The route must not contain any 'pending' activities.

Set users

PUT

/rest/ofscCore/v1/resources/{resourceId}/users

This operation updates the list of users assigned to the specified resource.

Unset users

DELETE

/rest/ofscCore/v1/resources/{resourceId}/users

This operation removes all users assigned to the specified resource.

Get work schedules

GET

/rest/ofscCore/v1/resources/{resourceId}/workSchedules

This operation returns a list of work schedules assigned to the specified resource.

Work schedules are a representation of the resources work calendar, which includes working hours, working and nonworking days, reasons for absence, and so on.

Set work schedule

POST

/rest/ofscCore/v1/resources/{resourceId}/workSchedules

This operation creates a work schedule for the specified resource.

Work schedules are a representation of the resources work calendar, which includes working hours, working and nonworking days, reasons for absence, and so on.

Delete work schedule item

DELETE

/rest/ofscCore/v1/resources/{resourceId}/workSchedules/{scheduleItemId}

This operation deletes a specific work schedule for the specified resource.

Work schedules are a representation of the resources work calendar, which includes working hours, working and nonworking days, reasons for absence, and so on.

Get calendar

GET

/rest/ofscCore/v1/resources/{resourceId}/workSchedules/calendarView

This operation returns a list of work schedules for the specified resource for the specified interval of days.

This operation can be used to render work schedules on a calendar view control, such as a month or week view.

Work schedules are a representation of the resources work calendar, which includes working hours, working and nonworking days, reasons for absence, and so on.

Get calendars

GET

/rest/ofscCore/v1/calendars

This operation returns a list of work schedules for the specified resource for the specified interval of days.

This operation can be used to render work schedules on a calendar view control, such as a month or week view.

Work schedules are a representation of the resources work calendar, which includes working hours, working and nonworking days, reasons for absence, and so on.

Get work skills

GET

/rest/ofscCore/v1/resources/{resourceId}/workSkills

This operation returns the details about the work skills assigned to the specified resource.

Set work skills

POST

/rest/ofscCore/v1/resources/{resourceId}/workSkills

This operation creates or updates work skills for the specified resource.

Delete work skill

DELETE

/rest/ofscCore/v1/resources/{resourceId}/workSkills/{workSkill}

This operation deletes work skills for the specified resource.

Get work zones

GET

/rest/ofscCore/v1/resources/{resourceId}/workZones

This operation returns the details about the work zones assigned to the specified resource.

Set work zones

POST

/rest/ofscCore/v1/resources/{resourceId}/workZones

This operation creates or updates work zones for the specified resource.

Find matching resources

POST

/rest/ofscCore/v1/resources/custom-actions/findMatchingResources

This operation returns a list of resources which can complete this activity based on the criteria in the request.

Only resources that match all of the criteria specified in request will be returned in response.

Find resources for urgent assignment

POST

/rest/ofscCore/v1/resources/custom-actions/findResourcesForUrgentAssignment

This operation returns a list of resources that can immediately perform an activity based on the specified criteria in the request.

Only resources matching the specified criteria will be returned in the response.

Bulk update resource work schedules

POST

/rest/ofscCore/v1/resources/custom-actions/bulkUpdateWorkSchedules

This operation creates, updates, or deletes work schedules of multiple resources at once.

Bulk update resource work skills

POST

/rest/ofscCore/v1/resources/custom-actions/bulkUpdateWorkSkills

This operation creates, updates, or deletes work skills of multiple resources at once.

Bulk update resource work zones

POST

/rest/ofscCore/v1/resources/custom-actions/bulkUpdateWorkZones

This operation creates, updates, or deletes work zones of multiple resources at once.

Bulk update resources inventories

POST

/rest/ofscCore/v1/resources/custom-actions/bulkUpdateInventories

This operation creates or updates resource inventory in bulk for the specified resources with the inventory specified in the request.

Get last known positions of resources

GET

/rest/ofscCore/v1/resources/custom-actions/lastKnownPositions

This operation retrieves the last known position of the specified resources.

Get position history for resource for certain date

GET

/rest/ofscCore/v1/resources/{resourceId}/positionHistory

This operation returns resource position history for a specific date.

Get resources in area

GET

/rest/ofscCore/v1/resources/custom-actions/resourcesInArea

This operation returns resources present in an area based on specified longitude, altitude, radius of area, and duration.

Set positions for resources

POST

/rest/ofscCore/v1/resources/custom-actions/setPositions

This operation sets resource positions for the specified resources. The maximum request size for this operation is five Mb.