機械翻訳について

移動先

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

タクソノミの作成

post

/content/management/api/v1.1/taxonomies

指定されたペイロード。 フィールドshortNameは一意である必要があり、値が指定されていない場合はシステムによって自動生成されます。 「シノニム」、「キーワード」、relatedCategoriesなどのシステム管理カテゴリ・プロパティは、作成時にデフォルトでタクソノミに割り当てられます。

リクエスト

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

• application/json

問合せパラメータ

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

ヘッダー・パラメータ

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

  許容値: [ "XMLHttpRequest" ]

本文()

ペイロード内に指定の情報を持つタクソノミを作成します。 フィールドid、createdBy、createdDate、updatedBy、updatedDate、status、version、availableStates、publishedChannels、categoryPropertiesおよび「リンク」は、ペイロードで指定されている場合でも無視されます。

ルート・スキーマ : タクソノミ

型: object

タクソノミ

ソースを表示

• availableStates(optional): array availableStates
  タクソノミのすべての状態をリストします。 これはオプション・プロパティであり、フィールド・パラメータでリクエストされている場合にのみ返されます。 post/putリクエストでは無視されます。
• categoryProperties(optional): object ItemSubResourceListCategoryPropertyDefinition
  アイテムSubResource。
• createdBy(optional): string
  タクソノミを作成したユーザー。
• createdDate(optional): object date
  date
• customProperties(optional): object customProperties
  許可される追加のプロパティ: additionalProperties

  タクソノミのカスタム・プロパティです。 これは、ユーザーが定義する名前と値のペアで構成されます。 単一のエントリを更新することはできません。カスタム・プロパティのリスト全体を更新するには指定する必要があります。
• description(optional): string
  タクソノミの説明。
• id: string
  タクソノミのid。 これはレスポンス取得時に必須プロパティであり、ポスト/putリクエストでは無視されます。
• isForSiteManagement(optional): boolean
  タクソノミがサイト管理用かどうか。 サイト管理タクソノミは公開できません。(デフォルトはfalseです)
• isPublishable(optional): boolean
  タクソノミが公開可能かどうか。(デフォルトはfalseです)
• links(optional): array links
  リンク
• name: string
  タクソノミの名前。 これはレスポンス取得の必須プロパティであり、投稿/書込みリクエストで空にはできません。
• publishedChannels(optional): array publishedChannels
  読取り専用: true

  タクソノミ公開チャネル。
• roleName(optional): string
  リソース上のロールの名前。
• shortName(optional): string
  タクソノミの短縮名。 このプロパティはすべてのタクソノミ間で一意であり、getレスポンスで必要です。 put/postリクエストでは、3文字まで入力できます。 値を指定しないと、デフォルトの値が生成されます。
• status(optional): string
  許容値: [ "draft", "promoted" ]

  タクソノミのステータス。 これはレスポンス取得時に必須プロパティであり、ポスト/putリクエストでは無視されます。
• updatedBy(optional): string
  タクソノミを最後に更新したユーザー。
• updatedDate(optional): object date
  date
• version(optional): integer(int32)
  最小値: 1

  このタクソノミのバージョン。 バージョン情報は、プロモートされたタクソノミについてのみ返されます。 post/putリクエストでは無視されます。

