REST API for Knowledge Management in Oracle Fusion Service

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

id: string

The unique identifier of the object to be retrieved.

Response

Supported Media Types

application/json
application/xml

200 Response

OK.

Root Schema : Locale

Type: object

Title: Locale

Show Source

active(optional): boolean

The flag indicates whether the Locale object is active in the Oracle Knowledge system.
dateAdded(optional): string(date-time)

The date when the Locale object was added or created.
dateFormat(optional): string

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.
dateFormatDisplay(optional): string

The prescribed format in which dates appears in the displayed content. The prescribed format class is java.text.DateFormat.
dateModified(optional): string(date-time)

The date when the Locale object was last modified.
encoding(optional): string

The prescribed encoding format used to display characters in the language.
groupDefault(optional): boolean

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.
language(optional): object LanguageKey

Title: LanguageKey
links(optional): array links
localeCode(optional): string

The unique code that represents the language and country associated with the Locale object.
localeDesc(optional): string

The description about the language and country that the Locale object represents.
localeValue(optional): integer

The Locale ID value for the language and country that the Locale object represents.
recordId(optional): string

The unique identifier of the Locale object.
timeFormat(optional): string

The prescribed format for displaying time to the end users associated with the Locale object. The prescribed format class is com.webobjects.foundation.NSTimestampFormatter.
timeFormatDisplay(optional): string

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

{
    "title":"Locale",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the Locale object.</p>",
            "type":"string"
        },
        "groupDefault":{
            "description":"<p>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.</p>",
            "type":"boolean"
        },
        "localeValue":{
            "description":"<p>The Locale ID value for the language and country that the Locale object represents.</p>",
            "type":"integer"
        },
        "dateModified":{
            "description":"<p>The date when the Locale object was last modified.</p>",
            "format":"date-time",
            "type":"string"
        },
        "timeFormat":{
            "description":"<p>The prescribed format for displaying time to the end users associated with the Locale object. The prescribed format class is <code>com.webobjects.foundation.NSTimestampFormatter</code>.</p>",
            "type":"string"
        },
        "localeDesc":{
            "description":"<p>The description about the language and country that the Locale object represents.</p>",
            "type":"string"
        },
        "dateAdded":{
            "description":"<p>The date when the Locale object was added or created.</p>",
            "format":"date-time",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "localeCode":{
            "description":"<p>The unique code that represents the language and country associated with the Locale object.</p>",
            "type":"string"
        },
        "timeFormatDisplay":{
            "description":"<p>The prescribed format in which time appears in the displayed content. The prescribed format class is <code>java.text.DateFormat</code>.</p>",
            "type":"string"
        },
        "encoding":{
            "description":"<p>The prescribed encoding format used to display characters in the language.</p>",
            "type":"string"
        },
        "active":{
            "description":"<p>The flag indicates whether the Locale object is active in the Oracle Knowledge system.</p>",
            "type":"boolean"
        },
        "dateFormat":{
            "description":"<p>The prescribed format for displaying dates to the end users who are associated with the Locale object. The prescribed format class is <code>com.webobjects.foundation.NSTimestampFormatter</code>.</p>",
            "type":"string"
        },
        "language":{
            "description":"<p>The Language object with which the Locale object is associated.  The language is of type languageKeyBO and will generally be addressed using the recordId subfield.  For example language.recordId eq 'en'</p>",
            "$ref":"#/definitions/LanguageKey"
        },
        "dateFormatDisplay":{
            "description":"<p>The prescribed format in which dates appears in the displayed content. The prescribed format class is <code>java.text.DateFormat</code>.</p>",
            "type":"string"
        }
    }
}

Nested Schema : LanguageKey

Type: object

Title: LanguageKey

Show Source

links(optional): array links
recordId(optional): string

The unique identifier of the Language object.

{
    "title":"LanguageKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the Language object.</p>",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

Nested Schema : instanceLink

Type: object

Metadata describing link description objects that MAY appear in the JSON instance representation.

Show Source

href: 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(optional): string

Media type, as defined by RFC 2046, describing the link target.
method(optional): string

HTTP method for requesting the target of the link.
profile(optional): string

Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..
rel: 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(optional): 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.

{
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "templated":{
            "description":"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.",
            "type":"boolean"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "type":"string"
        },
        "rel":{
            "description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.",
            "type":"string"
        },
        "href":{
            "description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.",
            "type":"string"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "type":"string"
        },
        "profile":{
            "description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..",
            "type":"string"
        }
    },
    "required":[
        "href",
        "rel"
    ],
    "type":"object"
}

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"
            }
        ]
    }
}