Find all

get

/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.

Query Parameters

The following table describes the query parameters for this resource.

ParameterQueryableSortableTypeDescription
recordIdYY'type' : 'string'

The unique identifier of the Language object.

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

The date when the Language object was created.

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

The date when the Language object was modified.

languageCodeYY'type' : 'string'

The code for the language that the Language object represents. For example, the language code for English is en.

languageDescYY'type' : 'string'

The description of the language that the Language object represents.

localesYN'$ref' : '#/definitions/ListLocaleKey'

The list of Locale objects associated with the Language object.

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 Language
Type: object
Title: ResultList Language
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 Language-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 : Language
Match All
Show Source
Nested Schema : LanguageKey
Match All
Show Source
Nested Schema : LanguageKey-allOf[1]
Type: object
Show Source
Nested Schema : Language-allOf[1]
Type: object
Show Source
Nested Schema : locales
Type: array

The list of Locale objects associated with the Language object.

Show Source
Nested Schema : LocaleKey
Match All
Show Source
Nested Schema : LocaleKey-allOf[1]
Type: object
Show Source
Back to Top

Examples

The following example shows how to find all Language 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/languages"

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" : [ {
    "dateAdded" : "2013-05-23T17:56:05EDT",
    "dateModified" : "2013-05-23T17:56:05EDT",
    "languageCode" : "en",
    "languageDesc" : "English",
    "locales" : [ {
      "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}"
      } ]
    } ],
    "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}/languages?limit=20&offset=0",
    "mediaType" : "application/json, application/xml",
    "method" : "GET"
  } ],
  "count" : 1
}
Back to Top