1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. List of Values
  4. Locations List of Values

Get all locations

get

/hcmRestApi/resources/11.13.18.05/locationsLov

Request

Query Parameters
  • This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
  • 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
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds all locations that match the primary key criteria specified.
      Finder Variables
      • EffectiveEndDate; string; Date at the end of the period within which the location is effective.
      • EffectiveStartDate; string; Date at the beginning of the period within which the location is effective.
      • LocationId; integer; Surrogate identifier for the location.
    • findByBusinessUnit Finds all locations that match the specified business unit.
      Finder Variables
      • BusinessUnitId; integer; Surrogate identifier for the business unit.
      • BusinessUnitName; string; Name of the business unit.
      • EmployeeLocFlag; boolean; Indicates whether location is an employee location or not.
      • FetchBlankInvOrgLocation; boolean; Indicates whether an inventory location is associated with this location. The valid values are true and false.
      • IncludeCommonSet; boolean; Indicates whether the common set must be included.
      • InventoryOrgId; integer; Unique identifier of the inventory organization to which the location belongs.
      • LegalEmpId; integer; Unique Identifier for the legal employer.
    • findByLocationId Finds all locations that match the specified location identifier.
      Finder Variables
      • LocationId; integer; Surrogate identifier for the location.
      • SysEffectiveDate; object;
    • findBySet Finds all locations that match the specified set.
      Finder Variables
      • SetCode; string; Code of the set to which the location belongs.
      • SetId; integer; Surrogate identifier of the set to which the location belongs.
      • SetName; string; Name of the set to which the location belongs.
      • SysEffectiveDate; object;
    • findByWord Finds all locations that match the specified word.
      Finder Variables
      • EmployeeLocationFlag; boolean; Indicates whether the location is an employee location.
      • FetchBlankInvOrgLocations; boolean; Indicates whether an inventory location is associated with this location. The valid values are true and false.
      • FilterAttributes; string; Filter attributes for the search criteria.
      • InventoryOrganizationId; integer; Unique identifier for the inventory organization to which the location belongs.
      • IsReceivingSiteLocation; boolean; Indicates whether the location is a receiving site location.
      • IsShipToSiteLocation; boolean; Indicates whether the location is a ship-to location.
      • LegalEmployerId; integer; Unique Identifier for the legal employer.
      • SearchTerms; string; Search term criteria to find the location.
      • SetId; integer; Surrogate identifier of the set to which the location belongs.
      • SysEffectiveDate; object;
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ActiveStatus; string; Status of the location such as active or inactive.
    • CountryCode; string; Country code for the location address.
    • CountryName; string; Country name for the location address.
    • InventoryOrganizationId; integer; Surrogate identifier for the inventory organization.
    • InventoryOrganizationName; string; Name of the inventory organization.
    • LocationCode; string; Code that uniquely references the location within the set.
    • LocationId; integer; Surrogate identifier for the location.
    • LocationName; string; Name of the location.
    • PostalCode; string; Postal code of the location address.
    • Region1; string; Primary region in which the address is located.
    • Region2; string; Subregion in which the address is located.
    • SetCode; string; Code of the set to which the location belongs.
    • SetId; integer; Surrogate identifier of the set to which the location belongs.
    • SetName; string; Name of the set to which the location belongs.
    • TimezoneCode; string; Time zone code for the location address.
    • TownOrCity; string; Town or city of the location address.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : locationsLov
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : locationsLov-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to retrieve all the locations 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" -H "REST-Framework-Version: 4""-X GET "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/locationsLov"

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": 25115,
          "EffectiveStartDate": "0001-01-01",
          "EffectiveEndDate": "4712-12-31",
          "LocationCode": "84HOUSTON_0_2454201114730",
          "LocationName": "84Houston",
          "ActiveStatus": "A",
          "CountryCode": "US",
          "CountryName": "United States",
          "Region1": "Montgomery",
          "Region2": "TX",
          "TownOrCity": "Houston",
          "PostalCode": "77002",
          "SetId": 0,
          "SetCode": "COMMON",
          "SetName": "Common Set",
          "links": [2]
      },
      {
          "LocationId": 25116,
          "EffectiveStartDate": "0001-01-01",
          "EffectiveEndDate": "4712-12-31",
          "LocationCode": "84ORLANDO_0_2454201114836",
          "LocationName": "84Orlando",
          "ActiveStatus": "A",
          "CountryCode": "US",
          "CountryName": "United States",
          "Region1": "Orange",
          "Region2": "FL",
          "TownOrCity": "Orlando",
          "PostalCode": "32822",
          "SetId": 0,
          "SetCode": "COMMON",
          "SetName": "Common Set",
          "links": [2]
      },
      {
          "LocationId": 1861233,
          "EffectiveStartDate": "0001-01-01",
          "EffectiveEndDate": "4712-12-31",
          "LocationCode": "A1_LOCATION_0_2454664002530",
          "LocationName": "A1 Location",
          "ActiveStatus": "A",
          "CountryCode": "IN",
          "CountryName": "India",
          "Region1": null,
          "Region2": null,
          "TownOrCity": null,
          "PostalCode": "500074",
          "SetId": 0,
          "SetCode": "COMMON",
          "SetName": "Common Set",
          "links": [2]
		         {
               ...}
  ]
}
Back to Top