機械翻訳について

移動先

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

カテゴリ・プロパティの作成

post

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

指定されたペイロード。

リクエスト

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

• application/json

パス・パラメータ

• id: string
  タクソノミのId。

問合せパラメータ

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

ヘッダー・パラメータ

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

  許容値: [ "XMLHttpRequest" ]

本文()

ペイロード内の指定された情報を使用してカテゴリ・プロパティを作成します。 フィールドid、apiName、isSystemManaged、createdBy、createdDate、updatedBy、updatedDateおよび「リンク」は、ペイロードで指定されている場合でも無視されます。

フィールドapiNameおよびdisplayNameは、タクソノミ内で一意であり、大/小文字が区別されません。つまり、同じタクソノミで既存のapiNameまたはdisplayNameを使用してプロパティを作成することはできません(異なるケースでも)。

フィールドdisplayNameでは、先頭および末尾のすべての空白文字が削除されます。 例:

• displayName = " model year "
• 結果displayName = "model year"

apiNameは、displayNameの値に基づいて生成されます。 displayName内の英数字以外の文字はすべて削除されます。 結果の値が空の文字列の場合、タイムスタンプ('yyyyMMddHHmmssSSS'の書式)が使用されます。 結果の値が数字で始まる場合は、プレフィクスとして'property'が付きます。

例:

• displayName = " model_year "
• 結果apiName = "modelYear"

例:

• displayName = "2022 models"
• 結果apiName = "property2022Models"

例:

• displayName = "??????"
• 結果apiName = "property20230101103022589"

フィールドisPublishableは、カテゴリ・プロパティが公開可能かどうかを示します。

フィールドvalueCountは値singleまたはlistを受け入れ、その他の値は許可されません。 valueCountの値がsingleの場合、カテゴリごとに許可されるプロパティ値は1つのみです。 valueCountの値がlistの場合、カテゴリごとに複数のプロパティ値が許可され、値の制限はsettings.caas.valueCountRangeフィールドで指定されます。

フィールドdefaultValuesはカンマ区切りの値リストを受け入れ、カテゴリの作成時にカテゴリ・プロパティに値が指定されていない場合、これらの値はデフォルトで適用されます。 valueCountの値がsingleの場合、デフォルト値は1つのみ許可されます。 valueCountの値がlistの場合、複数のデフォルト値が許可され、デフォルト値の制限はsettings.caas.valueCountRangeフィールドで指定されます。

フィールドsettings.caas.valueCountRangeは、カテゴリ・プロパティに許可される値の下限と上限を定義します。フィールドsettings.caas.valueCountRange.minは下限、フィールドsettings.caas.valueCountRange.maxは上限です。

フィールドsettings.caas.editorは、カテゴリ・プロパティに値を割り当てるために使用されるエディタを示します。 フィールドsettings.caas.editor.nameは、次のいずれかの値をサポートしています:

• テキスト・ボックス
• 単一選択メニュー
• 複数選択メニュー

単一選択または複数選択メニューの場合、フィールドsettings.caas.editor.optionsでメニュー・オプションを定義できます

フィールドsettings.caas.customValidatorsは、カテゴリ・プロパティの値に適用される検証のリストです。フィールドsettings.caas.customValidators.typeは検証のタイプを示し、フィールドsettings.caas.customValidators.optionsは検証を適用する特定のルールを示します。

ルート・スキーマ : CategoryPropertyDefinition

型: object

カテゴリ・プロパティ定義

ソースを表示

• apiName(optional): string
  読取り専用: true

  最小長: 1

  最大長: 64

  プロパティのAPI名。
• createdBy(optional): string
  読取り専用: true

  プロパティを作成したユーザー。
• createdDate(optional): object date
  date
• defaultValues(optional): array defaultValues
  プロパティのデフォルト値。
• description(optional): string
  最小長: 0

  最大長: 128

  プロパティの説明。
• displayName: string
  最小長: 1

  最大長: 128

  プロパティの表示名
• id(optional): string
  読取り専用: true

  プロパティのID。 これはGETレスポンスおよびPATCHリクエストで必要ですが、POSTリクエストでは無視されます。
