1. REST API for Knowledge Advanced in B2C Service
  2. Tasks
  3. Content (IM)
  4. Locales

Find all

get

/km/api/v1/locales

This method returns a list of Locale objects from the Oracle Knowledge system.

This resource supports the orderBy request parameter. Use this parameter along with the HTTP service request to sort the returned list.

You can find 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/locales

    The request returns a paginated list of Locale objects in the FULL mode. By default, the Locale objects are sorted according to the localeCode value in ascending order.

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

    The request returns a paginated list of Locale objects in the KEY mode. By default, the Locale objects are sorted according to the localeCode value in ascending order.

  • http://<IM_REST_API_HOST>/km/api/latest/locales?orderBy=localeDesc

    The request returns a paginated list of Locale objects in the FULL mode. The Locale objects are sorted according to the localeDesc parameter value in ascending order.

  • http://<IM_REST_API_HOST>/km/api/latest/locales?orderBy=dateAdded

    The request returns a paginated list of Locale objects in FULL mode. The objects in the list are sorted according to the date on which the Locale objects are created.


Find by query

Supported Media Types: 'application/json', 'application/xml'


This method returns a list of Locale objects that match the specified criteria.

This resource supports the orderBy request parameter. Use this parameter along with the HTTP service request to sort the returned list.

You can find 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/locales?q=groupDefault eq true

    The request returns a paginated list of Locale objects that are selected as default among the group of Locale objects. By default, the Locale objects are sorted by localeCode in ascending order.

  • http://<IM_REST_API_HOST>/km/api/latest/locales?q=language.languageCode eq 'en'&orderBy=localeCode

    The request returns a paginated list of Locale objects associated with the English language. By default, the Locale objects are sorted according to the localeCode parameter value in ascending order.

  • http://<IM_REST_API_HOST>/km/api/latest/locales?q=active eq true&orderBy=localeDesc

    The request returns a paginated list of Locale objects that are active in the Oracle Knowledge system. The Locale objects are sorted according to the localeDesc parameter value in ascending order.

Query Parameters

The following table describes the query parameters for this resource.

ParameterQueryableSortableTypeDescription
recordIdYY'type' : 'string'

The unique identifier of the Locale object.

activeYY'type' : 'boolean'

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

dateAddedYY'type' : 'string', 'format' : 'date-time'

The date when the Locale object was added or created.

dateFormatYY'type' : '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.

dateFormatDisplayYY'type' : 'string'

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

dateModifiedYY'type' : 'string', 'format' : 'date-time'

The date when the Locale object was last modified.

encodingYY'type' : 'string'

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

groupDefaultYY'type' : '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.

localeCodeYY'type' : 'string'

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

localeDescYY'type' : 'string'

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

localeValueYY'type' : 'integer'

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

timeFormatYY'type' : '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.

timeFormatDisplayYY'type' : 'string'

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

languageYN'$ref' : '#/definitions/LanguageKey'

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'

spellCheckingAlternateLocaleYN'$ref' : '#/definitions/LocaleKey'

The Locale object with which the Locale object is associated for speller purposes. The language is of type localeKeyBO and will generally be addressed using the recordId subfield. For example locale.recordId eq 'en'

Request

Query Parameters
  • 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.
  • This parameter defines amount of information to be included in the returned resources - KEY is the one that has least information (and hence performs better) and FULL is the one that has most information.
    Allowed Values: [ "KEY", "DATA", "EXTENDED", "FULL" ]
  • 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.
  • This parameter orders a resource collection based on the specified attributes. 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.
  • Value for this parameter should be Oracle Knowledge Q query - see the 'Getting Started' documentation ('Querying' page) of this operation and documentation for Q query.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : ResultList Locale
Type: object
Title: ResultList Locale
Match All
Show Source
Nested Schema : Collection Paging Resource
Title: Collection Paging Resource
Oracle base collection resource schema definition.
Match All
Show Source
Nested Schema : Base Collection Resource
Title: Base Collection Resource
Oracle base collection resource schema definition.
Match All
Show Source
Nested Schema : Singular Resource
Type: object
Title: Singular Resource
Oracle base singular resource schema definition.
Show Source
Nested Schema : Base Collection Resource-allOf[1]
Type: object
Show Source
Nested Schema : Collection Paging Resource-allOf[1]
Type: object
Show Source
Nested Schema : ResultList Locale-allOf[1]
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Nested Schema : items
Type: array
Show Source
Nested Schema : Locale
Match All
Show Source
Nested Schema : LocaleKey
Match All
Show Source
Nested Schema : LocaleKey-allOf[1]
Type: object
Show Source
Nested Schema : Locale-allOf[1]
Type: object
Show Source
Nested Schema : LanguageKey
Match All
Show Source
Nested Schema : LanguageKey-allOf[1]
Type: object
Show Source
Back to Top

Examples

The following example shows how to find all List objects from Oracle Knowledge repository by submitting a get request on the REST resource using cURL.

cURL Command

Command: curl -X "GET" "http://<IM_REST_API_HOST>/km/api/latest/locales"

Example of Request Header

The following shows an example of the request header.

-H "kmauthtoken: {\"siteName\":\"ORACLE_KNOWLEDGE\",\"integrationUserToken\":\"\"+eCJYkxKwj5HUaIiJYun0/TpatwT1LmtcsF05W33xnEojifV/AsLDj9RpN0lKuorTMNKeSE1tgC7svVL+BzntqDON4KiM1HFlpxvXEUCB0P2w0Xrs75McygqxdVaDSE9"}" \
-H "Accept: application/json"

Example of Response Body

The following shows an example of the response body in JSON format.

{
  "items" : [ {
    "active" : true,
    "dateAdded" : "2013-04-23T21:06:42EDT",
    "dateFormat" : "DATEFORMAT_VALUE",
    "dateFormatDisplay" : "DATEFORMATDISPLAY_VALUE",
    "dateModified" : "2013-04-23T21:06:42EDT",
    "encoding" : "UTF-8",
    "groupDefault" : true,
    "localeCode" : "en_US",
    "localeDesc" : "English United States",
    "localeValue" : 1033,
    "timeFormat" : "%I:%M %p",
    "timeFormatDisplay" : "hh:mm",
    "language" : {
      "links" : [ {
        "rel" : "canonical",
        "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}",
        "mediaType" : "application/json, application/xml",
        "templated" : true,
        "method" : "GET",
        "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}"
      } ]
    },
    "recordId" : "en_US",
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}"
    } ]
  } ],
  "hasMore" : false,
  "limit" : 20,
  "offset" : 0,
  "links" : [ {
    "rel" : "canonical",
    "href" : "http://<IM_REST_API_HOST>/km/api/{version}/locales?limit=20&offset=0",
    "mediaType" : "application/json, application/xml",
    "method" : "GET"
  } ],
  "count" : 1
}
Back to Top