割り当てられたすべてのオーサリング・ロケールを取得
get
/km/api/v1/users/{id}/contentLocales
このメソッドは、指定されたIDパラメータを持つUserオブジェクトに関連付けられた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/users/{id}/contentLocales
このメソッドは、指定されたIDパラメータを持つユーザー・オブジェクトに関連付けられているLocaleオブジェクトのリストを、ロケール・コードで昇順にソートして返します。
http://<IM_REST_API_HOST>/km/api/latest/users/{id}/contentLocales?orderBy=localeCode:desc
このメソッドは、指定されたIDパラメータを持つユーザー・オブジェクトに関連付けられているLocaleオブジェクトのリストを、ロケール・コードで降順にソートして返します。
リクエスト
パス・パラメータ
- id: string
ユーザー・オブジェクトの一意の識別子
レスポンス
サポートされるメディア・タイプ
- application/json
- application/xml
200 レスポンス
「OK」をクリックします。
ルート・スキーマ : ResultList LocaleKey
タイプ:
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。
ネストされたスキーマ : LocaleKey
タイプ:
object
タイトル:
ソースを表示
LocaleKey
- links(optional): array links
- recordId(optional): string
ロケール・オブジェクトの一意の識別子。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
array
- Array of: object instanceLink
JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。
ネストされたスキーマ : 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です。
例
次の例は、指定されたIDパラメータを持つUserオブジェクトに関連付けられたLocaleオブジェクトのリストを取得する方法を示しています:
curl -X GET "https://<IM_REST_API_HOST>/km/api/latest/users/{id}/contentLocales" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json"
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています:
{ "items": [ { "recordId": "en_GB", "links": [ { "rel": "canonical", "href": "https://<IM_REST_API_HOST>/km/api/latest/locales/en_GB", "mediaType": "application/json, application/xml", "method": "GET" }, { "rel": "collection", "href": "https://<IM_REST_API_HOST>/km/api/latest/locales", "mediaType": "application/json, application/xml", "method": "GET", "profile": "https://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/locales" } ] }, { "recordId": "en_US", "links": [ { "rel": "canonical", "href": "https://<IM_REST_API_HOST>/km/api/latest/locales/en_US", "mediaType": "application/json, application/xml", "method": "GET" }, { "rel": "collection", "href": "https://<IM_REST_API_HOST>/km/api/latest/locales", "mediaType": "application/json, application/xml", "method": "GET", "profile": "https://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/locales" } ] } ], "hasMore": false, "limit": 20, "offset": 0, "links": [ { "rel": "canonical", "href": "https://<IM_REST_API_HOST>/km/api/latest/users/2/contentLocales?limit=20&offset=0&_=1543231343448", "mediaType": "application/json, application/xml", "method": "GET" } ], "count": 2 }