• isPublishable(optional): boolean
  プロパティは公開可能です。
• isSystemManaged(optional): boolean
  読取り専用: true

  システムによって管理されるプロパティです。
• links(optional): array links
  リンク
• settings: object PropertySettingsBean
• updatedBy(optional): string
  読取り専用: true

  プロパティを最後に更新したユーザー。
• updatedDate(optional): object date
  date
• valueCount: string
  許容値: [ "single", "list" ]

  値は単一またはリストとしてカウントされます。

{
    "type":"object",
    "required":[
        "displayName",
        "settings",
        "valueCount"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the property. It is required in the GET response and PATCH request whereas it will be ignored in the POST request.",
            "readOnly":true
        },
        "apiName":{
            "type":"string",
            "description":"API Name of the property.",
            "readOnly":true,
            "minLength":1,
            "maxLength":64
        },
        "displayName":{
            "type":"string",
            "description":"Display name of the property.",
            "minLength":1,
            "maxLength":128
        },
        "description":{
            "type":"string",
            "description":"Description of the property.",
            "minLength":0,
            "maxLength":128
        },
        "isSystemManaged":{
            "type":"boolean",
            "description":"Is the property managed by the system.",
            "readOnly":true
        },
        "isPublishable":{
            "type":"boolean",
            "description":"Is the property publishable."
        },
        "valueCount":{
            "type":"string",
            "description":"Value count as a single or list.",
            "enum":[
                "single",
                "list"
            ]
        },
        "defaultValues":{
            "type":"array",
            "description":"Default values for the property.",
            "items":{
                "type":"string"
            }
        },
        "settings":{
            "description":"Settings for the property.",
            "$ref":"#/definitions/PropertySettingsBean"
        },
        "createdBy":{
            "type":"string",
            "description":"The user who created the property.",
            "readOnly":true
        },
        "createdDate":{
            "description":"The creation date of the property.",
            "readOnly":true,
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"The user who last updated the property.",
            "readOnly":true
        },
        "updatedDate":{
            "description":"The last updated date of the property.",
            "readOnly":true,
            "$ref":"#/definitions/date"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Category Property Definition"
}

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

型: object

date

ソースを表示

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

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

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

型: array

プロパティのデフォルト値。

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"Default values for the property.",
    "items":{
        "type":"string"
    }
}

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

型: array

リンク

ソースを表示

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

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: object

ソースを表示

• caas(optional): object PropertySettingsCaasBean

{
    "type":"object",
    "properties":{
        "caas":{
            "description":"settings of the property. It is required in the GET response and PUT request whereas it is not required in the POST request.",
            "$ref":"#/definitions/PropertySettingsCaasBean"
        }
    }
}

ネストされたスキーマ: 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."
}

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

型: object

ソースを表示

• customValidators(optional): array customValidators
  プロパティ値のカスタム・バリデータ。
• editor(optional): object PropertySettingsEditorBean
• valueCountRange(optional): object PropertySettingsValueCountRangeBean

{
    "type":"object",
    "properties":{
        "valueCountRange":{
            "description":"Value count range of the property.",
            "$ref":"#/definitions/PropertySettingsValueCountRangeBean"
        },
        "customValidators":{
            "type":"array",
            "description":"Custom validators for the property value.",
            "items":{
                "$ref":"#/definitions/PropertySettingsValidatorBean"
            }
        },
        "editor":{
            "description":"Editor for the property value.",
            "$ref":"#/definitions/PropertySettingsEditorBean"
        }
    }
}

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

型: array

プロパティ値のカスタム・バリデータ。

ソースを表示

• Array of: object PropertySettingsValidatorBean

{
    "type":"array",
    "description":"Custom validators for the property value.",
    "items":{
        "$ref":"#/definitions/PropertySettingsValidatorBean"
    }
}

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

型: object

ソースを表示

• name(optional): string
  エディタの名前。
• options(optional): object options
  許可される追加のプロパティ: additionalProperties

  プロパティ値のオプション。

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the editor."
        },
        "options":{
            "type":"object",
            "description":"Options of the property value.",
            "additionalProperties":{
                "type":"object"
            }
        }
    }
}

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

