Get all countries
get
/hcmRestApi/resources/11.13.18.05/hcmCountriesLov
Request
Query Parameters
-
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 -
finder: string
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 countries that match the specified primary key criteria.
Finder Variables- PhoneCountryCodeId; integer; Country code identifier of the phone number.
- TerritoryCode; string; Code of the country.
- findByWord Finds all jobs that match the specified word.
Finder Variables- DataSecurityPrivilege; boolean; Data security privilege to secure the countries.
- ExcludeCountries; string; Countries that should be excluded.
- FilterAttributes; string; Attributes for the search terms.
- SearchTerms; string; Search term criteria to retrieve data.
- PrimaryKey Finds all countries that match the specified primary key criteria.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- CountryName; string; Name of the country.
- CurrencyCode; string; Currency code of the country.
- Description; string; Description of the country.
- NlsTerritory; string; Oracle territory code for the country.
- ObsoleteFlag; boolean; Indicates if the country is obsolete.
- PhoneCountryCode; string; Country code of the phone number.
- PhoneCountryCodeId; integer; Country code identifier of the phone number.
- TerritoryCode; string; Code of the country.
-
totalResults: boolean
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
-
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
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : hcmCountriesLov
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hcmCountriesLov-item-response
Type:
Show Source
object
-
AlternateTerritoryCode: string
Title:
Alternate Territory Code
Read Only:true
Maximum Length:30
Alternate territory code for the country. -
CountryName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the country. -
CurrencyCode: string
Title:
Currency Code
Read Only:true
Maximum Length:15
Currency code of the country. -
Description: string
Title:
Description
Read Only:true
Maximum Length:4000
Description of the country. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NlsTerritory: string
Title:
Oracle Territory Code
Read Only:true
Maximum Length:30
Oracle territory code for the country. -
ObsoleteFlag: boolean
Title:
Obsolete
Read Only:true
Maximum Length:1
Indicates if the country is obsolete. -
PhoneCountryCode: string
Title:
Phone Country Code
Read Only:true
Maximum Length:30
Country code of the phone number. -
PhoneCountryCodeId: integer
(int64)
Read Only:
true
Country code identifier of the phone number. -
TerritoryCode: string
Title:
Code
Read Only:true
Maximum Length:2
Code of the country.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following example shows how to retrieve all the countries 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/hcmCountriesLov
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": [ { "CountryName": "Afghanistan", "TerritoryCode": "AF", "Description": "The Transitional Islamic State of Afghanistan", "AlternateTerritoryCode": null, "PhoneCountryCodeId": 100000020962004, "PhoneCountryCode": "93", "CurrencyCode": "AFN", "NlsTerritory": null, "ObsoleteFlag": false, "links": [2] }, { "CountryName": "Aland Islands", "TerritoryCode": "AX", "Description": "Aland Islands", "AlternateTerritoryCode": null, "PhoneCountryCodeId": 100000020962029, "PhoneCountryCode": "358", "CurrencyCode": "EUR", "NlsTerritory": null, "ObsoleteFlag": false, "links": [2] }, { "CountryName": "Albania", "TerritoryCode": "AL", "Description": "Republic of Albania", "AlternateTerritoryCode": null, "PhoneCountryCodeId": 100000020962010, "PhoneCountryCode": "355", "CurrencyCode": "ALL", "NlsTerritory": "ALBANIA", "ObsoleteFlag": false, "links": [2] }, { "CountryName": "Algeria", "TerritoryCode": "DZ", "Description": "People's Democratic Republic of Algeria", "AlternateTerritoryCode": "ar-DZ", "PhoneCountryCodeId": 100000020962123, "PhoneCountryCode": "213", "CurrencyCode": "DZD", "NlsTerritory": "ALGERIA", "ObsoleteFlag": false, "links": [2] }, { "CountryName": "American Samoa", "TerritoryCode": "AS", "Description": "America Samoa (principal island Tutuila and includes Swain's Island)", "AlternateTerritoryCode": null, "PhoneCountryCodeId": 100000020962024, "PhoneCountryCode": "1", "CurrencyCode": "USD", "NlsTerritory": null, "ObsoleteFlag": false, "links": [2] }, { "CountryName": "Andorra", "TerritoryCode": "AD", "Description": "Principality of Andorra", "AlternateTerritoryCode": null, "PhoneCountryCodeId": 100000020962001, "PhoneCountryCode": "376", "CurrencyCode": "EUR", "NlsTerritory": null, "ObsoleteFlag": false, "links": [2] }, { "CountryName": "Angola", "TerritoryCode": "AO", "Description": "Republic of Angola (includes Cabinda)", "AlternateTerritoryCode": null, "PhoneCountryCodeId": 100000020962014, "PhoneCountryCode": "244", "CurrencyCode": "AOA", "NlsTerritory": null, "ObsoleteFlag": false, "links": [2] }, { "CountryName": "Anguilla", "TerritoryCode": "AI", "Description": "Anguilla", "AlternateTerritoryCode": null, "PhoneCountryCodeId": 100000020962008, "PhoneCountryCode": "1", "CurrencyCode": "XCD", "NlsTerritory": null, "ObsoleteFlag": false, "links": [2] }, { "CountryName": "Antarctica", "TerritoryCode": "AQ", "Description": "Territory south of 60 degrees south latitude", "AlternateTerritoryCode": null, "PhoneCountryCodeId": 100000020962017, "PhoneCountryCode": "672", "CurrencyCode": null, "NlsTerritory": null, "ObsoleteFlag": false, "links": [2] }, { "CountryName": "Antigua and Barbuda", "TerritoryCode": "AG", "Description": "Antigua and Barbuda (includes Redonda Island)", "AlternateTerritoryCode": null, "PhoneCountryCodeId": 100000020962006, "PhoneCountryCode": "1", "CurrencyCode": "XCD", "NlsTerritory": null, "ObsoleteFlag": false, "links": [2] }, { "CountryName": "Argentina", "TerritoryCode": "AR", "Description": "Argentine Republic", "AlternateTerritoryCode": "es-AR", "PhoneCountryCodeId": 100000020962018, "PhoneCountryCode": "54", "CurrencyCode": "ARS", "NlsTerritory": "ARGENTINA", "ObsoleteFlag": false, "links": [2] }, { "CountryName": "Armenia", "TerritoryCode": "AM", "Description": "Republic of Armenia", "AlternateTerritoryCode": null, "PhoneCountryCodeId": 100000020962012, "PhoneCountryCode": "374", "CurrencyCode": "AMD", "NlsTerritory": null, "ObsoleteFlag": false, "links": [2] }, { "CountryName": "Aruba", "TerritoryCode": "AW", "Description": "Aruba", "AlternateTerritoryCode": null, "PhoneCountryCodeId": 100000020962028, "PhoneCountryCode": "297", "CurrencyCode": "AWG", "NlsTerritory": null, "ObsoleteFlag": false, "links": [2] }, { "CountryName": "Australia", "TerritoryCode": "AU", "Description": "Australia (includes Lord Howe Island, Macquarie Island, Ashmore and Cartier Islands, and Coral Sea Islands which are Australian external territories)", "AlternateTerritoryCode": "en-AU", "PhoneCountryCodeId": 100000020962026, "PhoneCountryCode": "61", "CurrencyCode": "AUD", "NlsTerritory": "AUSTRALIA", "ObsoleteFlag": false, "links": [2] }, { "CountryName": "Austria", "TerritoryCode": "AT", "Description": "Republic of Austria", "AlternateTerritoryCode": "de-AT", "PhoneCountryCodeId": 100000020962025, "PhoneCountryCode": "43", "CurrencyCode": "EUR", "NlsTerritory": "AUSTRIA", "ObsoleteFlag": false, "links": [2] }, { "CountryName": "Azerbaijan", "TerritoryCode": "AZ", "Description": "Republic of Azerbaijan", "AlternateTerritoryCode": "az-AZ", "PhoneCountryCodeId": 100000020962030, "PhoneCountryCode": "994", "CurrencyCode": "AZN", "NlsTerritory": "AZERBAIJAN", "ObsoleteFlag": false, "links": [2] }, { "CountryName": "Bahamas", "TerritoryCode": "BS", "Description": "Commonwealth of the Bahamas", "AlternateTerritoryCode": null, "PhoneCountryCodeId": 100000020962050, "PhoneCountryCode": "1", "CurrencyCode": "BSD", "NlsTerritory": null, "ObsoleteFlag": false, "links": [2] }, { "CountryName": "Bahrain", "TerritoryCode": "BH", "Description": "Kingdom of Bahrain", "AlternateTerritoryCode": "ar-BH", "PhoneCountryCodeId": 100000020962041, "PhoneCountryCode": "973", "CurrencyCode": "BHD", "NlsTerritory": "BAHRAIN", "ObsoleteFlag": false, "links": [2] }, { "CountryName": "Bangladesh", "TerritoryCode": "BD", "Description": "People's Republic of Bangladesh", "AlternateTerritoryCode": null, "PhoneCountryCodeId": 100000020962034, "PhoneCountryCode": "880", "CurrencyCode": "BDT", "NlsTerritory": "BANGLADESH", "ObsoleteFlag": false, "links": [2] }, { "CountryName": "Barbados", "TerritoryCode": "BB", "Description": "Barbados", "AlternateTerritoryCode": null, "PhoneCountryCodeId": 100000020962032, "PhoneCountryCode": "1", "CurrencyCode": "BBD", "NlsTerritory": null, "ObsoleteFlag": false, "links": [2] }, { "CountryName": "Belarus", "TerritoryCode": "BY", "Description": "Republic of Belarus", "AlternateTerritoryCode": "be-BY", "PhoneCountryCodeId": 100000020962055, "PhoneCountryCode": "375", "CurrencyCode": "BYR", "NlsTerritory": "BELARUS", "ObsoleteFlag": false, "links": [2] }, { "CountryName": "Belgium", "TerritoryCode": "BE", "Description": "Kingdom of Belgium", "AlternateTerritoryCode": "nl-BE", "PhoneCountryCodeId": 100000020962035, "PhoneCountryCode": "32", "CurrencyCode": "EUR", "NlsTerritory": "BELGIUM", "ObsoleteFlag": false, "links": [2] }, { "CountryName": "Belize", "TerritoryCode": "BZ", "Description": "Belize", "AlternateTerritoryCode": null, "PhoneCountryCodeId": 100000020962056, "PhoneCountryCode": "501", "CurrencyCode": "BZD", "NlsTerritory": null, "ObsoleteFlag": false, "links": [2] }, { "CountryName": "Benin", "TerritoryCode": "BJ", "Description": "Republic of Benin", "AlternateTerritoryCode": null, "PhoneCountryCodeId": 100000020962043, "PhoneCountryCode": "229", "CurrencyCode": "XOF", "NlsTerritory": null, "ObsoleteFlag": false, "links": [2] }, { "CountryName": "Bermuda", "TerritoryCode": "BM", "Description": "Bermuda", "AlternateTerritoryCode": null, "PhoneCountryCodeId": 100000020962044, "PhoneCountryCode": "1", "CurrencyCode": "BMD", "NlsTerritory": null, "ObsoleteFlag": false, "links": [2] { ...} ] }