すべてのローカリゼーション・ポリシーのリスト
get
/content/management/api/v1.1/localizationPolicies
すべてのローカリゼーション・ポリシーをリストします。
リクエスト
問合せパラメータ
- limit(optional): integer(int32)
このパラメータは、負でない整数を受け入れ、結果のサイズの制御に使用します。デフォルト値:
100 - links(optional): string
このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby, first, 最後, prev, next
- offset(optional): integer(int32)
このパラメータは、負でない整数を受け入れ、結果の開始インデックスを制御するために使用します。デフォルト値:
0 - orderBy(optional): string
このパラメータは、結果の順序を制御するために使用します。 この問合せパラメータの値は、fieldName:[asc/desc]の形式に従います。「昇順」は、昇順を表します「説明」は降順を表し、デフォルトの順序は「昇順」です。 フィールド名に使用できるフィールドは、nameとupdatedDateのみです。デフォルト値:
name:asc - q(optional): string
このパラメータは、フィールド値に一致する問合せ式条件を受け入れます。 問合せ条件の値は、{fieldName} {operator} "{fieldValue}"の形式に従います。 現在で使用できるfieldNamesはnameとconnectorTypeのみで、現在使用できる演算子は、connectorTypeのnameとeqではmtのみです。 この問合せパラメータは、デフォルトではオプションです。
例:
?q=(name mt "foo")
例:
?q=(connectorType eq "translation")
例:
?q=(connectorType eq "content") - totalResults(optional): boolean
このパラメータは、ブール・フラグを受け入れます。 trueとして指定した場合、返される結果には合計結果数が含まれる必要があります。デフォルト値:
false
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
OK。
ルート・スキーマ : LocalizationPolicies
型:
objectLocalizationPolicies
ソースを表示
- aggregationResults(optional): array aggregationResults
集計結果。
- count(optional): integer(int32)
現在のレスポンス内のレコードの合計数
- hasMore(optional): boolean
フェッチするページがまだあるかどうかを確認します。
- items(optional): array items
コレクションに含まれる特異なリソース。
- limit(optional): integer(int32)
サーバーによって使用される実際のページ・サイズ。 これは、クライアントがリクエストするものと同じではない可能性があります。
- links(optional): array links
リソースのリンク。
- offset(optional): integer(int32)
特異リソースが返される実際のインデックス。
- pinned(optional): array pinned
固定品目。 検索リストの上部に固定されたアイテムを表示
- scrollId(optional): string
scrollId:検索がスクロール検索に解決された場合。
- totalResults(optional): integer(int32)
クライアント・リクエストを満たすローの総数(ページング・パラメータを除く)
ネストされたスキーマ: items
型:
arrayコレクションに含まれる特異なリソース。
ソースを表示
- Array of: object LocalizationPolicy
ローカリゼーション・ポリシー
ネストされたスキーマ : LocalizationPolicy
型:
objectローカリゼーション・ポリシー
ソースを表示
- createdBy(optional): string
ローカリゼーション・ポリシーのユーザーによって作成されました。
- createdDate(optional): object date
date
- defaultValue(optional): string
指定した言語のアイテムが使用できない場合は、戻り言語になります。 値は必須言語の1つである必要があります。
- description(optional): string
ローカリゼーション・ポリシーの説明。
- id(optional): string
ローカリゼーション・ポリシーのId。 これはレスポンス取得と送信リクエストの必須プロパティであり、リクエストの転送には必要ありません。
- links(optional): array links
ローカリゼーション・ポリシーのリソースのリンク
- name(optional): string
ローカリゼーション・ポリシーの名前。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。
- optionalValues(optional): array optionalValues
オプションの言語値です。
- requiredValues(optional): array requiredValues
必須言語の値です。
- updatedBy(optional): string
ローカリゼーション・ポリシーのユーザーによる更新
- updatedDate(optional): object date
date
ネストされたスキーマ: Link
型:
objectリソースのリンク。
ソースを表示
- href(optional): string
ターゲット・リソースのURI それはテンプレートURIである可能性があります。 これはレスポンス取得の必須プロパティです。
- mediaType(optional): string
メディア・タイプ。
- method(optional): string
ターゲット・リソースへのアクセスに使用できるHTTPメソッド。
- profile(optional): string
ターゲット・リソースを記述するメタデータにリンクします。
- rel(optional): string
関連タイプ これはレスポンス取得の必須プロパティです。
- templated(optional): boolean
URIがテンプレートであるかどうか。
304 レスポンス
変更されていません。
400レスポンス
不正リクエスト
403レスポンス
禁止。
500レスポンス
内部サーバー・エラー
例
次の例では、cURLを使用してRESTリソースにGETリクエストを送信することによってローカリゼーション・ポリシー詳細を取得する方法を示します:
curl -i -X GET -H 'Accept:application/json' 'http://host:port/content/management/api/v1.1/localizationPolicies'
例1:
このとき、レスポンスにtotalResults値を含むすべてのローカリゼーション・ポリシーがリストされます。
/content/management/api/v1.1/localizationPolicies?totalResults=true
レスポンス本文
{
"hasMore": false,
"offset": 0,
"count": 2,
"limit": 2,
"totalResults": 2,
"items": [
{
"id": "7CCD8228C1DF6488E0534DB0F70ABB84",
"name": "policy1",
"description": "",
"createdBy": "marketing.user",
"createdDate": {
"value": "2018-12-10T12:49:35.740Z",
"timezone": "UTC"
},
"updatedBy": "marketing.user",
"updatedDate": {
"value": "2018-12-10T12:49:35.740Z",
"timezone": "UTC"
},
"defaultValue": null,
"requiredValues": [
"en_US"
],
"optionalValues": [
"ar-DZ",
"ar-EG"
],
"links": [
{
"href": "https://host:port/content/management/api/v1.1/localizationPolicies/7CCD8228C1DF6488E0534DB0F70ABB84",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
{
"id": "7CAB65ADA5886541E0534DB0F70AE4A1",
"name": "policy2",
"description": "",
"createdBy": "marketing.user",
"createdDate": {
"value": "2018-12-12T05:31:22.440Z",
"timezone": "UTC"
},
"updatedBy": "marketing.user",
"updatedDate": {
"value": "2018-12-12T05:31:22.440Z",
"timezone": "UTC"
},
"defaultValue": null,
"requiredValues": [
"en-IN"
],
"optionalValues": [
"en",
"fr"
],
"links": [
{
"href": "https://host:port/content/management/api/v1.1/localizationPolicies/7CAB65ADA5886541E0534DB0F70AE4A1",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
}
],
"links": [
{
"href": "https://host:port/content/management/api/v1.1/localizationPolicies?totalResults=true",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "https://host:port/content/management/api/v1.1/localizationPolicies?totalResults=true",
"rel": "canonical",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "https://host:port/content/management/api/v1.1/metadata-catalog/localizationPolicies",
"rel": "describedby",
"method": "GET",
"mediaType": "application/schema+json"
},
{
"href": "https://host:port/content/management/api/v1.1/localizationPolicies?offset=0&totalResults=true",
"rel": "first",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "https://host:port/content/management/api/v1.1/localizationPolicies?offset=0&totalResults=true",
"rel": "last",
"method": "GET",
"mediaType": "application/json"
}
]
}
例2:
ここには、インデックス1から始まる最初の2ローカリゼーション・ポリシーがリストされ、totalResults値およびフィールド名がレスポンス内で降順に含まれます。
/content/management/api/v1.1/localizationPolicies?limit=2&offset=1&totalResults=true&orderBy=name:desc
レスポンス本文
{
"hasMore": false,
"offset": 1,
"count": 2,
"limit": 3,
"totalResults": 3,
"items": [
{
"id": "7CAB65ADA5886541E0534DB0F70AE4A1",
"name": "policy2",
"description": "",
"createdBy": "marketing.user",
"createdDate": {
"value": "2018-12-10T12:49:35.740Z",
"timezone": "UTC"
},
"updatedBy": "marketing.user",
"updatedDate": {
"value": "2018-12-12T07:17:12.839Z",
"timezone": "UTC"
},
"defaultValue": null,
"requiredValues": [
"en_US"
],
"optionalValues": [
"ar-DZ",
"ar-EG"
],
"links": [
{
"href": "https://host:port/content/management/api/v1.1/localizationPolicies/7CAB65ADA5886541E0534DB0F70AE4A1",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
{
"id": "7CCD8228C1DF6488E0534DB0F70ABB84",
"name": "policy1",
"description": "",
"createdBy": "marketing.user",
"createdDate": {
"value": "2018-12-12T05:31:22.440Z",
"timezone": "UTC"
},
"updatedBy": "marketing.user",
"updatedDate": {
"value": "2018-12-12T05:31:22.440Z",
"timezone": "UTC"
},
"defaultValue": null,
"requiredValues": [
"en-IN"
],
"optionalValues": [
"en",
"fr"
],
"links": [
{
"href": "https://host:port/content/management/api/v1.1/localizationPolicies/7CCD8228C1DF6488E0534DB0F70ABB84",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
}
],
"links": [
{
"href": "https://host:port/content/management/api/v1.1/localizationPolicies?limit=2&orderBy=name:desc&totalResults=true&offset=1",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "https://host:port/content/management/api/v1.1/localizationPolicies?limit=2&orderBy=name:desc&totalResults=true&offset=1",
"rel": "canonical",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "https://host:port/content/management/api/v1.1/metadata-catalog/localizationPolicies",
"rel": "describedby",
"method": "GET",
"mediaType": "application/schema+json"
},
{
"href": "https://host:port/content/management/api/v1.1/localizationPolicies?limit=2&orderBy=name:desc&totalResults=true&offset=0",
"rel": "prev",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "https://host:port/content/management/api/v1.1/localizationPolicies?limit=2&orderBy=name:desc&totalResults=true&offset=0",
"rel": "first",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "https://host:port/content/management/api/v1.1/localizationPolicies?limit=2&orderBy=name:desc&totalResults=true&offset=1",
"rel": "last",
"method": "GET",
"mediaType": "application/json"
}
]
}