Get a location

get

/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Locations V2 resource and used to uniquely identify an instance of Locations V2. The client should not generate the hash key value. Instead, the client should query on the Locations V2 collection resource in order to navigate to a specific instance of Locations V2 to get the hash key.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : locationsV2-item-response
Type: object
Show Source
Nested Schema : Addresses
Type: array
Title: Addresses
The addresses resource is a child of the locations resource. It provides all the addresses of the location including the main address as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Banner Override Messages
Type: array
Title: Banner Override Messages
The bannerOverrideMessages resource provides all the status information and related messages for an object.
Show Source
Nested Schema : locationLegislativeEFF
Type: array
Show Source
  • Discriminator: CategoryCode
    Discriminator: { "propertyName":"CategoryCode", "mapping":{ "HCM_LOC_LEG":"#/components/schemas/oracle_apps_hcm_locations_flex_locationlegeff_category_view_j__LocationLegCategoryHcmLocLegprivateVO-item-response" } }
Nested Schema : locationsDFF
Type: array
Show Source
Nested Schema : Locations Extensible Flexfields Container
Type: array
Title: Locations Extensible Flexfields Container
The locationEFFContainer resource is a child of the locations resource. It's a container for the locations extensible flexfields.
Show Source
Nested Schema : locationsV2-addresses-item-response
Type: object
Show Source
Nested Schema : locationsV2-attachments-item-response
Type: object
Show Source
Nested Schema : locationsV2-bannerOverrideMessages-item-response
Type: object
Show Source
Nested Schema : Discriminator: CategoryCode
Type: object
Discriminator: CategoryCode

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_locations_flex_locationlegeff_category_view_j__LocationLegCategoryHcmLocLegprivateVO-item-response
Type: object
Show Source
Nested Schema : LocationLegislativeHRX_5FCA_5FLOC_5FEER_5FRULESprivateVO
Type: array
Show Source
Nested Schema : LocationLegislativeHRX_5FFR_5FEXT_5FREPORTING_5FINFOprivateVO
Type: array
Show Source
Nested Schema : LocationLegislativeHRX_5FUS_5FEEO1_5FINFORMATIONprivateVO
Type: array
Show Source
Nested Schema : LocationLegislativeHRX_5FUS_5FLOC_5FEEO_5FVETS_5FINFprivateVO
Type: array
Show Source
Nested Schema : LocationLegislativeHRX_5FUS_5FMWS_5FINFORMATIONprivateVO
Type: array
Show Source
Nested Schema : LocationLegislativeHRX_5FUS_5FPA_5FPSD_5FINFORMATIONprivateVO
Type: array
Show Source
Nested Schema : LocationLegislativeHRX_5FUS_5FREPORTING_5FINFORMATIONprivateVO
Type: array
Show Source
Nested Schema : LocationLegislativeHRX_5FUS_5FUNEMPLOYMENT_5FREPORTINGprivateVO
Type: array
Show Source
Nested Schema : LocationLegislativeHRX_5FUS_5FVETS_5FINFORMATIONprivateVO
Type: array
Show Source
Nested Schema : LocationLegislativeORA_5FHRX_5FCA_5FPM_5FLOCprivateVO
Type: array
Show Source
Nested Schema : LocationLegislativeORA_5FHRX_5FCA_5FWC_5FLOCprivateVO
Type: array
Show Source
Nested Schema : LocationLegislativeORA_5FHRX_5FIN_5FEMPLR_5FCONT_5FINFOprivateVO
Type: array
Show Source
Nested Schema : locationsV2-locationLegislativeEFF-LocationLegislativeHRX_5FCA_5FLOC_5FEER_5FRULESprivateVO-item-response
Type: object
Show Source
Nested Schema : locationsV2-locationLegislativeEFF-LocationLegislativeHRX_5FFR_5FEXT_5FREPORTING_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : locationsV2-locationLegislativeEFF-LocationLegislativeHRX_5FUS_5FEEO1_5FINFORMATIONprivateVO-item-response
Type: object
Show Source
Nested Schema : locationsV2-locationLegislativeEFF-LocationLegislativeHRX_5FUS_5FLOC_5FEEO_5FVETS_5FINFprivateVO-item-response
Type: object
Show Source
Nested Schema : locationsV2-locationLegislativeEFF-LocationLegislativeHRX_5FUS_5FMWS_5FINFORMATIONprivateVO-item-response
Type: object
Show Source
Nested Schema : locationsV2-locationLegislativeEFF-LocationLegislativeHRX_5FUS_5FPA_5FPSD_5FINFORMATIONprivateVO-item-response
Type: object
Show Source
Nested Schema : locationsV2-locationLegislativeEFF-LocationLegislativeHRX_5FUS_5FREPORTING_5FINFORMATIONprivateVO-item-response
Type: object
Show Source
Nested Schema : locationsV2-locationLegislativeEFF-LocationLegislativeHRX_5FUS_5FUNEMPLOYMENT_5FREPORTINGprivateVO-item-response
Type: object
Show Source
Nested Schema : locationsV2-locationLegislativeEFF-LocationLegislativeHRX_5FUS_5FVETS_5FINFORMATIONprivateVO-item-response
Type: object
Show Source
Nested Schema : locationsV2-locationLegislativeEFF-LocationLegislativeORA_5FHRX_5FCA_5FPM_5FLOCprivateVO-item-response
Type: object
Show Source
Nested Schema : locationsV2-locationLegislativeEFF-LocationLegislativeORA_5FHRX_5FCA_5FWC_5FLOCprivateVO-item-response
Type: object
Show Source
Nested Schema : locationsV2-locationLegislativeEFF-LocationLegislativeORA_5FHRX_5FIN_5FEMPLR_5FCONT_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : locationsV2-locationsDFF-item-response
Type: object
Show Source
Nested Schema : locationsV2-locationsEFFContainer-item-response
Type: object
Show Source
Nested Schema : locationsEFF
Type: array
Show Source
  • Discriminator: CategoryCode
    Discriminator: { "propertyName":"CategoryCode", "mapping":{ "HCM_LOC":"#/components/schemas/oracle_apps_hcm_locations_flex_locationextraInfoeff_category_view_j__LocationEitCategoryHcmLocprivateVO-item-response" } }
