Oracle Fusionサービスでのナレッジ管理のREST API

機械翻訳について

言語を取得

get

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

このメソッドは、指定されたIDパラメータを持つLanguageオブジェクトを返します。

URIの例

このメソッドのURIの例を次に示します:

http://<IM_REST_API_HOST>/km/api/latest/languages/{id}
リクエストは、指定されたIDパラメータを持つLanguageオブジェクトをFULLモードで返します。
http://<IM_REST_API_HOST>/km/api/latest/languages/{id}?mode=KEY
このリクエストは、KEYモードで指定したIDパラメータを持つLanguageオブジェクトを返します。

リクエスト

パス・パラメータ

id: string

取得するオブジェクトの一意の識別子。

トップに戻る

レスポンス

サポートされるメディア・タイプ

application/json
application/xml

200 レスポンス

「OK」をクリックします。

ルート・スキーマ : 言語

タイプ: object

タイトル: Language

ソースを表示

dateAdded(optional): string(date-time)

言語オブジェクトが作成された日付。
dateModified(optional): string(date-time)

言語オブジェクトが変更された日付。
languageCode(optional): string

Languageオブジェクトが表す言語のコード。たとえば、英語の言語コードはenです。
languageDesc(optional): string

Languageオブジェクトが表す言語の説明。
links(optional): array links
locales(optional): array locales

Languageオブジェクトに関連付けられたLocaleオブジェクトのリスト。
recordId(optional): string

Languageオブジェクトの一意の識別子。

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

ネストされたスキーマ : リンク

タイプ: array

ソースを表示

Array of: object instanceLink

JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。

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

ネストされたスキーマ : ロケール

タイプ: array

Languageオブジェクトに関連付けられたLocaleオブジェクトのリスト。

ソースを表示

Array of: object LocaleKey

タイトル: LocaleKey

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

ネストされたスキーマ : instanceLink

タイプ: object

JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。

ソースを表示

href: string

URI [RFC3986]またはURIテンプレート[RFC6570]。値がURI Templateに設定されている場合、「templated」プロパティをtrueに設定する必要があります。
mediaType(optional): string

RFC 2046で定義された、リンク・ターゲットを説明するメディア・タイプ。
method(optional): string

リンクのターゲットをリクエストするためのHTTPメソッド。
profile(optional): string

ターゲット・リソースの参照解除時に予期されるリソースを記述する、JSONスキーマなどのリソースのメタデータへのリンク。
rel: string

リンクの詳細を取得するためにタイプ・プロパティに加えて使用できるリンク関係の名前。たとえば、hrefやprofileです。
templated(optional): boolean

hrefプロパティがURIまたはURIテンプレートであることを指定するブール・フラグ。プロパティがURIテンプレートの場合は、この値をtrueに設定します。デフォルトでは、この値は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"
}

ネストされたスキーマ : LocaleKey

タイプ: object

タイトル: LocaleKey

ソースを表示

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

ロケール・オブジェクトの一意の識別子。

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

ネストされたスキーマ : リンク

タイプ: array

ソースを表示

Array of: object instanceLink

JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。

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

トップに戻る

例

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、指定されたIDパラメータを持つLanguageオブジェクトを検索する方法を示しています。

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

リクエスト・ヘッダーの例

次に、リクエスト・ヘッダーの例を示します。

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"

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています:

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

「トップに戻る」