REST API for Knowledge Management in Oracle Fusion Service

Get a language

get

/km/api/v1/languages/{id}

This method returns the Language object having the specified ID parameter.

Example URIs

The example URIs for this method are as follows:

http://<IM_REST_API_HOST>/km/api/latest/languages/{id}
The request returns the Language object having the specified ID parameter in FULL mode.
http://<IM_REST_API_HOST>/km/api/latest/languages/{id}?mode=KEY
The request returns the Language object having the specified ID parameter in KEY mode.

Request

Path Parameters

id: string

The unique identifier of the object to be retrieved.

Response

Supported Media Types

application/json
application/xml

200 Response

OK.

Root Schema : Language

Type: object

Title: Language

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

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

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

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

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

Nested Schema : locales

Type: array

The list of Locale objects associated with the Language object.

Show Source

Array of: object LocaleKey

Title: LocaleKey

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

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.

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

Nested Schema : LocaleKey

Type: object

Title: LocaleKey

Show Source

links(optional): array links
recordId(optional): string

The unique identifier of the Locale object.

{
    "title":"LocaleKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the Locale object.</p>",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

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

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

Examples

The following example shows how to find the Language object that has the specified ID parameter by submitting a get request on the REST resource using cURL.

curl -X "GET" "http://IM_REST_API_HOST/km/api/latest/languages/{id}"

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/{id}" -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:

{
    "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": []
}