Get all locales assigned to language
/km/api/v1/languages/{id}/locales
This method returns a list of Locale objects associated with the Language object having the specified ID parameter.
A Locale object is identified by the language and country it represents. For example, English United States and English Great Britain are the two default Locales for the English language.
This resource supports the orderBy request parameter, which allows you to sort the returned list of Locale objects.
You can find the different values to use with the orderBy parameter in the schema and catalog information of the resource. To get the schema and catalog information, use GET method with the mediaType value as 'application/schema+json'
in the HTTP request.
The example URI to get schema and catalog of the resource is as follows:
http://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/locales
Example URIs
The example URIs for this method are as follows:
http://<IM_REST_API_HOST>/km/api/latest/languages/{id}/locales
The request returns a paginated list of Locale objects in the FULL mode that are associated with the specified Language object. By default, the Locale objects are sorted by the localeCode parameter value in ascending order.
http://<IM_REST_API_HOST>/km/api/latest/languages/{id}/locales?mode=KEY
The request returns a paginated list of Locale objects in the KEY mode that are associated with the specified Language object. By default, the Locale objects are sorted by the localeCode parameter value in ascending order.
http://<IM_REST_API_HOST>/km/api/latest/languages/{id}/locales?orderBy=localeDesc
The request returns a paginated list of Locale objects in the FULL mode that are associated with the specified Language object. The Locale objects are sorted by the localeDesc parameter value in ascending order.
Request
-
id(required): string
The unique identifier of the Language object
Response
- application/json
- application/xml
200 Response
object
ResultList LocaleKey
-
count:
integer
Number of resource instances returned in the current range.
-
hasMore:
boolean
Boolean value that is set to true if more resources are available on the server than the subset returned in current page.
-
items:
array items
-
limit:
integer
Actual paging size used by the server.
-
links:
array links
-
offset:
integer
Offset value used in the current page.
-
totalResults:
integer
Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
object
LocaleKey
-
links:
array links
-
recordId:
string
The unique identifier of the Locale object.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
object
-
href(required):
string
URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the "templated" property must be set to true.
-
mediaType:
string
Media type, as defined by RFC 2046, describing the link target.
-
method:
string
HTTP method for requesting the target of the link.
-
profile:
string
Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..
-
rel(required):
string
Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.
-
templated:
boolean
Boolean flag that specifies that "href" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.
Examples
The following example shows how to find a list of Locale objects for the specified Language object by submitting a get request on the REST resource using cURL.
curl -X "GET" "http://IM_REST_API_HOST/km/api/latest/languages/{id}/locales"
Example of Request Header
The following shows an example of the request header.
curl -X GET "https://<IM_REST_API_HOST>/km/api/latest/languages/{id}/locales" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json"
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "recordId": "ar_AE", "links": [ { "rel": "canonical", "href": "https://<IM_REST_API_HOST>/km/api/v1/locales/ar_AE", "mediaType": "application/json, application/xml", "method": "GET" }, { "rel": "collection", "href": "https://<IM_REST_API_HOST>/km/api/v1/locales", "mediaType": "application/json, application/xml", "method": "GET", "profile": "https://<IM_REST_API_HOST>/km/api/v1/metadata-catalog/locales" } ], "active": true, "dateAdded": "1970-01-01T23:11:11+0000", "dateFormat": "%d/%m/%Y", "dateFormatDisplay": "dd/mm/yyyy", "dateModified": "1970-01-01T23:11:11+0000", "encoding": "UTF-8", "groupDefault": true, "localeCode": "ar_AE", "localeDesc": "Arabic - United Arab Emirates", "localeValue": 14337, "timeFormat": "%I:%M %p", "timeFormatDisplay": "hh:mm", "language": { "recordId": "ar", "links": [ { "rel": "canonical", "href": "https://<IM_REST_API_HOST>/km/api/v1/languages/ar", "mediaType": "application/json, application/xml", "method": "GET" } ] } }