機械翻訳について

移動先

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

リスト・タクソノミ

get

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

このリソースは、問合せ式に指定されているタクソノミ・ステータスでフィルタ処理できる使用可能なタクソノミのリストを返します。 フェッチ、ページ付け、並べ替えるアイテムの数を制御することができます。 制限を参照するには、問合せ構文の説明を参照してください。

リクエスト

問合せパラメータ

• fields(optional): string
  このパラメータは、タクソノミについて返されるフィールドを制御するために使用されます。 このパラメータは、フィールド名または「すべて」のカンマ区切りリストを受け入れます。 これらのフィールドは、リスト内の各タクソノミに対して返されます。 すべてのフィールド名で大文字と小文字が区別されるため、問合せには正しいフィールド名を指定する必要があります。 各タクソノミには、標準フィールド(id、name、description、shortName、status、version、isPublishable、isForSiteManagement、customProperties、createdBy、createdDate、updatedBy、updatedDate)と、追加フィールド(availableStates、publishedChannels、categoryPropertiesおよびroleName)の両方があります。 fieldsを「すべて」 (大/小文字を区別しない)として指定すると、すべての標準フィールドおよび追加フィールドが返されます。 標準フィールドは常にレスポンスで返され、除外することはできません。 ドラフト状態のタクソノミにはversionがありません。 ユーザーがフィルタ処理できるのは、追加フィールドのみです。 ユーザーはタクソノミの読取り中にcategoryPropertiesサブリソースを拡張できませんが、サブリソースAPIへのリンクが返されます。 このパラメータは問合せではオプションで、デフォルトではレスポンスの標準フィールドのみが表示されます。 問合せで指定したフィールド名が正しくないか無効であると、エラーが発生します。
  
  この場合、すべての標準フィールドが、各タクソノミの追加フィールドavailableStatesとともに戻されます。
  例: ?fields=availableStates
  
  このメソッドは、すべての標準フィールドを、各タクソノミの追加フィールドavailableStatesおよびpublishedChannelsとともに返します。
  例: ?fields=availableStates,publishedChannels
  
  これにより、すべての標準フィールドとすべての追加フィールド(availableStatesおよびpublishedChannels)および各タクソノミのサブリソースcategoryPropertiesへのリンクが返されます。
  例: ?fields=all
  
• limit(optional): integer(int32)
  このパラメータは、負でない整数を受け入れ、結果のサイズの制御に使用します。

  デフォルト値: 100
• links(optional): string
  このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby, first, 最後, prev, next
• offset(optional): integer(int32)
  このパラメータは、負でない整数を受け入れ、結果の開始インデックスを制御するために使用します。

  デフォルト値: 0
• orderBy(optional): string
  結果順。

  デフォルト値: name:asc
• q(optional): string
  このパラメータは、フィールド値に一致する問合せ式条件を受け入れます。 問合せ条件は、AND演算子を使用して結合し、カッコでグループ化できます。 問合せ条件の値は、{fieldName} {operator} "{fieldValue}"の形式に従います。 許可されるフィールド名は、status、version、name、shortName、roleNameおよびrepositoryIdのみです。 1つの問合せに複数のstatus、version、name、shortName、roleNameまたはrepositoryId fieldNamesを含めることはできません。 名前とshortNameの両方を同じ問合せで指定することはできません。
  statusに値が指定されていない場合、デフォルトの「プロモート」になります。 タクソノミをリストする場合、statusは「ドラフト」、「プロモート済」または「すべて」になります。 タクソノミをリストする場合、roleNameは"viewer"、"editor"または"manager"と等しくできます。 statusがすべてと等しい場合、すべてのタクソノミが取得されます - 現在、タクソノミが下書きとプロモートされた状態の両方で使用可能な場合、ドラフトのみが返されます。 statusが他のエンドポイントで"all"と等しい場合は、エラーが返されます。
  演算子で使用できる値は、status、version、shortName、roleName およびrepositoryId。
  演算子で使用できる値は、nameのco (Contains)のみです。
  
  タクソノミを更新する場合、デフォルトのステータスが「プロモート済」で、更新されたタクソノミを変更できないため、問合せパラメータは常に「ドラフト」に設定された状態で提供する必要があります。
  
  例:
  https://{cecsdomain}/content/management/api/v1.1/taxonomies?q=(status eq "draft")
  例:
  https://{cecsdomain}/content/management/api/v1.1/taxonomies?q=(status eq "promoted")のeq (等号)のみです
