機械翻訳について

移動先

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

カテゴリ・プロパティ定義へのパッチ適用

patch

/content/management/api/v1.1/taxonomies/{id}/categoryProperties/{propertyId}

指定されたJSONマージ・パッチ・ドキュメント。

マージ・パッチ・ドキュメントには、次のルールが適用されます:

• カテゴリ・プロパティ定義にすでに指定されたオブジェクトまたはフィールドが含まれている場合、値は置換されます。
• マージ・パッチの値nullは、特定のオブジェクトまたはフィールドが削除されることを意味します。 必須フィールドは削除できません。
• 配列に個々の値を追加または削除することはできません。 パッチ・マージ・ドキュメントに指定された配列によって、カテゴリ・プロパティ定義の配列全体が置換されます。

リクエスト

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

• application/merge-patch+json
• application/json

パス・パラメータ

• id: string
  タクソノミのId。
• propertyId: string
  カテゴリ・プロパティ定義の一意の識別子(id)。

本文()

JSONマージ・パッチ・ドキュメント内の指定された情報を使用して、カテゴリ・プロパティ定義にパッチを適用します。

次の例は、フィールドごとに可能な最小限の更新を示しています。 次の例の任意の組合せは有効であり、必要なフィールドのみにパッチを適用するために使用する必要があります。 「キーワード」、「シノニム」、relatedCategoriesなどのシステム定義プロパティでは、settingsのisPublishableおよびvalueCountRangeのみを更新できます。

displayName	displayNameフィールドは必須であり、削除できません。 例: ```{ "displayName" : "これは更新された表示名です" }''' このペイロードは、カテゴリ・プロパティ定義のdisplayNameを置き換えます。 作成時に使用したものと同じ一意性ルールおよびサーバー書式が引き続き適用されます。
description	descriptionフィールドはオプションです。 追加、更新または削除できます。 例: ```{ "description" : "adding/updating description" }``` このペイロードは、カテゴリ・プロパティ定義のdescriptionを追加または更新します。 作成で使用される同じルールが引き続き適用されます。 例: ```{ "description" : null }``` このペイロードにより、カテゴリ・プロパティ定義のdescriptionが削除されます。
isPublishable	isPublishableフィールドは必須であり、削除できません。 例: ```{ "isPublishable" : true }``` このペイロードは、カテゴリ・プロパティ定義のisPublishableを置き換えます。 作成で使用される同じルールが引き続き適用されます。
valueCount	valueCountフィールドは必須であり、削除できません。 valueCountに許可される値は'single'および'list'です。 例: ```{ "valueCount" : "list" }``` このペイロードは、カテゴリ・プロパティ定義のvalueCountを置き換えます。 作成で使用される同じルールが引き続き適用されます。
defaultValues	defaultValues配列はオプションです。 追加、更新または削除できます。 例: ```{ "defaultValues" : ["デフォルト値1"、"デフォルト値2\ }''' このペイロードは、カテゴリ・プロパティ定義のdefaultValuesを追加または更新します。 作成で使用される同じルールが引き続き適用されます。 例: ```{ "defaultValues" : null }``` このペイロードにより、カテゴリ・プロパティ定義のdefaultValuesが削除されます。
settings.caas.valueCountRange	settings.caas.valueCountRangeフィールドはオプションです。 追加、更新または削除できます。 例: ``` { "settings" : {"caas" : { "valueCountRange" : {"min" : 1, "max" : 50} } } }``` このペイロードは、カテゴリ・プロパティ定義のsettings.caas.valueCountRangeを置き換えます。 作成で使用される同じルールが引き続き適用されます。 例: ``` { "settings" : {"caas" : { "valuecountRange" : null } } }``` このペイロードにより、カテゴリ・プロパティ定義のsettings.caas.valueCountRangeが削除されます。
settings.caas.valueCountRange.min	settings.caas.valueCountRange.minフィールドはオプションです。 追加、更新または削除できます。 例: ``` { "settings" : {"caas" : { "valueCountRange" : {"min" : 10} } } }``` このペイロードは、カテゴリ・プロパティ定義のsettings.caas.valueCountRange.minを置き換えます。 作成で使用される同じルールが引き続き適用されます。 例: ``` { "settings" : {"caas" : { "valueCountRange" : {"min" : null} } } }``` このペイロードにより、カテゴリ・プロパティ定義のsettings.caas.valueCountRange.minが削除されます。
settings.caas.valueCountRange.max	settings.caas.valueCountRange.maxフィールドはオプションです。 追加、更新または削除できます。 例: ``` { "settings" : {"caas" : { "valueCountRange" : {"max" : 100} } } }``` このペイロードは、カテゴリ・プロパティ定義のsettings.caas.valueCountRange.maxを置き換えます。 作成で使用される同じルールが引き続き適用されます。 例: ``` { "settings" : {"caas" : { "valueCountRange" : {"max" : null} } } }``` このペイロードにより、カテゴリ・プロパティ定義のsettings.caas.valueCountRange.maxが削除されます。
settings.caas.customValidators	settings.caas.customValidators配列はオプションです。 追加、更新または削除できます。 例: ``` { "settings" : {"caas" : { "customValidators" : [{ "type" : "length", "options" : {"validateOnEachValue":true, "ignoreEmpty":true, "min":10, "max":1000} }] } } }``` このペイロードは、カテゴリ・プロパティ定義のsettings.caas.customValidatorsを置き換えます。 作成で使用される同じルールが引き続き適用されます。 例: ``` { "settings" : {"caas" : { "customValidators" : null } } }``` このペイロードにより、カテゴリ・プロパティ定義のsettings.caas.customValidatorsが削除されます。
settings.caas.editor	settings.caas.editorフィールドは必須であり、削除できません。 例: ``` { "settings" : {"caas" : { "editor" : {"name" : "multi-selectbox", "options" : {"multiple":true} } } } }``` このペイロードは、カテゴリ・プロパティ定義のsettings.caas.editorを置き換えます。 作成で使用される同じルールが引き続き適用されます。
settings.caas.editor.name	settings.caas.editor.nameフィールドは必須であり、削除できません。 例: ``` { "settings" : {"caas" : { "editor" : {"name" : "multi-selectbox" } } } }``` このペイロードは、カテゴリ・プロパティ定義のsettings.caas.editor.nameを置き換えます。 作成で使用される同じルールが引き続き適用されます。
settings.caas.editor.options	settings.caas.editor.optionsフィールドはオプションです。 追加、更新または削除できます。 例: ``` { "settings" : {"caas" : { "editor" : { "options" : {"multiple":true} } } } }``` このペイロードは、カテゴリ・プロパティ定義のsettings.caas.editor.optionsを置き換えます。 作成で使用される同じルールが引き続き適用されます。 例: ``` { "settings" : {"caas" : { "editor" : { "options" : null } } } }``` このペイロードにより、カテゴリ・プロパティ定義のsettings.caas.editor.optionsが削除されます。

ルート・スキーマ: schema

型: object

使用可能なその他のプロパティ

ソースを表示

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

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

型: object

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

204レスポンス

OK。

400レスポンス

不正リクエスト

403レスポンス

禁止。

404レスポンス

リクエストされたリソースは見つかりませんでした。

409レスポンス

リクエストされたリソース操作は一時的に使用できません

500レスポンス

内部サーバー・エラー

先頭に戻る