Get all locales
/km/api/v1/locales
This method returns a list of Locale objects from the Oracle Knowledge repository.
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.
The following table describes the query parameters for this resource.
Parameter | Queryable | Sortable | Type | Description |
---|---|---|---|---|
recordId | Y | Y | 'type' : 'string' | The unique identifier of the Locale object. |
active | Y | Y | 'type' : 'boolean' | The flag indicates whether the Locale object is active in the Oracle Knowledge system. |
dateAdded | Y | Y | 'type' : 'string', 'format' : 'date-time' | The date when the Locale object was added or created. |
dateFormat | Y | Y | 'type' : 'string' | The prescribed format for displaying dates to the end users who are associated with the Locale object. The prescribed format class is |
dateFormatDisplay | Y | Y | 'type' : 'string' | The prescribed format in which dates appears in the displayed content. The prescribed format class is |
dateModified | Y | Y | 'type' : 'string', 'format' : 'date-time' | The date when the Locale object was last modified. |
encoding | Y | Y | 'type' : 'string' | The prescribed encoding format used to display characters in the language. |
groupDefault | Y | Y | '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. |
localeCode | Y | Y | 'type' : 'string' | The unique code that represents the language and country associated with the Locale object. |
localeDesc | Y | Y | 'type' : 'string' | The description about the language and country that the Locale object represents. |
localeValue | Y | Y | 'type' : 'integer' | The Locale ID value for the language and country that the Locale object represents. |
timeFormat | Y | Y | 'type' : 'string' | The prescribed format for displaying time to the end users associated with the Locale object. The prescribed format class is |
timeFormatDisplay | Y | Y | 'type' : 'string' | The prescribed format in which time appears in the displayed content. The prescribed format class is |
language | Y | N | '$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' |
Request
-
limit(optional): integer
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.
-
mode(optional): string
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" ]
-
offset(optional): integer
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.
-
orderBy(optional): string
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.
-
q(optional): string
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.
Response
- application/json
- application/xml
200 Response
object
ResultList Locale
-
count(optional):
integer
Number of resource instances returned in the current range.
-
hasMore(optional):
boolean
Boolean value that is set to true if more resources are available on the server than the subset returned in current page.
-
items(optional):
array items
-
limit(optional):
integer
Actual paging size used by the server.
-
links(optional):
array links
-
offset(optional):
integer
Offset value used in the current page.
-
totalResults(optional):
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
Locale
-
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
.
object
LanguageKey
-
links(optional):
array links
-
recordId(optional):
string
The unique identifier of the Language object.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
object
-
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.
Examples
The following example shows how to find a list of Locale objects from the Oracle Knowledge repository by submitting a get request on the REST resource using cURL.
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.
curl -X GET "https://<IM_REST_API_HOST>/km/api/latest/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:
{ "items": [ { "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" } ] } } ], "hasMore": true, "limit": 1, "offset": 0, "links": [ { "rel": "canonical", "href": "https://<IM_REST_API_HOST>/km/api/v1/locales?limit=1&offset=0", "mediaType": "application/json, application/xml", "method": "GET" }, { "rel": "next", "href": "https://<IM_REST_API_HOST>/km/api/v1/locales?limit=1&offset=1", "mediaType": "application/json, application/xml", "method": "GET" } ], "count": 1 }