型: object

ソースを表示

• max(optional): integer(int32)
  最小値: 1

  プロパティ値の最大数。
• min(optional): integer(int32)
  最小値: 0

  プロパティ値の最小数。

{
    "type":"object",
    "properties":{
        "min":{
            "type":"integer",
            "format":"int32",
            "description":"Minimum count of the property value.",
            "minimum":0
        },
        "max":{
            "type":"integer",
            "format":"int32",
            "description":"Maximum count of the property value.",
            "minimum":1
        }
    }
}

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

型: object

ソースを表示

• options(optional): object options
  許可される追加のプロパティ: additionalProperties

  バリデータ詳細。
• type(optional): string
  許容値: [ "length" ]

  バリデータのタイプ。

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Type of the validator.",
            "enum":[
                "length"
            ]
        },
        "options":{
            "type":"object",
            "description":"Validator details.",
            "additionalProperties":{
                "type":"object"
            }
        }
    }
}

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

型: object

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

ソースを表示

• object additionalProperties

{
    "type":"object",
    "description":"Validator details.",
    "additionalProperties":{
        "type":"object"
    }
}

バリデータ詳細。

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

型: object

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

型: object

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

ソースを表示

• object additionalProperties

{
    "type":"object",
    "description":"Options of the property value.",
    "additionalProperties":{
        "type":"object"
    }
}

プロパティ値のオプション。

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

型: object

トップに戻る

レスポンス

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

• application/json

201レスポンス

作成されました。

本文()

ルート・スキーマ : CategoryPropertyDefinition

型: object

カテゴリ・プロパティ定義

ソースを表示

• apiName(optional): string
  読取り専用: true

  最小長: 1

  最大長: 64

  プロパティのAPI名。
• createdBy(optional): string
  読取り専用: true

  プロパティを作成したユーザー。
• createdDate(optional): object date
  date
• defaultValues(optional): array defaultValues
  プロパティのデフォルト値。
• description(optional): string
  最小長: 0

  最大長: 128

  プロパティの説明。
• displayName: string
  最小長: 1

  最大長: 128

  プロパティの表示名
• id(optional): string
  読取り専用: true

  プロパティのID。 これはGETレスポンスおよびPATCHリクエストで必要ですが、POSTリクエストでは無視されます。
• isPublishable(optional): boolean
  プロパティは公開可能です。
• isSystemManaged(optional): boolean
  読取り専用: true

  システムによって管理されるプロパティです。
• links(optional): array links
  リンク
• settings: object PropertySettingsBean
• updatedBy(optional): string
  読取り専用: true

  プロパティを最後に更新したユーザー。
• updatedDate(optional): object date
  date
• valueCount: string
  許容値: [ "single", "list" ]

  値は単一またはリストとしてカウントされます。

{
    "type":"object",
    "required":[
        "displayName",
        "settings",
        "valueCount"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the property. It is required in the GET response and PATCH request whereas it will be ignored in the POST request.",
            "readOnly":true
        },
        "apiName":{
            "type":"string",
            "description":"API Name of the property.",
            "readOnly":true,
            "minLength":1,
            "maxLength":64
        },
        "displayName":{
            "type":"string",
            "description":"Display name of the property.",
            "minLength":1,
            "maxLength":128
        },
        "description":{
            "type":"string",
            "description":"Description of the property.",
            "minLength":0,
            "maxLength":128
        },
        "isSystemManaged":{
            "type":"boolean",
            "description":"Is the property managed by the system.",
            "readOnly":true
        },
        "isPublishable":{
            "type":"boolean",
            "description":"Is the property publishable."
        },
        "valueCount":{
            "type":"string",
            "description":"Value count as a single or list.",
            "enum":[
                "single",
                "list"
            ]
        },
        "defaultValues":{
            "type":"array",
            "description":"Default values for the property.",
            "items":{
                "type":"string"
            }
        },
        "settings":{
            "description":"Settings for the property.",
            "$ref":"#/definitions/PropertySettingsBean"
        },
        "createdBy":{
            "type":"string",
            "description":"The user who created the property.",
            "readOnly":true
        },
        "createdDate":{
            "description":"The creation date of the property.",
            "readOnly":true,
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"The user who last updated the property.",
            "readOnly":true
        },
        "updatedDate":{
            "description":"The last updated date of the property.",
            "readOnly":true,
            "$ref":"#/definitions/date"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Category Property Definition"
}

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

型: object

date

ソースを表示

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

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

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

型: array

プロパティのデフォルト値。

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"Default values for the property.",
    "items":{
        "type":"string"
    }
}

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

