Supported operations
| DELETE /locationsV2/{id} |
| GET /locationsV2 |
| GET /locationsV2/{id} |
| PATCH /locationsV2/{id} |
| POST /locationsV2 |
Queryable q fields (65)
Only these fields can appear in a q filter expression on
/locationsV2. Filtering on any other field returns
400 Bad Request.
Example q request
GET /hcmRestApi/resources/11.13.18.05/locationsV2?q=EffectiveEndDate='<value>'&onlyData=true&limit=25
| Field | Type | Operators |
|---|---|---|
| EffectiveEndDate | string | = != |
| EffectiveStartDate | string | = != |
| LocationDetailsId | string | = != |
| AddressUsageType | string | = != |
| AddressUsageTypeMeaning | string | = != |
| Building | string | = != |
| Country | string | = != |
| FloorNumber | string | = != |
| Latitude | number | between |
| LocAddressUsageId | integer | = != |
| LongPostalCode | string | = != |
| Longitude | number | between |
| PostalCode | string | = != |
| Provider | string | = != |
| Region1 | string | = != |
| Region2 | string | = != |
| Region3 | string | = != |
| TimezoneCode | string | = != |
| TownOrCity | string | = != |
| ValidationStatusCode | string | = != |
| ActionReason | string | = != |
| ActionReasonCode | string | = != |
| ActiveStatus | string | = != |
| ActiveStatusMeaning | string | = != |
| AnnualWorkingDurationUnits | string | = != |
| AnnualWorkingDurationUnitsMeaning | string | = != |
| BillToSiteFlag | boolean | = != |
| Description | string | = != |
| DesignatedReceiverId | integer | = != |
| DesignatedReceiverNumber | string | = != |
| EmailAddress | string | = != |
| EmployeeLocationFlag | boolean | = != |
| FaxAreaCode | string | = != |
| FaxCountryCode | string | = != |
| FaxExtension | string | = != |
| FaxNumber | string | = != |
| GeoHierarchyNodeCode | string | = != |
| GeoHierarchyNodeName | string | = != |
| InventoryOrganizationId | integer | = != |
| InventoryOrganizationName | string | = != |
| LocationCode | string | = != |
| LocationId | integer | = != |
| LocationName | string | = != |
| MainPhoneAreaCode | string | = != |
| MainPhoneCountryCode | string | = != |
| MainPhoneExtension | string | = != |
| MainPhoneNumber | string | = != |
| OfficeSiteFlag | boolean | = != |
| OfficialLanguageCode | string | = != |
| OfficialLanguageMeaning | string | = != |
| OtherPhoneAreaCode | string | = != |
| OtherPhoneCountryCode | string | = != |
| OtherPhoneExtension | string | = != |
| OtherPhoneNumber | string | = != |
| ReceivingSiteFlag | boolean | = != |
| SetCode | string | = != |
| SetId | integer | = != |
| SetName | string | = != |
| ShipToLocationCode | string | = != |
| ShipToLocationId | integer | = != |
| ShipToSiteFlag | boolean | = != |
| StandardAnnualWorkingDuration | number | = != |
| StandardWorkingFrequency | string | = != |
| StandardWorkingFrequencyMeaning | string | = != |
| StandardWorkingHours | number | = != |
Child resources (6)
Each child is reachable at
/locationsV2/{id}/child/<name>
and most can also be inlined with expand.
addressesattachmentsbannerOverrideMessageslocationLegislativeEFFlocationsDFFlocationsEFFContainer Response fields (61)
Top-level attributes returned for each row. Use
fields= to request a subset and shrink the payload.
ActionIdActionReasonActionReasonCodeActionReasonIdActiveStatusActiveStatusMeaningAnnualWorkingDurationUnitsAnnualWorkingDurationUnitsMeaningBillToSiteFlagCreatedByCreationDateDescriptionDesignatedReceiverIdDesignatedReceiverNameDesignatedReceiverNumberEffectiveEndDateEffectiveStartDateEmailAddressEmployeeLocationFlagFaxAreaCodeFaxCountryCodeFaxExtensionFaxNumberGeoHierarchyNodeCodeGeoHierarchyNodeNameInventoryOrganizationIdInventoryOrganizationNameLastUpdateDateLastUpdatedByLocationCodeLocationIdLocationNameMainPhoneAreaCodeMainPhoneCountryCodeMainPhoneExtensionMainPhoneNumberOfficeSiteFlagOfficialLanguageCodeOfficialLanguageMeaningOtherPhoneAreaCodeOtherPhoneCountryCodeOtherPhoneExtensionOtherPhoneNumberReceivingSiteFlagSetCodeSetIdSetNameShipToLocationCodeShipToLocationIdShipToLocationNameShipToSiteFlagStandardAnnualWorkingDurationStandardWorkingFrequencyStandardWorkingFrequencyMeaningStandardWorkingHoursaddressesattachmentsbannerOverrideMessageslocationLegislativeEFFlocationsDFFlocationsEFFContainer 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
- /recruitingUIJobOfferDetails Get details about all recruiting job offers
- /recruitingCEJobRequisitionDetailsPreviews Get all job requisition details in preview mode
- /recruitingCEJobRequisitionDetails Get all job requisition details in preview mode
- /communicateUICampaignDetails Get all campaigns
- /recruitingUIJobApplications Get details about all job applications
- 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