Nested Schema : Discriminator: CategoryCode
Type: object
Discriminator: CategoryCode

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_locations_flex_locationextraInfoeff_category_view_j__LocationEitCategoryHcmLocprivateVO-item-response
Type: object
Show Source
Nested Schema : LocationExtraInfoJE_5FES_5FPRL_5FNOprivateVO
Type: array
Show Source
Nested Schema : LocationExtraInfoJE_5FES_5FPRL_5FYESprivateVO
Type: array
Show Source
Nested Schema : LocationExtraInfoJE_5FES_5FRENTED_5FLOCATIONprivateVO
Type: array
Show Source
Nested Schema : LocationExtraInfoJExESPropertyLocationprivateVO
Type: array
Show Source
Nested Schema : LocationExtraInfoORA_5FPER_5FOPERATIVE_5FLEGAL_5FEMPprivateVO
Type: array
Show Source
Nested Schema : locationsV2-locationsEFFContainer-locationsEFF-LocationExtraInfoJE_5FES_5FPRL_5FNOprivateVO-item-response
Type: object
Show Source
Nested Schema : locationsV2-locationsEFFContainer-locationsEFF-LocationExtraInfoJE_5FES_5FPRL_5FYESprivateVO-item-response
Type: object
Show Source
Nested Schema : locationsV2-locationsEFFContainer-locationsEFF-LocationExtraInfoJE_5FES_5FRENTED_5FLOCATIONprivateVO-item-response
Type: object
Show Source
Nested Schema : locationsV2-locationsEFFContainer-locationsEFF-LocationExtraInfoJExESPropertyLocationprivateVO-item-response
Type: object
Show Source
Nested Schema : locationsV2-locationsEFFContainer-locationsEFF-LocationExtraInfoORA_5FPER_5FOPERATIVE_5FLEGAL_5FEMPprivateVO-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to retrieve a location using a query parameter, by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X GET "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/locationsV2?q=LocationCode='PL_CA'"

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type: application/vnd.oracle.adf.resourceitem+json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "items": [
    {
      "LocationId": 300100188136324,
      "LocationCode": "PL_CA",
      "LocationName": "Pleasanton",
      "EffectiveStartDate": "2018-01-01",
      "EffectiveEndDate": "4712-12-31",
      "ActionReasonCode": null,
      "ActionReason": null,
      "ActiveStatus": "A",
      "ActiveStatusMeaning": "Active",
      "SetId": 0,
      "SetCode": "COMMON",
      "SetName": "Common Set",
      "Description": "Pleasanton Office",
      "InventoryOrganizationId": 458,
      "InventoryOrganizationName": "Vision Services",
      "OfficialLanguageCode": "US",
      "OfficialLanguageMeaning": "American English",
      "EmailAddress": "example@example.com",
      "GeoHierarchyNodeCode": "DE",
      "MainPhoneCountryCode": "1",
      "MainPhoneAreaCode": "040",
      "MainPhoneNumber": "555-1212",
      "MainPhoneExtension": "555-1213",
      "FaxCountryCode": "1",
      "FaxAreaCode": "050",
      "FaxNumber": "555-9999999",
      "FaxExtension": "555-9999999",
      "OtherPhoneCountryCode": "244",
      "OtherPhoneAreaCode": "060",
      "OtherPhoneNumber": "555-2222",
      "OtherPhoneExtension": "555-2233",
      "ShipToSiteFlag": false,
      "ShipToLocationId": 3033,
      "ShipToLocationCode": "ARMY_PENTAGON_0_2452230072550",
      "ShipToLocationName": "Army Pentagon",
      "OfficeSiteFlag": true,
      "BillToSiteFlag": true,
      "ReceivingSiteFlag": true,
      "DesignatedReceiverId": 100100124777049,
      "DesignatedReceiverNumber": "GHR_LINE_MGR",
      "DesignatedReceiverName": "GHR_LINE_MGR",
      "CreatedBy": "HCM_INTEGRATION_SPEC",
      "CreationDate": "2020-05-28T17:44:47+00:00",
      "LastUpdatedBy": "HCM_INTEGRATION_SPEC",
      "LastUpdateDate": "2020-05-28T17:44:47.767+00:00",
      "links": [
         {.... 
             }
  ]
}
Back to Top