タクソノミの昇格
post
/content/management/api/v1.1/taxonomies/{id}/promote
新しい上位タクソノミとなるようにドラフト・タクソノミをプロモートします。
タクソノミをプロモートするには、ドラフト・タクソノミのshortNameが一意である必要があります。 他のタクソノミのshortNameと競合する場合、このリクエストは失敗します。
ドラフトのタクソノミでは、一度に1つのプロモーション・リクエストのみアクティブにできます。 ドラフト・タクソノミで昇格が進行中の場合は、後続のすべてのリクエストは、初期プロモーションが完了するまで失敗します。
タクソノミをプロモートするには、ドラフト・タクソノミのshortNameが一意である必要があります。 他のタクソノミのshortNameと競合する場合、このリクエストは失敗します。
ドラフトのタクソノミでは、一度に1つのプロモーション・リクエストのみアクティブにできます。 ドラフト・タクソノミで昇格が進行中の場合は、後続のすべてのリクエストは、初期プロモーションが完了するまで失敗します。
リクエスト
パス・パラメータ
- id: string
タクソノミのId。
問合せパラメータ
- links(optional): string
このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby
ヘッダー・パラメータ
- X-Requested-With: string
CSRF攻撃を軽減するためのカスタム・ヘッダー。許容値:
[ "XMLHttpRequest" ]
タクソノミは、リクエスト・ペイロードをプロモートします。 現在、draftタクソノミのみプロモートできます。そのため、ペイロードは無視されます。
これは非同期操作です。 非同期リクエストは、ロケーション・ヘッダーにステータス・リンクがある202ステータスで応答します。
これは非同期操作です。 非同期リクエストは、ロケーション・ヘッダーにステータス・リンクがある202ステータスで応答します。
ルート・スキーマ : TaxonomyOperationPromoteRequest
型:
objectタクソノミ操作プロモート・リクエスト
ソースを表示
- isPublishable(optional): boolean
タクソノミが公開可能かどうか。(デフォルトはfalseです)
- status(optional): string
タクソノミのステータス(ドラフト/促進済)。 ドラフトのタクソノミのみをプロモートできるため、プロモーション・リクエストではこの操作は無視されます。
- version(optional): integer(int32)
タクソノミのバージョン。 現在、バージョン・フィールドは無視されます。
レスポンス
サポートされているメディア・タイプ
- application/json
202レスポンス
Accepted.
400レスポンス
不正リクエスト
403レスポンス
禁止。
404レスポンス
タクソノミが見つかりません。 リクエストしたリソースが見つかりません。
409レスポンス
リクエストされたリソース操作は一時的に使用できません
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/{id}/promote'
例:
次の例は、非同期ジョブを開始して、ドラフト・タクソノミを昇格する方法を示しています。
/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/promote
リクエスト本文
{
"status": "draft"
}