型: array

リンク

ソースを表示

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

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: object

ソースを表示

• caas(optional): object PropertySettingsCaasBean

{
    "type":"object",
    "properties":{
        "caas":{
            "description":"settings of the property. It is required in the GET response and PUT request whereas it is not required in the POST request.",
            "$ref":"#/definitions/PropertySettingsCaasBean"
        }
    }
}

ネストされたスキーマ: 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."
}

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

型: object

ソースを表示

• customValidators(optional): array customValidators
  プロパティ値のカスタム・バリデータ。
• editor(optional): object PropertySettingsEditorBean
• valueCountRange(optional): object PropertySettingsValueCountRangeBean

{
    "type":"object",
    "properties":{
        "valueCountRange":{
            "description":"Value count range of the property.",
            "$ref":"#/definitions/PropertySettingsValueCountRangeBean"
        },
        "customValidators":{
            "type":"array",
            "description":"Custom validators for the property value.",
            "items":{
                "$ref":"#/definitions/PropertySettingsValidatorBean"
            }
        },
        "editor":{
            "description":"Editor for the property value.",
            "$ref":"#/definitions/PropertySettingsEditorBean"
        }
    }
}

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

型: array

プロパティ値のカスタム・バリデータ。

ソースを表示

• Array of: object PropertySettingsValidatorBean

{
    "type":"array",
    "description":"Custom validators for the property value.",
    "items":{
        "$ref":"#/definitions/PropertySettingsValidatorBean"
    }
}

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

型: object

ソースを表示

• name(optional): string
  エディタの名前。
• options(optional): object options
  許可される追加のプロパティ: additionalProperties

  プロパティ値のオプション。

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the editor."
        },
        "options":{
            "type":"object",
            "description":"Options of the property value.",
            "additionalProperties":{
                "type":"object"
            }
        }
    }
}

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

型: object

ソースを表示

• max(optional): integer(int32)
  最小値: 1

  プロパティ値の最大数。
• min(optional): integer(int32)
  最小値: 0

  プロパティ値の最小数。

{
    "type":"object",
    "properties":{
        "min":{
            "type":"integer",
            "format":"int32",
            "description":"Minimum count of the property value.",
            "minimum":0
        },
        "max":{
            "type":"integer",
            "format":"int32",
            "description":"Maximum count of the property value.",
            "minimum":1
        }
    }
}

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

型: object

ソースを表示

• options(optional): object options
  許可される追加のプロパティ: additionalProperties

  バリデータ詳細。
• type(optional): string
  許容値: [ "length" ]

  バリデータのタイプ。

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Type of the validator.",
            "enum":[
                "length"
            ]
        },
        "options":{
            "type":"object",
            "description":"Validator details.",
            "additionalProperties":{
                "type":"object"
            }
        }
    }
}

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

型: object

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

ソースを表示

• object additionalProperties

{
    "type":"object",
    "description":"Validator details.",
    "additionalProperties":{
        "type":"object"
    }
}

バリデータ詳細。

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

型: object

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

型: object

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

ソースを表示

• object additionalProperties

{
    "type":"object",
    "description":"Options of the property value.",
    "additionalProperties":{
        "type":"object"
    }
}

プロパティ値のオプション。

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

型: object

400レスポンス

不正リクエスト

403レスポンス

禁止。

404レスポンス

タクソノミが見つかりません。 リクエストしたリソースが見つかりません。

409レスポンス

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

500レスポンス

内部サーバー・エラー

先頭に戻る