REST API for Knowledge Advanced in B2C Service

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.

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.

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 `en`.
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

Query Parameters

limit: 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:

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: 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: 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: 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

Supported Media Types

application/json
application/xml

200 Response

OK.

Root Schema : ResultList Language

Type: object

Title: ResultList Language

Match All

Show Source

allOf Collection Paging Resource

Title: Collection Paging Resource

Oracle base collection resource schema definition.
object ResultList Language-allOf[1]

{
    "title":"ResultList Language",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/collectionPagedResource"
        },
        {
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/Language"
                    }
                }
            }
        }
    ]
}

Nested Schema : Collection Paging Resource

Title: Collection Paging Resource

Oracle base collection resource schema definition.

Match All

Show Source

allOf Base Collection Resource

Title: Base Collection Resource

Oracle base collection resource schema definition.
object Collection Paging Resource-allOf[1]

{
    "title":"Collection Paging Resource",
    "description":"Oracle base collection resource schema definition. ",
    "allOf":[
        {
            "$ref":"#/definitions/collectionBaseResource"
        },
        {
            "properties":{
                "hasMore":{
                    "type":"boolean",
                    "description":"Boolean value that is set to true if more resources are available on the server than the subset returned in current page."
                },
                "totalResults":{
                    "type":"integer",
                    "description":"Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request."
                },
                "limit":{
                    "type":"integer",
                    "description":"Actual paging size used by the server."
                },
                "count":{
                    "type":"integer",
                    "description":"Number of resource instances returned in the current range."
                },
                "offset":{
                    "type":"integer",
                    "description":"Offset value used in the current page. "
                }
            }
        }
    ]
}

Nested Schema : Base Collection Resource

Title: Base Collection Resource

Oracle base collection resource schema definition.

Match All

Show Source

object Singular Resource

Title: Singular Resource

Oracle base singular resource schema definition.
object Base Collection Resource-allOf[1]

{
    "title":"Base Collection Resource",
    "description":"Oracle base collection resource schema definition. ",
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "type":"object"
                    }
                }
            }
        }
    ]
}

Nested Schema : Singular Resource

Type: object

Title: Singular Resource

Oracle base singular resource schema definition.

Show Source

links(optional): array links

{
    "title":"Singular Resource",
    "description":"Oracle base singular resource schema definition.",
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/instanceLink"
            }
        }
    }
}

Nested Schema : Base Collection Resource-allOf[1]

Type: object

Show Source

items(optional): array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    }
}

Nested Schema : Collection Paging Resource-allOf[1]

Type: object

Show Source

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.
limit(optional): integer

Actual paging size used by the server.
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.

{
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Boolean value that is set to true if more resources are available on the server than the subset returned in current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request."
        },
        "limit":{
            "type":"integer",
            "description":"Actual paging size used by the server."
        },
        "count":{
            "type":"integer",
            "description":"Number of resource instances returned in the current range."
        },
        "offset":{
            "type":"integer",
            "description":"Offset value used in the current page. "
        }
    }
}

Nested Schema : ResultList Language-allOf[1]

Type: object

Show Source

items(optional): array items

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

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

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

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

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.

{
    "type":"object",
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "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"
        },
        "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"
        },
        "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"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "type":"string"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "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"
    ]
}

Nested Schema : items

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : items

Type: array

Show Source

Array of: Language

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

Nested Schema : Language

Match All

Show Source

allOf LanguageKey
object Language-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/LanguageKey"
        },
        {
            "properties":{
                "dateAdded":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the Language object was created.</p>"
                },
                "dateModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the Language object was modified.</p>"
                },
                "languageCode":{
                    "type":"string",
                    "description":"<p>The code for the language that the Language object represents. For example, the language code for English is <code>en</code>.</p>"
                },
                "languageDesc":{
                    "type":"string",
                    "description":"<p>The description of the language that the Language object represents.</p>"
                },
                "locales":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LocaleKey"
                    },
                    "description":"<p>The list of Locale objects associated with the Language object.</p>"
                }
            }
        }
    ]
}

Nested Schema : LanguageKey

Match All

Show Source

object Singular Resource

Title: Singular Resource

Oracle base singular resource schema definition.
object LanguageKey-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the Language object.</p>"
                }
            }
        }
    ]
}

Nested Schema : LanguageKey-allOf[1]

Type: object

Show Source

recordId(optional): string

The unique identifier of the Language object.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier of the Language object.</p>"
        }
    }
}

Nested Schema : Language-allOf[1]

Type: object

Show Source

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.
locales(optional): array locales

The list of Locale objects associated with the Language object.

{
    "properties":{
        "dateAdded":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the Language object was created.</p>"
        },
        "dateModified":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the Language object was modified.</p>"
        },
        "languageCode":{
            "type":"string",
            "description":"<p>The code for the language that the Language object represents. For example, the language code for English is <code>en</code>.</p>"
        },
        "languageDesc":{
            "type":"string",
            "description":"<p>The description of the language that the Language object represents.</p>"
        },
        "locales":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LocaleKey"
            },
            "description":"<p>The list of Locale objects associated with the Language object.</p>"
        }
    }
}

Nested Schema : locales

Type: array

The list of Locale objects associated with the Language object.

Show Source

Array of: LocaleKey

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LocaleKey"
    },
    "description":"<p>The list of Locale objects associated with the Language object.</p>"
}

Nested Schema : LocaleKey

Match All

Show Source

object Singular Resource

Title: Singular Resource

Oracle base singular resource schema definition.
object LocaleKey-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the Locale object.</p>"
                }
            }
        }
    ]
}

Nested Schema : LocaleKey-allOf[1]

Type: object

Show Source

recordId(optional): string

The unique identifier of the Locale object.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier of the Locale object.</p>"
        }
    }
}

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
}