Supported operations
| GET /locations |
| GET /locations/{id} |
Queryable q fields (31)
Only these fields can appear in a q filter expression on
/locations. Filtering on any other field returns
400 Bad Request.
Example q request
GET /hcmRestApi/resources/11.13.18.05/locations?q=ActiveStatus='<value>'&onlyData=true&limit=25
| Field | Type | Operators |
|---|---|---|
| ActiveStatus | string | = != |
| AddressLine1 | string | = != |
| AddressLine2 | string | = != |
| AddressLine3 | string | = != |
| AddressLine4 | string | = != |
| AnnualWorkingDurationUnits | string | = != |
| BillToSiteFlag | boolean | = != |
| Country | string | = != |
| EffectiveEndDate | string | = != |
| EffectiveStartDate | string | = != |
| EmployeeLocationFlag | boolean | = != |
| LastUpdateDate | string | = != |
| Latitude | number | between |
| LocationCode | string | = != |
| LocationId | integer | = != |
| LocationName | string | = != |
| Longitude | number | between |
| OfficeSiteFlag | boolean | = != |
| PostalCode | string | = != |
| Provider | string | = != |
| ReceivingSiteFlag | boolean | = != |
| Region1 | string | = != |
| Region2 | string | = != |
| Region3 | string | = != |
| SetId | integer | = != |
| ShipToSiteFlag | boolean | = != |
| StandardAnnualWorkingDuration | number | = != |
| StandardWorkingFrequency | string | = != |
| StandardWorkingHours | number | = != |
| TownOrCity | string | = != |
| ValidationStatusCode | string | = != |
Child resources (1)
Each child is reachable at
/locations/{id}/child/<name>
and most can also be inlined with expand.
LocationDFF Response fields (39)
Top-level attributes returned for each row. Use
fields= to request a subset and shrink the payload.
ActiveStatusAddressLine1AddressLine2AddressLine3AddressLine4AnnualWorkingDurationUnitsBillToSiteFlagCountryCreationDateDescriptionEffectiveEndDateEffectiveStartDateEmailAddressEmployeeLocationFlagLastUpdateDateLatitudeLocationCodeLocationDFFLocationIdLocationNameLongitudeMainAddressIdOfficeSiteFlagPostalCodeProviderReceivingSiteFlagRegion1Region2Region3SetIdShipToSiteFlagStandardAnnualWorkingDurationStandardWorkingFrequencyStandardWorkingHoursTelephoneNumber1TelephoneNumber2TelephoneNumber3TownOrCityValidationStatusCode Build this query visually in OPAL
OPAL bundles this endpoint — and 59,000+ more — fully searchable offline, with a visual Q Builder and Finder Builder that only offer the fields listed above, so your filter can't 400. Download free · see features.
Related reference & reading
- /learningEvents Get all events
- /elementEntries Get all element entries
- /recruitingUICreateOrUpdateJobOffers Get data about all job offers
- /learningSelfPacedItems Get all learning items
- /jobs Identifier of the job valid grade to be provided when using alternate key finder on jobs valid grades.
- Oracle HCM API guide
- Why the q parameter fails and how to fix it
- Finders: named queries in Oracle Fusion REST APIs
- All endpoint reference pages