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

すべてのロケールを取得

get

/km/api/v1/locales

このメソッドは、Oracle Knowledgeリポジトリからロケール・オブジェクトのリストを返します。

このリソースは、orderByリクエスト・パラメータをサポートしています。 このパラメータをHTTPサービス・リクエストとともに使用して、返されたリストをソートします。

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

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

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

URIの例

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

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

    このリクエストは、FULLモードのLocaleオブジェクトのページ区切りリストを返します。 デフォルトでは、LocaleオブジェクトはlocaleCode値に従って昇順にソートされます。

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

    このリクエストは、KEYモードのLocaleオブジェクトのページ区切りリストを返します。 デフォルトでは、LocaleオブジェクトはlocaleCode値に従って昇順にソートされます。

  • http://<IM_REST_API_HOST>/km/api/latest/locales?orderBy=localeDesc

    このリクエストは、FULLモードのLocaleオブジェクトのページ区切りリストを返します。 ロケール・オブジェクトは、localeDescパラメータ値に従って昇順にソートされます。

  • http://<IM_REST_API_HOST>/km/api/latest/locales?orderBy=dateAdded

    このリクエストは、FULLモードのLocaleオブジェクトのページ区切りリストを返します。 リスト内のオブジェクトは、Localeオブジェクトが作成された日付に従ってソートされます。


問合せで検索

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


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

このリソースは、orderByリクエスト・パラメータをサポートしています。 このパラメータをHTTPサービス・リクエストとともに使用して、返されたリストをソートします。

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

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

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

URIの例

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

  • http://<IM_REST_API_HOST>/km/api/latest/locales?q=groupDefault eq true

    このリクエストは、Localeオブジェクトのグループ間でデフォルトとして選択されたLocaleオブジェクトのページ区切りリストを返します。 デフォルトでは、LocaleオブジェクトはlocaleCodeで昇順にソートされます。

  • http://<IM_REST_API_HOST>/km/api/latest/locales?q=language.languageCode eq 'en'&orderBy=localeCode

    このリクエストは、英語に関連付けられているロケール・オブジェクトのページ区切りリストを返します。 デフォルトでは、LocaleオブジェクトはlocaleCodeパラメータ値に従って昇順にソートされます。

  • http://<IM_REST_API_HOST>/km/api/latest/locales?q=active eq true&orderBy=localeDesc

    このリクエストは、Oracle Knowledgeシステムでアクティブなロケール・オブジェクトのページ区切りリストを返します。 ロケール・オブジェクトは、localeDescパラメータ値に従って昇順にソートされます。

問合せパラメータ

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

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

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

アクティブYY'type' : 'boolean'

このフラグは、LocaleオブジェクトがOracle Knowledgeシステムでアクティブかどうかを示します。

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

Localeオブジェクトが追加または作成された日付。

dateFormatYY'type' : 'string'

ロケール・オブジェクトに関連付けられているエンド・ユーザーに日付を表示するための規定の書式。 規定された書式クラスは、com.webobjects.foundation.NSTimestampFormatterです。

dateFormatDisplayYY'type' : 'string'

表示されたコンテンツに日付が表示される規定の書式。 規定された書式クラスは、java.text.DateFormatです。

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

ロケール・オブジェクトが最後に変更された日付。

エンコーディングYY'type' : 'string'

言語での文字の表示に使用される規定エンコーディング形式。

groupDefaultYY'type' : 'boolean'

このフラグは、指定されたLocaleオブジェクトがグループのデフォルト・オブジェクトであるかどうかを示します。 ロケール・オブジェクトは、それらが表す言語に従ってグループ化されます。

localeCodeYY'type' : 'string'

Localeオブジェクトに関連付けられている言語および国を表す一意のコード。

localeDescYY'type' : 'string'

Localeオブジェクトが表す言語と国に関する説明。

localeValueYY'type' : 'integer'

Localeオブジェクトが表す言語と国のロケールIDの値。

timeFormatYY'type' : 'string'

Localeオブジェクトに関連付けられているエンド・ユーザーに時間を表示するための規定の書式。 規定された書式クラスは、com.webobjects.foundation.NSTimestampFormatterです。

timeFormatDisplayYY'type' : 'string'

表示されたコンテンツに時間が表示される規定の書式。 規定された書式クラスは、java.text.DateFormatです。

languageYN'$ref' : '#/definitions/LanguageKey'

Localeオブジェクトが関連付けられているLanguageオブジェクト。 言語はlanguageKeyBO型で、通常はrecordIdサブフィールドを使用してアドレス指定されます。 例: language.recordId eq 'en'

リクエスト

問合せパラメータ
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、返されるリソースに含める情報の量を定義 - 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 Locale
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
ソースを表示
ネストされたスキーマ : 言語
タイプ: object
タイトル: Locale
ソースを表示
ネストされたスキーマ : LanguageKey
タイプ: object
タイトル: LanguageKey
ソースを表示
トップに戻る

例

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

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

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

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

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

レスポンス本文の例

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

{
    "items": [
        {
            "recordId": "sk_SK",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<IM_REST_API_HOST>/km/api/v1/locales/sk_SK",
                    "mediaType": "application/json, application/xml",
                    "method": "GET"
                },
                {
                    "rel": "collection",
                    "href": "https://<IM_REST_API_HOST>/km/api/v1/locales",
                    "mediaType": "application/json, application/xml",
                    "method": "GET",
                    "profile": "https://<IM_REST_API_HOST>/km/api/v1/metadata-catalog/locales"
                }
            ],
            "active": true,
            "dateAdded": "1970-01-01T23:11:11+0000",
            "dateFormat": "%d/%m/%Y",
            "dateFormatDisplay": "dd/mm/yyyy",
            "dateModified": "1970-01-01T23:11:11+0000",
            "encoding": "UTF-8",
            "groupDefault": true,
            "localeCode": "sk_SK",
            "localeDesc": "Slovak - Slovakia",
            "localeValue": 1051,
            "timeFormat": "%H:%M",
            "timeFormatDisplay": "HH:mm",
            "language": {
                "recordId": "sk",
                "links": [
                    {
                        "rel": "canonical",
                        "href": "https://<IM_REST_API_HOST>/km/api/v1/languages/sk",
                        "mediaType": "application/json, application/xml",
                        "method": "GET"
                    }
                ]
            }
        }
    ],
    "hasMore": true,
    "limit": 1,
    "offset": 0,
    "links": [
        {
            "rel": "canonical",
            "href": "https://<IM_REST_API_HOST>/km/api/v1/locales?limit=1&offset=0",
            "mediaType": "application/json, application/xml",
            "method": "GET"
        },
        {
            "rel": "next",
            "href": "https://<IM_REST_API_HOST>/km/api/v1/locales?limit=1&offset=1",
            "mediaType": "application/json, application/xml",
            "method": "GET"
        }
    ],
    "count": 1
}
「トップに戻る」