Get all locales assigned to language

get

/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

Path Parameters
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : ResultList LocaleKey
Type: object
Title: ResultList LocaleKey
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : LocaleKey
Type: object
Title: LocaleKey
Show Source
Back to Top

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"
            }
        ]
    }
}
Back to Top