Jump to

• Request
• Response
• Examples

Find by ID

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(required): string
  The unique identifier of the object to be retrieved.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK.

Body ()

Root 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 : Singular Resource

Type: object

Title: Singular Resource

Oracle base singular resource schema definition.

Show Source

• links: array links

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

Nested Schema : LanguageKey-allOf[1]

Type: object

Show Source

• recordId: 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: string(date-time)

  The date when the Language object was created.

• dateModified: string(date-time)

  The date when the Language object was modified.

• languageCode: string

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

• languageDesc: string

  The description of the language that the Language object represents.

• locales: 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 : 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(required): 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: string
  Media type, as defined by RFC 2046, describing the link target.
• method: string
  HTTP method for requesting the target of the link.
• profile: string
  Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..
• rel(required): 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: 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 : 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: string

  The unique identifier of the Locale object.

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

Back to Top

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 Command

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.

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

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

Back to Top