機械翻訳について

移動先

• リクエスト
• レスポンス
• 例

ローカリゼーション・ポリシーの作成

post

/content/management/api/v1.1/localizationPolicies

指定されたペイロードでローカリゼーション・ポリシーを作成します。
作成されたローカリゼーション・ポリシーにより、次のことが保証されます

完全にリクエストされた言語を含むアイテムを配信する場合(公開されている場合)

定義済のデフォルト言語でアイテムを配信する(公開された場合)

アイテムを配信します(公開されている場合)。このアイテムは使用できない翻訳を指します。

また、確認

LocalizationPolicy.required値で指定されたすべての言語の翻訳を翻訳セットとともに公開する必要があること

LocalizationPolicy.optional値で指定された言語を使用した翻訳は、翻訳セットとともに公開できます。

リクエスト

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

• application/json

問合せパラメータ

• links(optional): string
  このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby

ヘッダー・パラメータ

• X-Requested-With: string
  CSRF攻撃を軽減するためのカスタム・ヘッダー。

  許容値: [ "XMLHttpRequest" ]

本文()

ペイロード内に指定の情報でローカリゼーション・ポリシーを作成します。 ペイロード内に指定されている場合でも、id, createdBy, createdDate, updatedBy, updatedDateおよびlinksフィールドは無視されます。

ルート・スキーマ : 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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the localization policy. It is a required property in the get response and put request whereas it is not required in the post request."
        },
        "name":{
            "type":"string",
            "description":"Name of the localization policy. It is a required property in the get response and post/put request."
        },
        "description":{
            "type":"string",
            "description":"Description of the localization policy."
        },
        "createdBy":{
            "type":"string",
            "description":"created by user of the localization policy."
        },
        "createdDate":{
            "description":"date and time Localization Policy createdAt",
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"updated by user of the Localization Policy"
        },
        "updatedDate":{
            "description":"date and time Localization Policy updatedAt",
            "$ref":"#/definitions/date"
        },
        "defaultValue":{
            "type":"string",
            "description":"Fall back language in case if item of the given language not available. Value should be one of the required languages."
        },
        "requiredValues":{
            "type":"array",
            "description":"Required language values.",
            "items":{
                "type":"string"
            }
        },
        "optionalValues":{
            "type":"array",
            "description":"Optional language values.",
            "items":{
                "type":"string"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the Localization Policy resource",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Localization Policy"
}

ネストされたスキーマ : date

型: object

date

ソースを表示

• timezone(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "timezone":{
            "type":"string"
        }
    },
    "description":"date"
}

ネストされたスキーマ: links

型: array

ローカリゼーション・ポリシーのリソースのリンク

ソースを表示

• Array of: object Link
  リソースのリンク。

{
    "type":"array",
    "description":"Links of the Localization Policy resource",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

ネストされたスキーマ : optionalValues

型: array

オプションの言語値です。

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"Optional language values.",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ : requiredValues

型: array

必須言語の値です。

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"Required language values.",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: Link

型: object

リソースのリンク。

ソースを表示

• href(optional): string
  ターゲット・リソースのURI それはテンプレートURIである可能性があります。 これはレスポンス取得の必須プロパティです。
• mediaType(optional): string
  メディア・タイプ。
• method(optional): string
  ターゲット・リソースへのアクセスに使用できるHTTPメソッド。
• profile(optional): string
  ターゲット・リソースを記述するメタデータにリンクします。
• rel(optional): string
  関連タイプ これはレスポンス取得の必須プロパティです。
• templated(optional): boolean
  URIがテンプレートであるかどうか。

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

トップに戻る

レスポンス

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

• application/json

201レスポンス

作成されました。

本文()

ルート・スキーマ : 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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the localization policy. It is a required property in the get response and put request whereas it is not required in the post request."
        },
        "name":{
            "type":"string",
            "description":"Name of the localization policy. It is a required property in the get response and post/put request."
        },
        "description":{
            "type":"string",
            "description":"Description of the localization policy."
        },
        "createdBy":{
            "type":"string",
            "description":"created by user of the localization policy."
        },
        "createdDate":{
            "description":"date and time Localization Policy createdAt",
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"updated by user of the Localization Policy"
        },
        "updatedDate":{
            "description":"date and time Localization Policy updatedAt",
            "$ref":"#/definitions/date"
        },
        "defaultValue":{
            "type":"string",
            "description":"Fall back language in case if item of the given language not available. Value should be one of the required languages."
        },
        "requiredValues":{
            "type":"array",
            "description":"Required language values.",
            "items":{
                "type":"string"
            }
        },
        "optionalValues":{
            "type":"array",
            "description":"Optional language values.",
            "items":{
                "type":"string"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the Localization Policy resource",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Localization Policy"
}

ネストされたスキーマ : date

型: object

date

ソースを表示

• timezone(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "timezone":{
            "type":"string"
        }
    },
    "description":"date"
}

ネストされたスキーマ: links

型: array

ローカリゼーション・ポリシーのリソースのリンク

ソースを表示

• Array of: object Link
  リソースのリンク。

{
    "type":"array",
    "description":"Links of the Localization Policy resource",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

ネストされたスキーマ : optionalValues

型: array

オプションの言語値です。

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"Optional language values.",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ : requiredValues

型: array

必須言語の値です。

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"Required language values.",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: Link

型: object

リソースのリンク。

ソースを表示

• href(optional): string
  ターゲット・リソースのURI それはテンプレートURIである可能性があります。 これはレスポンス取得の必須プロパティです。
• mediaType(optional): string
  メディア・タイプ。
• method(optional): string
  ターゲット・リソースへのアクセスに使用できるHTTPメソッド。
• profile(optional): string
  ターゲット・リソースを記述するメタデータにリンクします。
• rel(optional): string
  関連タイプ これはレスポンス取得の必須プロパティです。
• templated(optional): boolean
  URIがテンプレートであるかどうか。

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

400レスポンス

不正リクエスト

403レスポンス

禁止。

404レスポンス

見つかりません。

500レスポンス

内部サーバー・エラー

トップに戻る

例

次の例では、cURLを使用してRESTリソースにPOSTリクエストを発行することによってローカリゼーション・ポリシーを作成する方法を示します。

curl -X POST -H 'Content-Type: application/json' -H 'X-Requested-With: XMLHttpRequest' 'http://host:port/content/management/api/v1.1/policy'

例:

これにより、必須のリストと、en-IN、en-AUおよびen-USが言語コードのオプション言語のリストを含むローカリゼーション・ポリシーが作成されます。 ペイロードを独自のデータで置換します。

/content/management/api/v1.1/localizationPolicies

リクエスト本文

{
  "name": "policy4",
  "description": "policy4 description",
  "requiredValues": [
    "en-AU",
    "en-US"
  ],
  "optionalValues": [
    "en-IN",
    "en-US"
  ]
}

先頭に戻る