{
    "type":"object",
    "required":[
        "id",
        "name"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the Taxonomy. This is a required property in the get response and ignored in post/put requests."
        },
        "name":{
            "type":"string",
            "description":"The name of the Taxonomy. It is a required property in the get response and cannot be empty in post/put request."
        },
        "description":{
            "type":"string",
            "description":"The description of the Taxonomy."
        },
        "shortName":{
            "type":"string",
            "description":"The short name of the Taxonomy. This property is unique among all taxonomies and it is required in the get response. Up to 3 characters can be provided in a put/post request. If no value is provided, a default one will be generated."
        },
        "status":{
            "type":"string",
            "description":"The status of the Taxonomy. This is a required property in the get response and ignored in post/put requests.",
            "enum":[
                "draft",
                "promoted"
            ]
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "description":"The version of this Taxonomy. Version information is only returned for promoted taxonomies. It is ignored in post/put requests.",
            "minimum":1
        },
        "isPublishable":{
            "type":"boolean",
            "description":"Whether taxonomy is publishable. (defaults to false)"
        },
        "isForSiteManagement":{
            "type":"boolean",
            "description":"Whether taxonomy is for site management. A site management taxonomy is not publishable. (defaults to false)"
        },
        "availableStates":{
            "type":"array",
            "description":"List all states of the Taxonomy. This is an optional property and is only returned if requested in the fields parameter. It is ignored in post/put requests.",
            "items":{
                "$ref":"#/definitions/TaxonomyStatus"
            }
        },
        "customProperties":{
            "type":"object",
            "description":"Custom properties of the Taxonomy. This consists of a name value pairs defined by the user.  Single entries cannot be updated, the entire list of custom properties have to be provided to update entries.",
            "additionalProperties":{
                "type":"string"
            }
        },
        "publishedChannels":{
            "type":"array",
            "description":"Taxonomy published channels.",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/ChannelInTaxonomy"
            }
        },
        "createdBy":{
            "type":"string",
            "description":"The user who created the Taxonomy."
        },
        "createdDate":{
            "description":"The creation date of the Taxonomy.",
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"The user who last updated the Taxonomy."
        },
        "updatedDate":{
            "description":"The date the Taxonomy was last updated.",
            "$ref":"#/definitions/date"
        },
        "categoryProperties":{
            "description":"The definition of category properties for this taxonomy. There are user defined properties and system defined properties such as synonyms, keywords and related categories. These properties are defined as a sub-resource of a single taxonomy and they cannot be expanded through read taxonomy API. They will be ignored by the server in POST and PUT requests. The sub-resource API contains additional information about parameters and available operations.",
            "$ref":"#/definitions/ItemSubResourceListCategoryPropertyDefinition"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "roleName":{
            "type":"string",
            "description":"name of the role on the resource."
        }
    },
    "description":"Taxonomy"
}

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

型: array

タクソノミのすべての状態をリストします。 これはオプション・プロパティであり、フィールド・パラメータでリクエストされている場合にのみ返されます。 post/putリクエストでは無視されます。

ソースを表示

• Array of: object TaxonomyStatus
  TaxonomyStatus

{
    "type":"array",
    "description":"List all states of the Taxonomy. This is an optional property and is only returned if requested in the fields parameter. It is ignored in post/put requests.",
    "items":{
        "$ref":"#/definitions/TaxonomyStatus"
    }
}

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

型: object

アイテムSubResource。

ソースを表示

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CategoryPropertyDefinition"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

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

型: object

date

ソースを表示

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

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

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

型: object

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

ソースを表示

• string

{
    "type":"object",
    "description":"Custom properties of the Taxonomy. This consists of a name value pairs defined by the user.  Single entries cannot be updated, the entire list of custom properties have to be provided to update entries.",
    "additionalProperties":{
        "type":"string"
    }
}

タクソノミのカスタム・プロパティです。 これは、ユーザーが定義する名前と値のペアで構成されます。 単一のエントリを更新することはできません。カスタム・プロパティのリスト全体を更新するには指定する必要があります。

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

型: array

リンク

ソースを表示

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

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

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

型: array

読取り専用: true

タクソノミ公開チャネル。

ソースを表示

• Array of: object ChannelInTaxonomy
  ChannelInTaxonomy

{
    "type":"array",
    "description":"Taxonomy published channels.",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/ChannelInTaxonomy"
    }
}

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

型: object

TaxonomyStatus

ソースを表示

• jobs(optional): array jobs
• published(optional): boolean
• status(optional): string
• version(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        },
        "published":{
            "type":"boolean"
        },
        "jobs":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TaxonomyJobInfo"
            }
        }
    },
    "description":"TaxonomyStatus"
}

ネストされたスキーマ : ジョブ

型: array

ソースを表示

• Array of: object TaxonomyJobInfo
  TaxonomyJobInfo

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TaxonomyJobInfo"
    }
}

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

型: object

TaxonomyJobInfo

ソースを表示

• errorDetails(optional): string
• id(optional): string
• status(optional): string
• type(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "errorDetails":{
            "type":"string"
        }
    },
    "description":"TaxonomyJobInfo"
}

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

型: array

ソースを表示

• Array of: object CategoryPropertyDefinition
  カテゴリ・プロパティ定義

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CategoryPropertyDefinition"
    }
}

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

型: array

ソースを表示

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

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

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

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

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

型: object

ChannelInTaxonomy

ソースを表示

• id(optional): string
  チャネルのId。
• name(optional): string
  チャネルの名前。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the channel."
        },
        "name":{
            "type":"string",
            "description":"Name of the channel."
        }
    },
    "description":"ChannelInTaxonomy"
}

トップに戻る

レスポンス

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

• application/json

201レスポンス

作成されました。

本文()

ルート・スキーマ : タクソノミ

型: object

タクソノミ

ソースを表示

• availableStates(optional): array availableStates
  タクソノミのすべての状態をリストします。 これはオプション・プロパティであり、フィールド・パラメータでリクエストされている場合にのみ返されます。 post/putリクエストでは無視されます。