• totalResults(optional): boolean
  このパラメータは、ブール・フラグを受け入れます。 trueとして指定した場合、返される結果には合計結果数が含まれる必要があります。

  デフォルト値: false

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

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

型: object

タクソノミ

ソースを表示

• 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)
  クライアント・リクエストを満たすローの総数(ページング・パラメータを除く)

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Check whether there are more pages to fetch."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"The actual index from which the singular resources are returned."
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of records in the current response."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Actual page size used by the server. This might not be the same as what the client requests."
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of rows that satisfy the client request (excluding the paging parameters.)"
        },
        "scrollId":{
            "type":"string",
            "description":"scrollId if the search resolved to a scroll search."
        },
        "items":{
            "type":"array",
            "description":"Singular resources contained in the collection.",
            "items":{
                "$ref":"#/definitions/TaxonomyInCollection"
            }
        },
        "aggregationResults":{
            "type":"array",
            "description":"Aggregation results.",
            "items":{
                "$ref":"#/definitions/AggregationResult"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "pinned":{
            "type":"array",
            "description":"Pinned items. Shows items pinned at the top of search list",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Taxonomies"
}

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

型: array

集計結果。

ソースを表示

• Array of: object AggregationResult

{
    "type":"array",
    "description":"Aggregation results.",
    "items":{
        "$ref":"#/definitions/AggregationResult"
    }
}

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

型: array

コレクションに含まれる特異なリソース。

ソースを表示

• Array of: object TaxonomyInCollection
  コレクション・レスポンスのタクソノミ

{
    "type":"array",
    "description":"Singular resources contained in the collection.",
    "items":{
        "$ref":"#/definitions/TaxonomyInCollection"
    }
}

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

型: array

リソースのリンク。

ソースを表示

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

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

ネストされたスキーマ : 殺害

型: array

固定品目。 検索リストの上部に固定されたアイテムを表示

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"Pinned items. Shows items pinned at the top of search list",
    "items":{
        "type":"string"
    }
}

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

型: object

ソースを表示

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

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "readOnly":true
        }
    }
}

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

型: 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
  タクソノミの名前。 これはレスポンス取得の必須プロパティであり、投稿/書込みリクエストで空にはできません。
• 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)"
        },
        "roleName":{
            "type":"string",
            "description":"name of the role on the resource."
        },
        "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"
            }
        },
        "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"
            }
        }
    },
    "description":"Taxonomy in Collection Response"
}

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

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

400レスポンス

不正リクエスト

403レスポンス

禁止。

500レスポンス

内部サーバー・エラー

トップに戻る

例

次の例では、cURLを使用してGETリクエストを送信することによってプロモートされたドラフトのタクソノミをフェッチする方法を示します。

curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/taxonomies'

例1:

これは、プロモートされた(デフォルト)タクソノミのリストを返します。

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

レスポンス本文

