Get all languages
/km/api/v1/languages
This method returns a list of Language objects from the Oracle Knowledge Repository.
This resource supports the orderBy request parameter, which allows you to sort the returned list of Language 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 information of the resource is as follows:
http://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/languages
Example URIs
The example URIs for this method are as follows:
http://<IM_REST_API_HOST>/km/api/latest/languages
The request returns a paginated list of Language objects in the FULL mode. By default, the Language objects are sorted by the date when the object was created, in ascending order.
http://<IM_REST_API_HOST>/km/api/latest/languages?mode=KEY
The request returns a paginated list of Language objects in the KEY mode. By default, the Language objects are sorted by the date when the object was created, in ascending order.
http://<IM_REST_API_HOST>/km/api/latest/languages?orderBy=languageDesc
The request returns a paginated list of Language objects in the FULL mode. The Language objects are sorted by the languageDesc parameter value in ascending order.
Find by query
Supported Media Types: 'application/json', 'application/xml'
This method returns a list of Language objects that match the specified criteria.
This resource supports the orderBy request parameter, which allows you to sort the returned list of Language 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 information of the resource is as follows:
http://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/languages
Example URIs
The example URIs for this method are as follows:
http://<IM_REST_API_HOST>/km/api/latest/languages/?q=languageDesc likeAny ('*English*')
The request returns a paginated list of Language objects that contain the term
English
in the language description. By default, the Language objects are sorted by the date when the object was created, in ascending order.http://<IM_REST_API_HOST>/km/api/latest/languages?q=languageCode eq 'en'
The request returns a paginated list of Language objects associated with the English language. By default, the Language objects are sorted by the date when the object was created, in ascending order.
http://<IM_REST_API_HOST>/km/api/latest/languages?q=locales.recordId in ('en_US','en_GB')&orderBy=languageCode
The request returns a paginated list of Language objects associated with the Locale objects representing United States English and Great Britain English. The Language objects are sorted by the languageCode 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 Language object. |
dateAdded | Y | Y | 'type' : 'string', 'format' : 'date-time' | The date when the Language object was created. |
dateModified | Y | Y | 'type' : 'string', 'format' : 'date-time' | The date when the Language object was modified. |
languageCode | Y | Y | 'type' : 'string' | The code for the language that the Language object represents. For example, the language code for English is |
languageDesc | Y | Y | 'type' : 'string' | The description of the language that the Language object represents. |
locales | Y | N | '$ref' : '#/definitions/ListLocaleKey' | The list of Locale objects associated with the Language object. |
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 Language
-
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
Language
-
dateAdded(optional):
string(date-time)
The date when the Language object was created.
-
dateModified(optional):
string(date-time)
The date when the Language object was modified.
-
languageCode(optional):
string
The code for the language that the Language object represents. For example, the language code for English is
en
. -
languageDesc(optional):
string
The description of the language that the Language object represents.
-
links(optional):
array links
-
locales(optional):
array locales
The list of Locale objects associated with the Language object.
-
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
The list of Locale objects associated with the Language object.
-
Array of:
object LocaleKey
Title:
LocaleKey
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.
object
LocaleKey
-
links(optional):
array links
-
recordId(optional):
string
The unique identifier of the Locale object.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
Examples
The following example shows how to find a list of Language 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/languages"
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" -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": "af", "links": [ { "rel": "canonical", "href": "https://<IM_REST_API_HOST>/km/api/v1/languages/af", "mediaType": "application/json, application/xml", "method": "GET" }, { "rel": "collection", "href": "https://<IM_REST_API_HOST>/km/api/v1/languages", "mediaType": "application/json, application/xml", "method": "GET", "profile": "https://<IM_REST_API_HOST>/km/api/v1/metadata-catalog/languages" } ], "dateAdded": "1970-01-01T23:11:11+0000", "dateModified": "1970-01-01T23:11:11+0000", "languageCode": "af", "languageDesc": "Afrikaans", "locales": [] } ], "hasMore": true, "limit": 1, "offset": 0, "links": [ { "rel": "canonical", "href": "https://<IM_REST_API_HOST>/km/api/v1/languages/?limit=1&offset=0", "mediaType": "application/json, application/xml", "method": "GET" }, { "rel": "next", "href": "https://<IM_REST_API_HOST>/km/api/v1/languages/?limit=1&offset=1", "mediaType": "application/json, application/xml", "method": "GET" } ], "count": 1 }