言語に割り当てられたすべてのロケールを取得
/km/api/v1/languages/{id}/locales
このメソッドは、指定されたIDパラメータを持つLanguageオブジェクトに関連付けられたLocaleオブジェクトのリストを返します。
Localeオブジェクトは、そのオブジェクトが表す言語と国によって識別されます。 たとえば、English United StatesとEnglish Great Britainは、英語のデフォルトである2つのロケールです。
このリソースは、返されるロケール・オブジェクトのリストをソートできるorderByリクエスト・パラメータをサポートしています。
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/languages/{id}/locales
このリクエストは、指定されたLanguageオブジェクトに関連付けられているFULLモードのLocaleオブジェクトのページ区切りリストを返します。 デフォルトでは、LocaleオブジェクトはlocaleCodeパラメータ値で昇順にソートされます。
http://<IM_REST_API_HOST>/km/api/latest/languages/{id}/locales?mode=KEY
このリクエストは、指定されたLanguageオブジェクトに関連付けられているKEYモードのLocaleオブジェクトのページ区切りリストを返します。 デフォルトでは、LocaleオブジェクトはlocaleCodeパラメータ値で昇順にソートされます。
http://<IM_REST_API_HOST>/km/api/latest/languages/{id}/locales?orderBy=localeDesc
このリクエストは、指定されたLanguageオブジェクトに関連付けられているFULLモードのLocaleオブジェクトのページ区切りリストを返します。 ロケール・オブジェクトは、localeDescパラメータ値で昇順にソートされます。
リクエスト
- id: string
言語オブジェクトの一意の識別子
レスポンス
- application/json
- application/xml
200 レスポンス
object
ResultList LocaleKey
- count(optional): integer
現在の範囲で返されたリソース・インスタンスの数。
- hasMore(optional): boolean
サーバーで使用可能なリソースが現在のページで返されたサブセットよりも多い場合にtrueに設定されるブール値。
- items(optional): array items
- limit(optional): integer
サーバーが使用する実際のページング・サイズ。
- links(optional): array links
- offset(optional): integer
現在のページで使用される相殺値。
- totalResults(optional): integer
現在の範囲内のインスタンスと、リクエストを満たすサーバー上のインスタンスの両方を含む、リソース・インスタンスの合計数。
array
- Array of: object instanceLink
JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。
object
LocaleKey
- links(optional): array links
- recordId(optional): string
ロケール・オブジェクトの一意の識別子。
array
- Array of: object instanceLink
JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。
object
- 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です。
例
次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、指定した言語オブジェクトのロケール・オブジェクトのリストを検索する方法を示しています。
curl -X "GET" "http://IM_REST_API_HOST/km/api/latest/languages/{id}/locales"
リクエスト・ヘッダーの例
次に、リクエスト・ヘッダーの例を示します。
curl -X GET "https://<IM_REST_API_HOST>/km/api/latest/languages/{id}/locales" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json"
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています:
{ "recordId": "ar_AE", "links": [ { "rel": "canonical", "href": "https://<IM_REST_API_HOST>/km/api/v1/locales/ar_AE", "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": "ar_AE", "localeDesc": "Arabic - United Arab Emirates", "localeValue": 14337, "timeFormat": "%I:%M %p", "timeFormatDisplay": "hh:mm", "language": { "recordId": "ar", "links": [ { "rel": "canonical", "href": "https://<IM_REST_API_HOST>/km/api/v1/languages/ar", "mediaType": "application/json, application/xml", "method": "GET" } ] } }