Locations V2
locationsV2 Based on latest (2026.09)
Create, change, delete and look up Locations V2, with addresses and banner override messages. Actions include get reloaded EFF data and split location for child update.
The record key locationsV2UniqID 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)DELETE6 actions
- Record key
locationsV2UniqID- Required on create
EffectiveEndDateEffectiveStartDateLocationCodeLocationNameSetCodeSetId- At a glance
- 58 fields2 finders8 children
- Extra parameters
?effectiveDate=Effective-Of:
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/locationsV2?fields=ActionId,ActionReason,ActionReasonCode,ActionReasonId,ActiveStatus&limit=25&onlyData=true
{
"items": [
{
"ActionId": 0,
"ActionReason": "<string, max 80>",
"ActionReasonCode": "<string, max 30>",
"ActionReasonId": 0,
"ActiveStatus": "A"
}
],
"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 58
| Attribute | Type | Use |
|---|---|---|
ActionId | number | Optional on createUpdatable |
ActionReason | text · max 80 | Read-onlySearchable |
ActionReasonCode | text · max 30 | Optional on createUpdatableSearchable |
ActionReasonId | number | Optional on createUpdatable |
ActiveStatus | text · max 30 · default A | Optional on createUpdatableSearchable |
ActiveStatusMeaning | text · max 80 | Read-onlySearchable |
AnnualWorkingDurationUnits | text · max 10 | Optional on createUpdatableSearchable |
AnnualWorkingDurationUnitsMeaning | text · max 80 | Read-onlySearchable |
BillToSiteFlag | yes/no · max 30 · default true | Optional on createUpdatableSearchable |
CreatedBy | text · max 64 | Read-only |
CreationDate | date-time | Read-only |
DeliverToSiteFlag | yes/no · max 1 · default true | Optional on createUpdatableSearchable |
Description | text · max 240 | Optional on createUpdatableSearchable |
DesignatedReceiverId | number | Optional on createUpdatableSearchable |
DesignatedReceiverName | text · max 240 | Read-only |
DesignatedReceiverNumber | text · max 30 | Optional on createUpdatableSearchable |
EffectiveEndDate | date | Required on createUpdatableSearchable |
EffectiveStartDate | date | Required on createUpdatableSearchable |
EmailAddress | text · max 240 | Optional on createUpdatableSearchable |
EmployeeLocationFlag | yes/no · max 1 · default true | Optional on createUpdatableSearchable |
FaxAreaCode | text · max 60 | Optional on createUpdatableSearchable |
FaxCountryCode | text · max 30 | Optional on createUpdatableSearchable |
FaxExtension | text · max 60 | Optional on createUpdatableSearchable |
FaxNumber | text · max 60 | Optional on createUpdatableSearchable |
GeoHierarchyNodeCode | text · max 100 | Optional on createUpdatableSearchable |
GeoHierarchyNodeName | text · max 80 | Read-onlySearchable |
InventoryOrganizationId | number | Optional on createUpdatableSearchable |
InventoryOrganizationName | text · max 240 | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-only |
LastUpdatedBy | text · max 64 | Read-only |
LocationCode | text · max 120 | Required on createUpdatableSearchable |
LocationId | number | Optional on createSearchable |
LocationName | text · max 60 | Required on createUpdatableSearchable |
MainPhoneAreaCode | text · max 60 | Optional on createUpdatableSearchable |
MainPhoneCountryCode | text · max 30 | Optional on createUpdatableSearchable |
MainPhoneExtension | text · max 60 | Optional on createUpdatableSearchable |
MainPhoneNumber | text · max 60 | Optional on createUpdatableSearchable |
OfficeSiteFlag | yes/no · max 30 · default true | Optional on createUpdatableSearchable |
OfficialLanguageCode | text · max 30 | Optional on createUpdatableSearchable |
OfficialLanguageMeaning | text · max 80 | Read-onlySearchable |
OtherPhoneAreaCode | text · max 60 | Optional on createUpdatableSearchable |
OtherPhoneCountryCode | text · max 30 | Optional on createUpdatableSearchable |
OtherPhoneExtension | text · max 60 | Optional on createUpdatableSearchable |
OtherPhoneNumber | text · max 60 | Optional on createUpdatableSearchable |
ReceivableMaterials | text · max 2000 | Optional on createUpdatableSearchable |
ReceivableMaterialsMeaning | text · max 80 | Read-onlySearchable |
ReceivingSiteFlag | yes/no · max 30 · default true | Optional on createUpdatableSearchable |
SetCode | text · max 30 | Required on createSearchable |
SetId | number | Required on createSearchable |
SetName | text · max 80 | Read-onlySearchable |
ShipToLocationCode | text · max 120 | Optional on createUpdatableSearchable |
ShipToLocationId | number | Optional on createUpdatableSearchable |
ShipToLocationName | text · max 60 | Read-only |
ShipToSiteFlag | yes/no · max 30 · default true | Optional on createUpdatableSearchable |
StandardAnnualWorkingDuration | number | Optional on createUpdatableSearchable |
StandardWorkingFrequency | text · max 30 | Optional on createUpdatableSearchable |
StandardWorkingFrequencyMeaning | text · max 80 | Read-onlySearchable |
StandardWorkingHours | number | 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.
findByLocationId·LocationIdSysEffectiveDatefindByLocationIdAfterReload·LocationIdSysEffectiveDateTransactionId
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 8
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/<name>. Add them to a GET with expand.
addressesGET · POST · PATCH · DELETE Addresses · 34 fields · 1 findersAddlAddressAttribute1AddlAddressAttribute2AddlAddressAttribute3AddlAddressAttribute4AddlAddressAttribute5AddressLine1AddressLine2AddressLine3AddressLine4AddressUsageTypeAddressUsageTypeMeaningBuildingCountryCreatedByCreationDateEffectiveEndDateEffectiveStartDateFloorNumberLastUpdateDateLastUpdatedByLatitudeLocAddressUsageIdLongPostalCodeLongitudePostalCodeProviderRegion1Region2Region3TimezoneTimezoneCodeTownOrCityValidateAddressFlagValidationStatusCodeattachmentsGET · POST · PATCH · DELETE Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNamebannerOverrideMessagesGET Banner Override Messages · 16 fieldsBusinessProcessNameIdentificationKeyLoggedInUserTypeObjectObjectIdPrimaryActionLabelForBannerPrimaryTextForBannerRootTaskIdSecondaryTextForBannerSubjectSubjectIdTaskNumberTaskStateTransactionIdTransactionStateTransactionStatuslocationLegislativeEFFGET · POST · PATCH · DELETE Locations Legislative Extensible FlexfieldsFields depend on your pod's flexfield setup (check
/describe).locationsDFFGET · POST · PATCH · DELETE Locations Descriptive Flexfields · 5 fieldsEffectiveEndDateEffectiveStartDateLocationDetailsId__FLEX_Context__FLEX_Context_DisplayValuelocationsEFFContainerGET · POST Locations Extensible Flexfields ContainerFields depend on your pod's flexfield setup (check
/describe).locationsEFFGET · POST · PATCH · DELETE Locations Extensible FlexfieldsFields depend on your pod's flexfield setup (check
/describe).translationsGET · PATCH Locations V2 Translations · 7 fieldsDescriptionEffectiveEndDateEffectiveStartDateLanguageLocationDetailsIdLocationNameSourceLang
Actions 6
POST …/action/getReloadedEFFData·transactionIdPOST …/action/splitLocationForChildUpdate·locationIdeffectiveStartDatePOST …/action/verifyForeignKeysOnDateChange·fkMapeffectiveDatePOST …/{locationsV2UniqID}/action/changeEffectiveStartDate·newEffectiveStartDatePOST …/{locationsV2UniqID}/action/deleteLocationOtherAddresses·otherAddressValueseffectiveStartDateisEffectiveStartDateMovedPOST …/{locationsV2UniqID}/action/modifyLocationRowForChildCorrect
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/locationsV2and ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByLocationIdfor 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:ActionId, notactionid. - 14 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.