• categoryProperties(optional): object ItemSubResourceListCategoryPropertyDefinition
  アイテムSubResource。
• createdBy(optional): string
  タクソノミを作成したユーザー。
• createdDate(optional): object date
  date
• customProperties(optional): object customProperties
  許可される追加のプロパティ: additionalProperties

  タクソノミのカスタム・プロパティです。 これは、ユーザーが定義する名前と値のペアで構成されます。 単一のエントリを更新することはできません。カスタム・プロパティのリスト全体を更新するには指定する必要があります。
• description(optional): string
  タクソノミの説明。
• id: string
  タクソノミのid。 これはレスポンス取得時に必須プロパティであり、ポスト/putリクエストでは無視されます。
• isForSiteManagement(optional): boolean
  タクソノミがサイト管理用かどうか。 サイト管理タクソノミは公開できません。(デフォルトはfalseです)
• isPublishable(optional): boolean
  タクソノミが公開可能かどうか。(デフォルトはfalseです)
• links(optional): array links
  リンク
• name: string
  タクソノミの名前。 これはレスポンス取得の必須プロパティであり、投稿/書込みリクエストで空にはできません。
• publishedChannels(optional): array publishedChannels
  読取り専用: true

  タクソノミ公開チャネル。
• roleName(optional): string
  リソース上のロールの名前。
• shortName(optional): string
  タクソノミの短縮名。 このプロパティはすべてのタクソノミ間で一意であり、getレスポンスで必要です。 put/postリクエストでは、3文字まで入力できます。 値を指定しないと、デフォルトの値が生成されます。
• status(optional): string
  許容値: [ "draft", "promoted" ]

  タクソノミのステータス。 これはレスポンス取得時に必須プロパティであり、ポスト/putリクエストでは無視されます。
• updatedBy(optional): string
  タクソノミを最後に更新したユーザー。
• updatedDate(optional): object date
  date
• version(optional): integer(int32)
  最小値: 1

  このタクソノミのバージョン。 バージョン情報は、プロモートされたタクソノミについてのみ返されます。 post/putリクエストでは無視されます。

{
    "type":"object",
    "required":[
        "id",
        "name"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the Taxonomy. This is a required property in the get response and ignored in post/put requests."
        },
        "name":{
            "type":"string",
            "description":"The name of the Taxonomy. It is a required property in the get response and cannot be empty in post/put request."
        },
        "description":{
            "type":"string",
            "description":"The description of the Taxonomy."
        },
        "shortName":{
            "type":"string",
            "description":"The short name of the Taxonomy. This property is unique among all taxonomies and it is required in the get response. Up to 3 characters can be provided in a put/post request. If no value is provided, a default one will be generated."
        },
        "status":{
            "type":"string",
            "description":"The status of the Taxonomy. This is a required property in the get response and ignored in post/put requests.",
            "enum":[
                "draft",
                "promoted"
            ]
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "description":"The version of this Taxonomy. Version information is only returned for promoted taxonomies. It is ignored in post/put requests.",
            "minimum":1
        },
        "isPublishable":{
            "type":"boolean",
            "description":"Whether taxonomy is publishable. (defaults to false)"
        },
        "isForSiteManagement":{
            "type":"boolean",
            "description":"Whether taxonomy is for site management. A site management taxonomy is not publishable. (defaults to false)"
        },
        "availableStates":{
            "type":"array",
            "description":"List all states of the Taxonomy. This is an optional property and is only returned if requested in the fields parameter. It is ignored in post/put requests.",
            "items":{
                "$ref":"#/definitions/TaxonomyStatus"
            }
        },
        "customProperties":{
            "type":"object",
            "description":"Custom properties of the Taxonomy. This consists of a name value pairs defined by the user.  Single entries cannot be updated, the entire list of custom properties have to be provided to update entries.",
            "additionalProperties":{
                "type":"string"
            }
        },
        "publishedChannels":{
            "type":"array",
            "description":"Taxonomy published channels.",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/ChannelInTaxonomy"
            }
        },
        "createdBy":{
            "type":"string",
            "description":"The user who created the Taxonomy."
        },
        "createdDate":{
            "description":"The creation date of the Taxonomy.",
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"The user who last updated the Taxonomy."
        },
        "updatedDate":{
            "description":"The date the Taxonomy was last updated.",
            "$ref":"#/definitions/date"
        },
        "categoryProperties":{
            "description":"The definition of category properties for this taxonomy. There are user defined properties and system defined properties such as synonyms, keywords and related categories. These properties are defined as a sub-resource of a single taxonomy and they cannot be expanded through read taxonomy API. They will be ignored by the server in POST and PUT requests. The sub-resource API contains additional information about parameters and available operations.",
            "$ref":"#/definitions/ItemSubResourceListCategoryPropertyDefinition"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "roleName":{
            "type":"string",
            "description":"name of the role on the resource."
        }
    },
    "description":"Taxonomy"
}

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