{
  "hasMore": false,
  "offset": 0,
  "count": 4,
  "limit": 100,
  "items": [
    {
      "id": "5D5AF080B7824C49950443A7D51DE950",
      "name": "Taxonomy 1",
      "description": "",
      "shortName": "T1",
      "status": "promoted",
      "version": 4,
      "isPublishable": false,
      "isForSiteManagement": false,
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-01-31T19:52:45.472Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:49:43.854Z",
        "timezone": "UTC"
      },
      "links": [
        {
          "href": "https://<hostname>/content/management/api/v1.1/taxonomies/5D5AF080B7824C49950443A7D51DE950",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    },
    {
      "id": "22ED0446197F49B490619206DEC71482",
      "name": "Taxonomy 2",
      "description": "Some description",
      "shortName": "T2",
      "status": "promoted",
      "version": 5,
      "isPublishable": false,
      "isForSiteManagement": false,
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-02-01T17:48:25.082Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:49:52.936Z",
        "timezone": "UTC"
      },
      "links": [
        {
          "href": "https://<hostname>/content/management/api/v1.1/taxonomies/22ED0446197F49B490619206DEC71482",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    },
    {
      "id": "D7969D6CA0D144AEA9CCA88BA6D2CF81",
      "name": "Taxonomy 3",
      "description": "Another description",
      "shortName": "T3",
      "status": "promoted",
      "version": 6,
      "isPublishable": false,
      "isForSiteManagement": false,
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-02-01T17:49:08.832Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:50:00.951Z",
        "timezone": "UTC"
      },
      "links": [
        {
          "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    },
    {
      "id": "FB8240D6DC70407F87ED111325D06F89",
      "name": "Organization1",
      "description": "organization one taxonomy",
      "shortName": "ORG",
      "status": "promoted",
      "version": 1,
      "isPublishable": false,
      "isForSiteManagement": true,
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2022-12-14T07:15:17.269Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2022-12-14T07:22:38.724Z",
        "timezone": "UTC"
      },
      "links": [
        {
          "href": "https://<hostname>/content/management/api/v1.1/taxonomies/FB8240D6DC70407F87ED111325D06F89",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/taxonomies",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?offset=0",
      "rel": "first",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?offset=0",
      "rel": "last",
      "method": "GET",
      "mediaType": "application/json"
    }
  ]
}

例2:

これは、ドラフト・タクソノミのリストを返します。

/content/management/api/v1.1/taxonomies?q=(status eq \"draft\")

レスポンス本文

{
  "hasMore": false,
  "offset": 0,
  "count": 3,
  "limit": 100,
  "items": [
    {
      "id": "5D5AF080B7824C49950443A7D51DE950",
      "name": "Taxonomy 1",
      "description": "",
      "shortName": "T1",
      "status": "draft",
      "isPublishable": false,
      "isForSiteManagement": false,
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-02-01T17:50:09.286Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:50:09.286Z",
        "timezone": "UTC"
      },
      "links": [
        {
          "href": "https://<hoastname>/content/management/api/v1.1/taxonomies/5D5AF080B7824C49950443A7D51DE950?q=(status eq \"draft\")",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    },
    {
      "id": "22ED0446197F49B490619206DEC71482",
      "name": "Taxonomy 2",
      "description": "Some description",
      "shortName": "T2",
      "status": "draft",
      "isPublishable": false,
      "isForSiteManagement": false,
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-02-01T17:50:17.648Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:50:17.648Z",
        "timezone": "UTC"
      },
      "links": [
        {
          "href": "https://<hoastname>/content/management/api/v1.1/taxonomies/22ED0446197F49B490619206DEC71482?q=(status eq \"draft\")",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    },
    {
      "id": "D7969D6CA0D144AEA9CCA88BA6D2CF81",
      "name": "Taxonomy 3",
      "description": "Another description",
      "shortName": "T3",
      "status": "draft",
      "isPublishable": false,
      "isForSiteManagement": false,
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-02-01T17:50:26.936Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:50:26.936Z",
        "timezone": "UTC"
      },
      "links": [
        {
          "href": "https://<hoastname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81?q=(status eq \"draft\")",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "https://<hoastname>/content/management/api/v1.1/taxonomies?q=(status eq \"draft\")",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hoastname>/content/management/api/v1.1/taxonomies?q=(status eq \"draft\")",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hoastname>/content/management/api/v1.1/metadata-catalog/taxonomies",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    },
    {
      "href": "https://<hoastname>/content/management/api/v1.1/taxonomies?offset=0&q=(status eq \"draft\")",
      "rel": "first",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hoastname>/content/management/api/v1.1/taxonomies?offset=0&q=(status eq \"draft\")",
      "rel": "last",
      "method": "GET",
      "mediaType": "application/json"
    }
  ]
}

例3 :

これは、offset=1からプロモートされたタクソノミのリストを返します。

/content/management/api/v1.1/taxonomies?offset=1

レスポンス本文

{
  "hasMore": false,
  "offset": 1,
  "count": 2,
  "limit": 100,
  "items": [
    {
      "id": "22ED0446197F49B490619206DEC71482",
      "name": "Taxonomy 2",
      "description": "Some description",
      "shortName": "T2",
      "status": "promoted",
      "version": 5,
      "isPublishable": false,
      "isForSiteManagement": false,
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-02-01T17:48:25.082Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:49:52.936Z",
        "timezone": "UTC"
      },
      "links": [
        {
          "href": "https://<hoastname>/content/management/api/v1.1/taxonomies/22ED0446197F49B490619206DEC71482?offset=1",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    },
    {
      "id": "D7969D6CA0D144AEA9CCA88BA6D2CF81",
      "name": "Taxonomy 3",
      "description": "Another description",
      "shortName": "T3",
      "status": "promoted",
      "version": 6,
      "isPublishable": false,
      "isForSiteManagement": false,
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-02-01T17:49:08.832Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:50:00.951Z",
        "timezone": "UTC"
      },
      "links": [
        {
          "href": "https://<hoastname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81?offset=1",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "https://<hoastname>/content/management/api/v1.1/taxonomies?offset=1",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hoastname>/content/management/api/v1.1/taxonomies?offset=1",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hoastname>/content/management/api/v1.1/metadata-catalog/taxonomies",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    },
    {
      "href": "https://<hoastname>/content/management/api/v1.1/taxonomies?offset=0",
      "rel": "prev",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hoastname>/content/management/api/v1.1/taxonomies?offset=0",
      "rel": "first",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hoastname>/content/management/api/v1.1/taxonomies?offset=1",
      "rel": "last",
      "method": "GET",
      "mediaType": "application/json"
    }
  ]
}

例4 :

これは、ページごとにoffset=1および1アイテムから昇格されたタクソノミのリストを返します。

/content/management/api/v1.1/taxonomies?offset=1&limit=1

レスポンス本文

{
  "hasMore": true,
  "offset": 1,
  "count": 1,
  "limit": 1,
  "items": [
    {
      "id": "22ED0446197F49B490619206DEC71482",
      "name": "Taxonomy 2",
      "description": "Some description",
      "shortName": "T2",
      "status": "promoted",
      "version": 5,
      "isPublishable": false,
      "isForSiteManagement": false,
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-02-01T17:48:25.082Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:49:52.936Z",
        "timezone": "UTC"
      },
      "links": [
        {
          "href": "https://<hoastname>/content/management/api/v1.1/taxonomies/22ED0446197F49B490619206DEC71482?offset=1&limit=1",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "https://<hoastname>/content/management/api/v1.1/taxonomies?offset=1&limit=1",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hoastname>/content/management/api/v1.1/taxonomies?offset=1&limit=1",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hoastname>/content/management/api/v1.1/metadata-catalog/taxonomies",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    },
    {
      "href": "https://<hoastname>/content/management/api/v1.1/taxonomies?offset=0&limit=1",
      "rel": "prev",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hoastname>/content/management/api/v1.1/taxonomies?offset=2&limit=1",
      "rel": "next",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hoastname>/content/management/api/v1.1/taxonomies?offset=0&limit=1",
      "rel": "first",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hoastname>/content/management/api/v1.1/taxonomies?offset=2&limit=1",
      "rel": "last",
      "method": "GET",
      "mediaType": "application/json"
    }
  ]
}

例5 :

これにより、すべての昇格されたタクソノミとオプション・フィールド'availableStates'がリストされます。

/content/management/api/v1.1/taxonomies?fields=availableStates

レスポンス本文

{
  "hasMore": false,
  "offset": 0,
  "count": 3,
  "limit": 100,
  "items": [
    {
      "id": "5D5AF080B7824C49950443A7D51DE950",
      "name": "Taxonomy 1",
      "description": "",
      "shortName": "T1",
      "status": "promoted",
      "version": 4,
      "isPublishable": false,
      "isForSiteManagement": false,
      "availableStates": [
        {
          "status": "promoted",
          "version": 4,
          "published": false
        },
        {
          "status": "draft",
          "published": false
        }
      ],
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-01-31T19:52:45.472Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:49:43.854Z",
        "timezone": "UTC"
      },
      "links": [
        {
          "href": "https://<hostname>/content/management/api/v1.1/taxonomies/5D5AF080B7824C49950443A7D51DE950?fields=availableStates",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    },
    {
      "id": "22ED0446197F49B490619206DEC71482",
      "name": "Taxonomy 2",
      "description": "Some description",
      "shortName": "T2",
      "status": "promoted",
      "version": 5,
      "isPublishable": false,
      "isForSiteManagement": false,
      "availableStates": [
        {
          "status": "promoted",
          "version": 5,
          "published": false
        },
        {
          "status": "draft",
          "published": false
        }
      ],
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-02-01T17:48:25.082Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:49:52.936Z",
        "timezone": "UTC"
      },
      "links": [
        {
          "href": "https://<hostname>/content/management/api/v1.1/taxonomies/22ED0446197F49B490619206DEC71482?fields=availableStates",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    },
    {
      "id": "D7969D6CA0D144AEA9CCA88BA6D2CF81",
      "name": "Taxonomy 3",
      "description": "Another description",
      "shortName": "T3",
      "status": "promoted",
      "version": 6,
      "isPublishable": false,
      "isForSiteManagement": false,
      "availableStates": [
        {
          "status": "promoted",
          "version": 6,
          "published": false
        },
        {
          "status": "draft",
          "published": false
        }
      ],
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-02-01T17:49:08.832Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:50:00.951Z",
        "timezone": "UTC"
      },
      "links": [
        {
          "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81?fields=availableStates",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?fields=availableStates",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?fields=availableStates",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/taxonomies",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?fields=availableStates&offset=0",
      "rel": "first",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?fields=availableStates&offset=0",
      "rel": "last",
      "method": "GET",
      "mediaType": "application/json"
    }
  ]
}

例6 :

昇格されたタクソノミのリストを返します。

/content/management/api/v1.1/taxonomies?q=(status eq \"promoted\")

レスポンス本文

{
  "hasMore": true,
  "offset": 0,
  "count": 1,
  "limit": 1,
  "items": [
    {
      "id": "5D5AF080B7824C49950443A7D51DE950",
      "name": "Taxonomy 1",
      "description": "",
      "shortName": "T1",
      "status": "promoted",
      "version": 4,
      "isPublishable": false,
      "isForSiteManagement": false,
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-01-31T19:52:45.472Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:49:43.854Z",
        "timezone": "UTC"
      },
      "links": [
        {
          "href": "https://<hostname>/content/management/api/v1.1/taxonomies/5D5AF080B7824C49950443A7D51DE950?limit=1&q=(status eq \"promoted\")",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?limit=1&q=(status eq \"promoted\")",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?limit=1&q=(status eq \"promoted\")",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/taxonomies",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?limit=1&offset=1&q=(status eq \"promoted\")",
      "rel": "next",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?limit=1&offset=0&q=(status eq \"promoted\")",
      "rel": "first",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?limit=1&offset=2&q=(status eq \"promoted\")",
      "rel": "last",
      "method": "GET",
      "mediaType": "application/json"
    }
  ]
}

例7 :

製品を含むタクソノミ名を持つ昇格されたタクソノミのリストを返します。

/content/management/api/v1.1/taxonomies?q=(status eq \"promoted\" AND name co \"product\")

レスポンス本文

{
  "hasMore": true,
  "offset": 0,
  "count": 1,
  "limit": 1,
  "items": [
    {
      "id": "5D5AF080B7824C49950443A7D51DE9F1",
      "name": "Product Colors",
      "description": "",
      "shortName": "COL",
      "status": "promoted",
      "version": 2,
      "isPublishable": false,
      "isForSiteManagement": false,
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-01-31T19:52:45.472Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:49:43.854Z",
        "timezone": "UTC"
      },
      "links": [
        {
          "href": "https://<hostname>/content/management/api/v1.1/taxonomies/5D5AF080B7824C49950443A7D51DE950?limit=1&q=(status eq \"promoted\" AND name co \"product\")",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?limit=1&q=(status eq \"promoted\" AND name co \"product\")",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?limit=1&q=(status eq \"promoted\" AND name co \"product\")",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/taxonomies",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?limit=1&offset=0&q=(status eq \"promoted\" AND name co \"product\")",
      "rel": "first",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?limit=1&offset=0&q=(status eq \"promoted\" AND name co \"product\")",
      "rel": "last",
      "method": "GET",
      "mediaType": "application/json"
    }
  ]
}

例8 :

コラムのタクソノミ短縮名を使用して、昇格されたタクソノミを検索します。

/content/management/api/v1.1/taxonomies?q=(status eq \"promoted\" AND shortName eq \"col\")

レスポンス本文

{
  "hasMore": true,
  "offset": 0,
  "count": 1,
  "limit": 1,
  "items": [
    {
      "id": "5D5AF080B7824C49950443A7D51DE9F1",
      "name": "Product Colors",
      "description": "",
      "shortName": "COL",
      "status": "promoted",
      "version": 2,
      "isPublishable": false,
      "isForSiteManagement": false,
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-01-31T19:52:45.472Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:49:43.854Z",
        "timezone": "UTC"
      },
      "links": [
        {
          "href": "https://<hostname>/content/management/api/v1.1/taxonomies/5D5AF080B7824C49950443A7D51DE950?limit=1&q=(status eq \"promoted\" AND shortName eq \"col\")",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?limit=1&q=(status eq \"promoted\" AND shortName eq \"col\"",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?limit=1&q=(status eq \"promoted\" AND shortName eq \"col\")",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/taxonomies",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?limit=1&offset=0&q=(status eq \"promoted\" AND shortName eq \"col\")",
      "rel": "first",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?limit=1&offset=0&q=(status eq \"promoted\" AND shortName eq \"col\")",
      "rel": "last",
      "method": "GET",
      "mediaType": "application/json"
    }
  ]
}

例9:

すべての昇格されたタクソノミとオプション・フィールド'availableStates'および'publishedChannels'をリストします。

/content/management/api/v1.1/taxonomies?fields=availableStates,publishedChannels

レスポンス本文

{
  "hasMore": false,
  "offset": 0,
  "count": 3,
  "limit": 100,
  "items": [
    {
      "id": "5D5AF080B7824C49950443A7D51DE950",
      "name": "Taxonomy 1",
      "description": "",
      "shortName": "T1",
      "status": "promoted",
      "version": 4,
      "isPublishable": true,
      "isForSiteManagement": false,
      "availableStates": [
        {
          "status": "promoted",
          "version": 4,
          "published": true
        },
        {
          "status": "draft",
          "published": false
        }
      ],
      "publishedChannels": [
        {
          "id": "CC59073EACA4A56A990700ADEB643CAB64E62AA2CC55",
          "name": "Channel 02"
        },
        {
          "id": "CCD608830CFD886E62FC58DC2B89320BEA5A4052D0FC",
          "name": "Channel 01"
        }
      ],
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-01-31T19:52:45.472Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:49:43.854Z",
        "timezone": "UTC"
      },
      "links": [
        {
          "href": "https://<hostname>/content/management/api/v1.1/taxonomies/5D5AF080B7824C49950443A7D51DE950?fields=availableStates,publishedChannels",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    },
    {
      "id": "22ED0446197F49B490619206DEC71482",
      "name": "Taxonomy 2",
      "description": "Some description",
      "shortName": "T2",
      "status": "promoted",
      "version": 5,
      "isPublishable": false,
      "isForSiteManagement": false,
      "availableStates": [
        {
          "status": "promoted",
          "version": 5,
          "published": false
        },
        {
          "status": "draft",
          "published": false
        }
      ],
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-02-01T17:48:25.082Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:49:52.936Z",
        "timezone": "UTC"
      },
      "links": [
        {
          "href": "https://<hostname>/content/management/api/v1.1/taxonomies/22ED0446197F49B490619206DEC71482?fields=availableStates,publishedChannels",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    },
    {
      "id": "D7969D6CA0D144AEA9CCA88BA6D2CF81",
      "name": "Taxonomy 3",
      "description": "Another description",
      "shortName": "T3",
      "status": "promoted",
      "version": 6,
      "isPublishable": true,
      "isForSiteManagement": false,
      "availableStates": [
        {
          "status": "promoted",
          "version": 6,
          "published": true
        },
        {
          "status": "draft",
          "published": false
        }
      ],
      "publishedChannels": [
        {
          "id": "CC59073EACA4A56A990700ADEB643CAB64E62AA2CC55",
          "name": "Channel 02"
        }
      ],
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-02-01T17:49:08.832Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:50:00.951Z",
        "timezone": "UTC"
      },
      "links": [
        {
          "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81?fields=availableStates,publishedChannels",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?fields=availableStates,publishedChannels",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?fields=availableStates,publishedChannels",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/taxonomies",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?fields=availableStates,publishedChannels&offset=0",
      "rel": "first",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?fields=availableStates,publishedChannels&offset=0",
      "rel": "last",
      "method": "GET",
      "mediaType": "application/json"
    }
  ]
}

例10:

各タクソノミのサブリソースcategoryPropertiesへのリンクを含む、すべての昇格済タクソノミをリストします。

/content/management/api/v1.1/taxonomies?fields=categoryProperties

レスポンス本文

{
  "hasMore": false,
  "offset": 0,
  "count": 3,
  "limit": 100,
  "items": [
    {
      "id": "5D5AF080B7824C49950443A7D51DE950",
      "name": "Taxonomy 1",
      "description": "",
      "shortName": "T1",
      "status": "promoted",
      "version": 4,
      "isPublishable": false,
      "isForSiteManagement": false,
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-01-31T19:52:45.472Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:49:43.854Z",
        "timezone": "UTC"
      },
      "categoryProperties": {
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/taxonomies/5D5AF080B7824C49950443A7D51DE950/categoryProperties",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
      },
      "links": [
        {
          "href": "https://<hostname>/content/management/api/v1.1/taxonomies/5D5AF080B7824C49950443A7D51DE950?fields=categoryProperties",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    },
    {
      "id": "22ED0446197F49B490619206DEC71482",
      "name": "Taxonomy 2",
      "description": "Some description",
      "shortName": "T2",
      "status": "promoted",
      "version": 5,
      "isPublishable": false,
      "isForSiteManagement": false,
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-02-01T17:48:25.082Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:49:52.936Z",
        "timezone": "UTC"
      },
      "categoryProperties": {
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/taxonomies/22ED0446197F49B490619206DEC71482/categoryProperties",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
      },
      "links": [
        {
          "href": "https://<hostname>/content/management/api/v1.1/taxonomies/22ED0446197F49B490619206DEC71482?fields=categoryProperties",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    },
    {
      "id": "D7969D6CA0D144AEA9CCA88BA6D2CF81",
      "name": "Taxonomy 3",
      "description": "Another description",
      "shortName": "T3",
      "status": "promoted",
      "version": 6,
      "isPublishable": false,
      "isForSiteManagement": false,
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-02-01T17:49:08.832Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:50:00.951Z",
        "timezone": "UTC"
      },
      "categoryProperties": {
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categoryProperties",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
      },
      "links": [
        {
          "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81?fields=categoryProperties",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?fields=categoryProperties",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?fields=categoryProperties",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/taxonomies",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?fields=categoryProperties&offset=0",
      "rel": "first",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?fields=categoryProperties&offset=0",
      "rel": "last",
      "method": "GET",
      "mediaType": "application/json"
    }
  ]
}

例11:

すべてのオプション・フィールドおよびサブリソースcategoryPropertiesへのリンクを含む、すべての昇格されたタクソノミをリストします。

/content/management/api/v1.1/taxonomies?fields=all

レスポンス本文

{
  "hasMore": false,
  "offset": 0,
  "count": 3,
  "limit": 100,
  "items": [
    {
      "id": "5D5AF080B7824C49950443A7D51DE950",
      "name": "Taxonomy 1",
      "description": "",
      "shortName": "T1",
      "status": "promoted",
      "version": 4,
      "isPublishable": true,
      "isForSiteManagement": false,
      "roleName": "manager",
      "availableStates": [
        {
          "status": "promoted",
          "version": 4,
          "published": true
        },
        {
          "status": "draft",
          "published": false
        }
      ],
      "publishedChannels": [
        {
          "id": "CC59073EACA4A56A990700ADEB643CAB64E62AA2CC55",
          "name": "Channel 02"
        },
        {
          "id": "CCD608830CFD886E62FC58DC2B89320BEA5A4052D0FC",
          "name": "Channel 01"
        }
      ],
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-01-31T19:52:45.472Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:49:43.854Z",
        "timezone": "UTC"
      },
      "categoryProperties": {
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/taxonomies/5D5AF080B7824C49950443A7D51DE950/categoryProperties",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
      },
      "links": [
        {
          "href": "https://<hostname>/content/management/api/v1.1/taxonomies/5D5AF080B7824C49950443A7D51DE950?fields=all",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    },
    {
      "id": "22ED0446197F49B490619206DEC71482",
      "name": "Taxonomy 2",
      "description": "Some description",
      "shortName": "T2",
      "status": "promoted",
      "version": 5,
      "isPublishable": false,
      "isForSiteManagement": false,
      "availableStates": [
        {
          "status": "promoted",
          "version": 5,
          "published": false
        },
        {
          "status": "draft",
          "published": false
        }
      ],
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-02-01T17:48:25.082Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:49:52.936Z",
        "timezone": "UTC"
      },
      "categoryProperties": {
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/taxonomies/22ED0446197F49B490619206DEC71482/categoryProperties",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
      },
      "links": [
        {
          "href": "https://<hostname>/content/management/api/v1.1/taxonomies/22ED0446197F49B490619206DEC71482?fields=all",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    },
    {
      "id": "D7969D6CA0D144AEA9CCA88BA6D2CF81",
      "name": "Taxonomy 3",
      "description": "Another description",
      "shortName": "T3",
      "status": "promoted",
      "version": 6,
      "isPublishable": true,
      "isForSiteManagement": false,
      "availableStates": [
        {
          "status": "promoted",
          "version": 6,
          "published": true
        },
        {
          "status": "draft",
          "published": false
        }
      ],
      "publishedChannels": [
        {
          "id": "CC59073EACA4A56A990700ADEB643CAB64E62AA2CC55",
          "name": "Channel 02"
        }
      ],
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-02-01T17:49:08.832Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:50:00.951Z",
        "timezone": "UTC"
      },
      "categoryProperties": {
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categoryProperties",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
      },
      "links": [
        {
          "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81?fields=all",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?fields=all",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?fields=all",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/taxonomies",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?fields=all&offset=0",
      "rel": "first",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?fields=all&offset=0",
      "rel": "last",
      "method": "GET",
      "mediaType": "application/json"
    }
  ]
}

例12:

「ビューア」以上の権限を持つ昇格されたタクソノミのリストを返します。

/content/management/api/v1.1/taxonomies?q=(roleName eq \"viewer\")&fields=all"

レスポンス本文

{
  "hasMore": false,
  "offset": 0,
  "count": 3,
  "limit": 100,
  "items": [
    {
      "id": "5D5AF080B7824C49950443A7D51DE950",
      "name": "Taxonomy Manager 1",
      "description": "",
      "shortName": "T1",
      "status": "promoted",
      "version": 4,
      "isPublishable": false,
      "isForSiteManagement": false,
      "roleName": "manager",
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-01-31T19:52:45.472Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:49:43.854Z",
        "timezone": "UTC"
      },
      "links": [
        {
          "href": "https://<hostname>/content/management/api/v1.1/taxonomies/5D5AF080B7824C49950443A7D51DE950",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    },
    {
      "id": "22ED0446197F49B490619206DEC71482",
      "name": "Taxonomy Editor 2",
      "description": "Some description",
      "shortName": "T2",
      "status": "promoted",
      "version": 5,
      "isPublishable": false,
      "isForSiteManagement": false,
      "roleName": "editor",
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-02-01T17:48:25.082Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:49:52.936Z",
        "timezone": "UTC"
      },
      "links": [
        {
          "href": "https://<hostname>/content/management/api/v1.1/taxonomies/22ED0446197F49B490619206DEC71482",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    },
    {
      "id": "D7969D6CA0D144AEA9CCA88BA6D2CF81",
      "name": "Taxonomy Viewer 3",
      "description": "Another description",
      "shortName": "T3",
      "status": "promoted",
      "version": 6,
      "isPublishable": false,
      "isForSiteManagement": false,
      "roleName": "viewer",
      "createdBy": "cecusername",
      "createdDate": {
        "value": "2019-02-01T17:49:08.832Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecusername",
      "updatedDate": {
        "value": "2019-02-01T17:50:00.951Z",
        "timezone": "UTC"
      },
      "links": [
        {
          "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/taxonomies",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?offset=0",
      "rel": "first",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies?offset=0",
      "rel": "last",
      "method": "GET",
      "mediaType": "application/json"
    }
  ]
}

先頭に戻る