1. REST API for Knowledge Management in Oracle Fusion Service
  2. Tasks
  3. Content (IM)
  4. Locales

Get a locale

get

/km/api/v1/locales/{id}

This method returns the Locale object specified by the ID parameter.

Example URIs

The example URIs for this method are as follows:

  • http://<IM_REST_API_HOST>/km/api/latest/locales/{id}

    This method returns the Locale object having the specified ID parameter in the FULL mode.

  • http://<IM_REST_API_HOST>/km/api/latest/locales/{id}?mode=KEY

    This method returns the Locale object having the specified ID parameter in KEY mode.

Request

Path Parameters
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : Locale
Type: object
Title: Locale
Show Source

  • The flag indicates whether the Locale object is active in the Oracle Knowledge system.

  • The date when the Locale object was added or created.

  • The prescribed format for displaying dates to the end users who are associated with the Locale object. The prescribed format class is com.webobjects.foundation.NSTimestampFormatter.

  • The prescribed format in which dates appears in the displayed content. The prescribed format class is java.text.DateFormat.

  • The date when the Locale object was last modified.

  • The prescribed encoding format used to display characters in the language.

  • The flag indicates whether the specified Locale object is the default object for the group. Locale objects are grouped according to the language they represent.

  • LanguageKey
    Title: LanguageKey
  • links

  • The unique code that represents the language and country associated with the Locale object.

  • The description about the language and country that the Locale object represents.

  • The Locale ID value for the language and country that the Locale object represents.

  • The unique identifier of the Locale object.

  • The prescribed format for displaying time to the end users associated with the Locale object. The prescribed format class is com.webobjects.foundation.NSTimestampFormatter.

  • The prescribed format in which time appears in the displayed content. The prescribed format class is java.text.DateFormat.

Nested Schema : LanguageKey
Type: object
Title: LanguageKey
Show Source
Back to Top

Examples

The following example shows how to find the Locale object that has the specified ID parameter by submitting a get request on the REST resource using cURL.

curl -X "GET" "http://IM_REST_API_HOST/km/api/latest/locales/{id}"

Example of Request Header

The following shows an example of the request header.

curl -X GET "https://<IM_REST_API_HOST>/km/api/latest/locales/{id}" -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": "sk_SK",
    "links": [
        {
            "rel": "canonical",
            "href": "https://<IM_REST_API_HOST>/km/api/v1/locales/sk_SK",
            "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": "sk_SK",
    "localeDesc": "Slovak - Slovakia",
    "localeValue": 1051,
    "timeFormat": "%H:%M",
    "timeFormatDisplay": "HH:mm",
    "language": {
        "recordId": "sk",
        "links": [
            {
                "rel": "canonical",
                "href": "https://<IM_REST_API_HOST>/km/api/v1/languages/sk",
                "mediaType": "application/json, application/xml",
                "method": "GET"
            }
        ]
    }
}
Back to Top