型: array

タクソノミのすべての状態をリストします。 これはオプション・プロパティであり、フィールド・パラメータでリクエストされている場合にのみ返されます。 post/putリクエストでは無視されます。

ソースを表示

• Array of: object TaxonomyStatus
  TaxonomyStatus

{
    "type":"array",
    "description":"List all states of the Taxonomy. This is an optional property and is only returned if requested in the fields parameter. It is ignored in post/put requests.",
    "items":{
        "$ref":"#/definitions/TaxonomyStatus"
    }
}

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

型: object

アイテムSubResource。

ソースを表示

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CategoryPropertyDefinition"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

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

型: object

date

ソースを表示

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

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

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

型: object

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

ソースを表示

• string

{
    "type":"object",
    "description":"Custom properties of the Taxonomy. This consists of a name value pairs defined by the user.  Single entries cannot be updated, the entire list of custom properties have to be provided to update entries.",
    "additionalProperties":{
        "type":"string"
    }
}

タクソノミのカスタム・プロパティです。 これは、ユーザーが定義する名前と値のペアで構成されます。 単一のエントリを更新することはできません。カスタム・プロパティのリスト全体を更新するには指定する必要があります。

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

型: array

リンク

ソースを表示

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

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

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

型: array

読取り専用: true

タクソノミ公開チャネル。

ソースを表示

• Array of: object ChannelInTaxonomy
  ChannelInTaxonomy

{
    "type":"array",
    "description":"Taxonomy published channels.",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/ChannelInTaxonomy"
    }
}

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

型: object

TaxonomyStatus

ソースを表示

• jobs(optional): array jobs
• published(optional): boolean
• status(optional): string
• version(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        },
        "published":{
            "type":"boolean"
        },
        "jobs":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TaxonomyJobInfo"
            }
        }
    },
    "description":"TaxonomyStatus"
}

ネストされたスキーマ : ジョブ

型: array

ソースを表示

• Array of: object TaxonomyJobInfo
  TaxonomyJobInfo

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TaxonomyJobInfo"
    }
}

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

型: object

TaxonomyJobInfo

ソースを表示

• errorDetails(optional): string
• id(optional): string
• status(optional): string
• type(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "errorDetails":{
            "type":"string"
        }
    },
    "description":"TaxonomyJobInfo"
}

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

型: array

ソースを表示

• Array of: object CategoryPropertyDefinition
  カテゴリ・プロパティ定義

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CategoryPropertyDefinition"
    }
}

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

型: array

ソースを表示

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

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

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

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

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

型: object

ChannelInTaxonomy

ソースを表示

• id(optional): string
  チャネルのId。
• name(optional): string
  チャネルの名前。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the channel."
        },
        "name":{
            "type":"string",
            "description":"Name of the channel."
        }
    },
    "description":"ChannelInTaxonomy"
}

400レスポンス

不正リクエスト

403レスポンス

禁止。

500レスポンス

内部サーバー・エラー

トップに戻る

例

次の例では、cURLを使用してRESTリソースにPOSTリクエストを発行することで、タクソノミを作成する方法を示します:

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

例1:

この例では、指定した名前のタクソノミを作成する方法を示します。

ノート:

shortNameは、スペースを除く最初の3文字から生成されます。

/content/management/api/v1.1/taxonomies

リクエスト本文

{
  "name": "New Taxonomy"
}

例2:

この例では、指定した名前および生成された短縮名税を持つタクソノミを作成する方法を示します。

/content/management/api/v1.1/taxonomies

リクエスト本文

{
  "name": "New Taxonomy",
  "shortName": "TAX"
}

例3 :

この例では、指定された名前およびカスタム・プロパティを持つタクソノミを作成する方法を示します。

/content/management/api/v1.1/taxonomies

リクエスト本文

{
   "name": "New Taxonomy",
   "customProperties": {
         "property 1": "value 1"
        }
}

例4 :

この例では、指定した名前、短縮名および2つのカスタム・プロパティを持つタクソノミを作成する方法を示します。

/content/management/api/v1.1/taxonomies

リクエスト本文

{
   "name": "New Taxonomy",
   "shortName": "SRT"
   "customProperties": {
          "property 1": "value 1",
          "property 2": "value 2"
          }
}

先頭に戻る