機械翻訳について
  1. Oracle Fusionサービスでのナレッジ管理のREST API
  2. タスク
  3. コンテンツ(IM)
  4. 言語

すべての言語の取得

get

/km/api/v1/languages

このメソッドは、Oracle Knowledge Repositoryから言語オブジェクトのリストを返します。

このリソースは、返される言語オブジェクトのリストをソートできるorderByリクエスト・パラメータをサポートしています。

orderByパラメータで使用する様々な値は、スキーマおよびリソースのカタログ情報で確認できます。 スキーマおよびカタログ情報を取得するには、HTTPリクエストでmediaType値を'application/schema+json'としてGETメソッドを使用します。

リソースのスキーマおよびカタログ情報を取得するURIの例を次に示します:

  • http://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/languages

URIの例

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

  • http://<IM_REST_API_HOST>/km/api/latest/languages

    リクエストによって、言語オブジェクトのページ区切りリストがFULLモードで返されます。 デフォルトでは、Languageオブジェクトは、オブジェクトが作成された日付の昇順でソートされます。

  • http://<IM_REST_API_HOST>/km/api/latest/languages?mode=KEY

    このリクエストは、KEYモードで言語オブジェクトのページ区切りリストを返します。 デフォルトでは、Languageオブジェクトは、オブジェクトが作成された日付の昇順でソートされます。

  • http://<IM_REST_API_HOST>/km/api/latest/languages?orderBy=languageDesc

    リクエストによって、言語オブジェクトのページ区切りリストがFULLモードで返されます。 Languageオブジェクトは、languageDescパラメータ値で昇順にソートされます。


問合せで検索

サポートされているメディア・タイプ: 'application/json', 'application/xml'


このメソッドは、指定された条件に一致するLanguageオブジェクトのリストを返します。

このリソースは、返される言語オブジェクトのリストをソートできるorderByリクエスト・パラメータをサポートしています。

orderByパラメータで使用する様々な値は、スキーマおよびリソースのカタログ情報で確認できます。 スキーマおよびカタログ情報を取得するには、HTTPリクエストでmediaType値を'application/schema+json'としてGETメソッドを使用します。

リソースのスキーマおよびカタログ情報を取得するURIの例を次に示します:

  • http://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/languages

URIの例

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

  • http://<IM_REST_API_HOST>/km/api/latest/languages/?q=languageDesc likeAny ('*English*')

    このリクエストは、言語記述にEnglishという語を含む言語オブジェクトのページ区切りリストを返します。 デフォルトでは、Languageオブジェクトは、オブジェクトが作成された日付の昇順でソートされます。

  • http://<IM_REST_API_HOST>/km/api/latest/languages?q=languageCode eq 'en'

    このリクエストは、英語に関連付けられている言語オブジェクトのページ区切りリストを返します。 デフォルトでは、Languageオブジェクトは、オブジェクトが作成された日付の昇順でソートされます。

  • http://<IM_REST_API_HOST>/km/api/latest/languages?q=locales.recordId in ('en_US','en_GB')&orderBy=languageCode

    このリクエストは、アメリカ英語および英国英語を表すロケール・オブジェクトに関連付けられている言語オブジェクトのページ区切りリストを返します。 Languageオブジェクトは、languageCodeパラメータ値で昇順にソートされます。

問合せパラメータ

次の表では、このリソースの問合せパラメータについて説明します。

パラメータ問合せ可能ソート可能タイプ説明
recordIdYY'type' : 'string'

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

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

言語オブジェクトが作成された日付。

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

言語オブジェクトが変更された日付。

languageCodeYY'type' : 'string'

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

languageDescYY'type' : 'string'

Languageオブジェクトが表す言語の説明。

ロケールYN'$ref' : '#/definitions/ListLocaleKey'

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

リクエスト

問合せパラメータ
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、返されるリソースに含める情報の量を定義 - KEYは情報の最小化(したがって、パフォーマンスが向上)されており、FULLはほとんどの情報を持つ情報です。
    許可された値: [ "KEY", "DATA", "EXTENDED", "FULL" ]
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • このパラメータは、指定された属性に基づいてリソース・コレクションを順序付けします。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと'asc'または'desc'が続きます。 昇順には'asc'を指定し、降順には'desc'を指定します。 デフォルト値は'asc'です。 たとえば、?orderBy=field1:asc,field2:descです。
  • このパラメータの値はOracle Knowledge Q問合せである必要があります - この操作の『スタート・ガイド』ドキュメント(「問合せ」ページ)およびQ問合せのドキュメントを参照してください。
トップに戻る

レスポンス

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

200 レスポンス

「OK」をクリックします。
本文( )
ルート・スキーマ : ResultList言語
タイプ: object
タイトル: ResultList Language
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
ソースを表示
ネストされたスキーマ : 言語
タイプ: object
タイトル: Language
ソースを表示
ネストされたスキーマ : ロケール
タイプ: array

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

ソースを表示
ネストされたスキーマ : LocaleKey
タイプ: object
タイトル: LocaleKey
ソースを表示
トップに戻る

例

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、Oracle Knowledgeリポジトリから言語オブジェクトのリストを検索する方法を示しています。

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

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

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

curl -X GET "https://<IM_REST_API_HOST>/km/api/latest/languages" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json"

レスポンス本文の例

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

{
    "items": [
        {
            "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": []
        }
    ],
    "hasMore": true,
    "limit": 1,
    "offset": 0,
    "links": [
        {
            "rel": "canonical",
            "href": "https://<IM_REST_API_HOST>/km/api/v1/languages/?limit=1&offset=0",
            "mediaType": "application/json, application/xml",
            "method": "GET"
        },
        {
            "rel": "next",
            "href": "https://<IM_REST_API_HOST>/km/api/v1/languages/?limit=1&offset=1",
            "mediaType": "application/json, application/xml",
            "method": "GET"
        }
    ],
    "count": 1
}
「トップに戻る」