Geofences
timeGeofences Based on latest (2026.09)
Create, change, delete and look up Geofences, with geofence assignments. Actions include fetch geocoordinates and formatted addresses.
The record key timeGeofencesUniqID is a generated hash. Take it from the record's links (rel self) in a GET response; never build it yourself.
Oracle documents an Effective-Of header and an effectiveDate parameter for this resource, used for date-effective reads and changes.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE1 action
- Record key
timeGeofencesUniqID- Required on create
CodeLocationIdName- At a glance
- 12 fields2 finders1 children
- Extra parameters
?effectiveDate=Effective-Of:
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/timeGeofences?fields=Code,Description,GeoJson,GeofenceId,LastUpdateDate&limit=25&onlyData=true
{
"items": [
{
"Code": "<string, max 256>",
"Description": "<string, max 4000>",
"GeoJson": "<string>",
"GeofenceId": 0,
"LastUpdateDate": "2026-01-31T09:00:00+00:00"
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's latest (2026.09) REST specification.
Fields 12
| Attribute | Type | Use |
|---|---|---|
Code | text · max 256 | Required on createSearchable |
Description | text · max 4000 | Optional on createUpdatableSearchable |
GeoJson | text | Optional on createUpdatable |
GeofenceId | number | Optional on createSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
LocationId | number | Required on createUpdatableSearchable |
LocationName | text · max 255 | Optional on createUpdatableSearchable |
LocationValidFlag | yes/no | Read-onlySearchable |
Name | text · max 256 | Required on createUpdatableSearchable |
Radius | number | Optional on createUpdatableSearchable |
Source | text · max 32 · default ORA_HXT_GF_SOURCE_MD_USER | Optional on createUpdatableSearchable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 2
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
FindByLocationName·LocationNameSysEffectiveDatefindByName·NameSysEffectiveDate
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 1
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/timeGeofences/{timeGeofencesUniqID}/child/<name>. Add them to a GET with expand.
geofenceAssignmentsGET · POST · PATCH · DELETE Geofence Assignments · 4 fieldsGeofenceAssignmentIdGeofenceIdGroupNameGrpId
Actions 1
POST …/action/fetchGeocoordinatesAndFormattedAddresses·locations
Actions use Content-Type: application/vnd.oracle.adf.action+json. A path with a {key} runs on one record.
Use in AI Agent Studio
- Point a Business Object or REST tool at
/hcmRestApi/resources/11.13.18.05/timeGeofencesand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
FindByLocationNamefor the agent's main search: its variables become clean tool parameters. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:Code, notcode. - 3 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
onlyData=trueremoveslinks, and this resource's key only comes fromlinks. Leave it off when you need the key.- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.