Get a location
/hcmRestApi/resources/11.13.18.05/locationsLov/{locationsLovUniqID}
Request
-
locationsLovUniqID(required): string
This is the hash key of the attributes which make up the composite key--- LocationId, EffectiveStartDate and EffectiveEndDate ---for the Locations List of Values resource and used to uniquely identify an instance of Locations List of Values. The client should not generate the hash key value. Instead, the client should query on the Locations List of Values collection resource with a filter on the primary key values in order to navigate to a specific instance of Locations List of Values.
For example: locationsLov?q=LocationId=<value1>;EffectiveStartDate=<value2>;EffectiveEndDate=<value3>
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
Effective-Of:
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. -
Metadata-Context:
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".
-
REST-Framework-Version:
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 TopResponse
- application/json
Default Response
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
object
-
ActiveStatus: string
Title:
Status
Read Only:true
Maximum Length:30
Status of the location such as active or inactive. -
CountryCode: string
Title:
Country Code
Read Only:true
Maximum Length:60
Country code for the location address. -
CountryName: string
Title:
Country
Read Only:true
Maximum Length:80
Country name for the location address. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
Read Only:true
Date at the end of the period within which the location is effective. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Read Only:true
Date at the beginning of the period within which the location is effective. -
InventoryOrganizationId: integer
(int64)
Title:
Inventory Organization ID
Read Only:true
Surrogate identifier for the inventory organization. -
InventoryOrganizationName: string
Title:
Inventory Organization
Read Only:true
Maximum Length:240
Name of the inventory organization. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationCode: string
Title:
Code
Read Only:true
Maximum Length:150
Code that uniquely references the location within the set. -
LocationId: integer
(int64)
Read Only:
true
Surrogate identifier for the location. -
LocationName: string
Title:
Name
Read Only:true
Maximum Length:60
Name of the location. -
PostalCode: string
Title:
Postal Code
Read Only:true
Maximum Length:30
Postal code of the location address. -
Region1: string
Title:
Region 1
Read Only:true
Maximum Length:120
Primary region in which the address is located. -
Region2: string
Title:
Region 2
Read Only:true
Maximum Length:120
Subregion in which the address is located. -
SetCode: string
Title:
Set Code
Read Only:true
Maximum Length:30
Code of the set to which the location belongs. -
SetId: integer
(int64)
Title:
Set
Read Only:true
Surrogate identifier of the set to which the location belongs. -
SetName: string
Title:
Set
Read Only:true
Maximum Length:80
Name of the set to which the location belongs. -
SingleLineAddress: string
Title:
Address
Read Only:true
Address of the location. -
TimezoneCode: string
Title:
Time Zone Code
Read Only:true
Maximum Length:50
Time zone code for the location address. -
TownOrCity: string
Title:
Town or City
Read Only:true
Maximum Length:30
Town or city of the location address.
array
Links
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following examples show how to retrieve a location by submitting a GET request on the REST resource using cURL.
Use a Query Parameter
In this example, the query parameter LocationId
is used to retrieve
a location. The following is an example of the cURL command.
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?q=LocationId=300100026725092"
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": 300100026725092, "EffectiveStartDate": "1951-01-01", "EffectiveEndDate": "4712-12-31", "LocationCode": "ABC001", "LocationName": "ABC Location", "ActiveStatus": "A", "CountryCode": "US", "CountryName": "United States", "Region1": "Yap", "Region2": "F.S. of Micronesia", "TownOrCity": "Faraulep", "PostalCode": "96943", "SetId": 0, "SetCode": "COMMON", "SetName": "Common Set", "links": [2] { ...} ] }
Use Finders
Example 1
In this example, the finder findByWord
is used with the finder variables SearchTerms
and FilterAttributes
to retrieve the locations that match the specified criteria. The
following is an example of the cURL command.
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?finder=findByWord;SearchTerms=AM,FilterAttributes=LocationCode LocationName"
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": 20699, "EffectiveStartDate": "0001-01-01", "EffectiveEndDate": "4712-12-31", "LocationCode": "AM1_-_A&D_MAINTENANCE_OPS,_MAINTENANCE_BASE_US1_0_2453319051529", "LocationName": "AM1 - A&D Maintenance Ops, Maintenance Base US1", "ActiveStatus": "A", "CountryCode": "US", "CountryName": "United States", "Region1": "Dallas", "Region2": "TX", "TownOrCity": "Dallas", "PostalCode": "75201", "SetId": 0, "SetCode": "COMMON", "SetName": "Common Set", "links": [2] }, { "LocationId": 20700, "EffectiveStartDate": "0001-01-01", "EffectiveEndDate": "4712-12-31", "LocationCode": "AM2_-_A&D_MAINTENANCE_OPS,_MAINTENANCE_BASE_US2_0_2453319060420", "LocationName": "AM2 - A&D Maintenance Ops, Maintenance Base US2", "ActiveStatus": "A", "CountryCode": "US", "CountryName": "United States", "Region1": "Brevard", "Region2": "FL", "TownOrCity": "Melbourne", "PostalCode": "32901", "SetId": 0, "SetCode": "COMMON", "SetName": "Common Set", "links": [2] }, { "LocationId": 20718, "EffectiveStartDate": "0001-01-01", "EffectiveEndDate": "4712-12-31", "LocationCode": "AM3_-_A&D_MAINTENANCE_OPS,_EUROPEAN_BASE_0_2453319081405", "LocationName": "AM3 - A&D Maintenance Ops, European Base", "ActiveStatus": "A", "CountryCode": "GB", "CountryName": "United Kingdom", "Region1": null, "Region2": null, "TownOrCity": "Manchester", "PostalCode": "MC12 9EX", "SetId": 0, "SetCode": "COMMON", "SetName": "Common Set", "links": [2] { ...} ] }
Example 2
In this example, the
finder findByLocationId
is used with the finder variable LocationId
to retrieve the locations that match the specified
criteria. The following is an example of the cURL command.
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?finder=findByLocationId;LocationId=300100098646721"
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": 300100098646721, "EffectiveStartDate": "1990-01-01", "EffectiveEndDate": "4712-12-31", "LocationCode": "DDT_W2_US_Hamilton OH", "LocationName": "DDT_W2_US_Hamilton OH", "ActiveStatus": "A", "CountryCode": "US", "CountryName": "United States", "Region1": "BUTLER", "Region2": "OH", "TownOrCity": "HAMILTON", "PostalCode": "45015", "SetId": 0, "SetCode": "COMMON", "SetName": "Common Set", "links": [2] { ...} ] }
Example 3
In this example, the
finder findByBusinessUnit
is used with the finder variable BusinessUnitId
to retrieve the locations that match the
specified criteria. The following is an example of the cURL command.
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?finder=findByBusinessUnit;BusinessUnitId=202"
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": 16306, "EffectiveStartDate": "0001-01-01", "EffectiveEndDate": "4712-12-31", "LocationCode": "ADDISON_TX_0_2452684152807", "LocationName": "Addison TX", "ActiveStatus": "A", "CountryCode": "US", "CountryName": "United States", "Region1": "Dallas", "Region2": "TX", "TownOrCity": "Addison", "PostalCode": "75001", "SetId": 0, "SetCode": "COMMON", "SetName": "Common Set", "links": [2] }, { "LocationId": 2084, "EffectiveStartDate": "0001-01-01", "EffectiveEndDate": "4712-12-31", "LocationCode": "ADELAIDE_0_2451947154351", "LocationName": "Adelaide", "ActiveStatus": "A", "CountryCode": "AU", "CountryName": "Australia", "Region1": "SA", "Region2": null, "TownOrCity": "Adelaide", "PostalCode": "5000", "SetId": 0, "SetCode": "COMMON", "SetName": "Common Set", "links": [2] }, { "LocationId": 300100067490098, "EffectiveStartDate": "2015-03-24", "EffectiveEndDate": "4712-12-31", "LocationCode": "AKLOC", "LocationName": "AKLOC", "ActiveStatus": "A", "CountryCode": "US", "CountryName": "United States", "Region1": "ARLINGTON", "Region2": "VA", "TownOrCity": "ARLINGTON", "PostalCode": "22209", "SetId": 0, "SetCode": "COMMON", "SetName": "Common Set", "links": [2] { ...} ] }
Example 4
In this example, the
finder findBySet
is used
with the finder variable SetId
to retrieve the locations that match the specified criteria. The
following is an example of the cURL command.
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?finder=findBySet;SetId=0"
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": 300100166437458, "EffectiveStartDate": "1951-01-01", "EffectiveEndDate": "4712-12-31", "LocationCode": "999 Bad Address", "LocationName": "999 Bad Address", "ActiveStatus": "A", "CountryCode": "US", "CountryName": "United States", "Region1": "SUFFOLK", "Region2": "MA", "TownOrCity": "BOSTON", "PostalCode": "2228", "SetId": 0, "SetCode": "COMMON", "SetName": "Common Set", "links": [2] { ...} ] }