テーマのソフト削除
/sites/management/api/v1/themes/{id}
テーマをソフト削除します。 ソフト削除されたテーマに対応するフォルダは、テーマの所有者のごみ箱フォルダに移動されます。 ソフト削除されたテーマは、リストアまたはハード削除できます。
リリース19.4.1.での導入。
認可
この操作を起動するには、認証されたユーザーまたはクライアント・アプリケーションがリソースと共有され、次のいずれかの「共有」ロールを持っている必要があります:
- 所有者
- マネージャ
テーマの使用中
テーマは、テンプレート、サイトまたはサイトの更新(ごみ箱内のテンプレート、サイトまたは更新を含む)で使用されている場合、削除できません。
削除したテーマのリストア
ソフト削除されたテーマは、所有者またはテーマを削除したユーザーがリストアできます。
詳細は、「削除するテーマの削除を元に戻す」を参照してください。
テーマの完全削除
ソフト削除されたテーマは、ハード削除を使用して完全に削除できます。
詳細は、「テーマのハード削除」を参照してください。
パス代替識別子
「テーマ」リソースのデフォルトの識別子は、「テーマ識別子」です。 テーマ・リソースは代替識別子をサポートしています。
nameテーマ名
テーマ識別子のかわりに、テーマ名を使用して、リソース・パスのテーマを一意に識別できます。 テーマのデフォルトのリソース・パス・パラメータはテーマ識別子ですが、テーマで作業すると、判読可能なテーマ名の方が簡単になる場合があります。
http://api.example.com/sites/management/api/v1/themes/name:LearnTheme
リリース19.4.1.での導入。
成功したレスポンスの例
この操作は、次の成功(2xx)のレスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。
204No Content - Soft Deleted
リソースが削除されると、204
ステータス・コードが返されます。
クライアント・エラー・レスポンスの例
この操作は、レスポンス本文に例外の詳細が含まれている次のクライアント・エラー(4xx)レスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。
403Forbidden - Theme Operation Forbidden
テーマ内で共有ロールを使用した場合、操作を実行できません。
エラー・コード
OCE-SITEMGMT-009054
解決 - 共有ロールの変更
認証ユーザーに付与された共有ロールを必要なロール以上に変更します。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
theme | 操作が実行されているテーマ。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのThemeOperationForbiddenExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Theme Operation Forbidden", "status": "403", "detail": "You do have a sharing role in this theme, but your role does not allow you to use this operation.", "o:errorCode": "OCE-SITEMGMT-009054", "theme": { "id": "FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC" } }
リリース19.4.1.での導入。
404Not Found - Theme Not Found
サイト・テーマが存在しないか削除されているか、認証されたユーザー・アプリケーションまたはクライアント・アプリケーションがテーマへのアクセス権を持っていません。
エラー・コード
OCE-SITEMGMT-009041
解決 - 識別子のチェック
テーマ識別子が有効であることを確認してください。
解決 - メンバーシップのチェック
認証されたユーザーがテーマのメンバーであることを確認します。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
theme | 存在しないか、認証されたユーザーに表示されないテーマ。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのThemeNotFoundExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Theme Not Found", "status": "404", "detail": "Theme does not exist or has been deleted, or the authenticated user or client application does not have access to the theme.", "o:errorCode": "OCE-SITEMGMT-009041", "theme": { "id": "FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC" } }
リリース19.4.1.での導入。
409Conflict - Theme In Use
このテーマは複数のサイトまたはテンプレートで使用されているので削除できません。
エラー・コード
OCE-SITEMGMT-009056
解決 - ハード削除サイト
テーマに関連付けられたサイトをハード削除します。
解決 - ハード削除テンプレート
テーマに関連付けられたテンプレートをハード削除します。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
theme | 使用中のため削除できないテーマ。 |
templates | テーマを使用するテンプレート。 |
sites | テーマを使用するサイト。 |
usedBy | テーマを使用しているサイト・リソース。 |
sitePlans | テーマを使用するサイト・プラン。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのThemeInUseExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Theme In Use", "status": "409", "detail": "Theme cannot be deleted because it is being used by one or more sites, site plans or templates.", "o:errorCode": "OCE-SITEMGMT-009056", "theme": { "id": "FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC" }, "templates": [ { "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6" } ], "sites": [ { "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0" } ], "usedBy": { "sites": [ { "name": "MyNewProduct", "site": { "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0" } } ], "templates": [ { "name": "CafeSupremo", "template": { "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6" } } ], "types": [ { "name": "value", "type": { "name": "Video" } } ], "translationConnectors": [ { "name": "value" } ], "sitePlans": [ { "name": "value" } ] }, "sitePlans": [ "value" ] }
リリース19.4.1.での導入。
リクエスト
- id: string
テーマの不変識別子。
レスポンス
204レスポンス
400レスポンス
401レスポンス
403レスポンス
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- object ThemeOperationForbiddenExceptionDetail-allOf[1]
object
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- detail(optional): string
この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で問題を説明しています。
- instance(optional): string(uri)
エラーに関する詳細を提供するリンクへのURI。
- o:errorCode(optional): string
アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。 このコードは、
title
やdetail
などのフィールドを比較するのではなく、特定のエラーをチェックするために使用する必要があります。 - o:errorDetails(optional): array o:errorDetails
階層構造に複数のエラーがある場合もあります。
- o:errorPath(optional): string
エラーが発生した場所を示すXPathまたはJSONパス。
- status(optional): integer(int32)
エラーに対応するHTTPステータス・コード。
- title(optional): string
問題の短く、判読可能なサマリー。 タイトルは、特定のエラーをチェックする方法としては使用しないでください。そのためには
o:errorCode
を使用してください。 - type(optional): string(uri)
問題のタイプを識別する絶対URI。 このURIが参照解除されると、「推奨」は、HTMLページなどの問題の判読可能なサマリーを提供します。
object
- theme(optional): string
操作が実行されているテーマ。
リリース19.4.1.での導入。
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Theme Operation Forbidden",
"status":"403",
"detail":"You do have a sharing role in this theme, but your role does not allow you to use this operation.",
"o:errorCode":"OCE-SITEMGMT-009054",
"theme":{
"id":"FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC"
}
}
404レスポンス
- Cache-Control: string
キャッシュ・メカニズムのディレクティブ。
- Content-Length: string
レスポンス本文のサイズ。
- Content-Type: string
レスポンスのコンテンツ・タイプ。
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- object ThemeNotFoundExceptionDetail-allOf[1]
object
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- detail(optional): string
この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で問題を説明しています。
- instance(optional): string(uri)
エラーに関する詳細を提供するリンクへのURI。
- o:errorCode(optional): string
アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。 このコードは、
title
やdetail
などのフィールドを比較するのではなく、特定のエラーをチェックするために使用する必要があります。 - o:errorDetails(optional): array o:errorDetails
階層構造に複数のエラーがある場合もあります。
- o:errorPath(optional): string
エラーが発生した場所を示すXPathまたはJSONパス。
- status(optional): integer(int32)
エラーに対応するHTTPステータス・コード。
- title(optional): string
問題の短く、判読可能なサマリー。 タイトルは、特定のエラーをチェックする方法としては使用しないでください。そのためには
o:errorCode
を使用してください。 - type(optional): string(uri)
問題のタイプを識別する絶対URI。 このURIが参照解除されると、「推奨」は、HTMLページなどの問題の判読可能なサマリーを提供します。
object
- theme(optional): string
存在しないか、認証されたユーザーに表示されないテーマ。
リリース19.4.1.での導入。
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Theme Not Found",
"status":"404",
"detail":"Theme does not exist or has been deleted, or the authenticated user or client application does not have access to the theme.",
"o:errorCode":"OCE-SITEMGMT-009041",
"theme":{
"id":"FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC"
}
}
409レスポンス
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- object ThemeInUseExceptionDetail-allOf[1]
object
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- detail(optional): string
この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で問題を説明しています。
- instance(optional): string(uri)
エラーに関する詳細を提供するリンクへのURI。
- o:errorCode(optional): string
アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。 このコードは、
title
やdetail
などのフィールドを比較するのではなく、特定のエラーをチェックするために使用する必要があります。 - o:errorDetails(optional): array o:errorDetails
階層構造に複数のエラーがある場合もあります。
- o:errorPath(optional): string
エラーが発生した場所を示すXPathまたはJSONパス。
- status(optional): integer(int32)
エラーに対応するHTTPステータス・コード。
- title(optional): string
問題の短く、判読可能なサマリー。 タイトルは、特定のエラーをチェックする方法としては使用しないでください。そのためには
o:errorCode
を使用してください。 - type(optional): string(uri)
問題のタイプを識別する絶対URI。 このURIが参照解除されると、「推奨」は、HTMLページなどの問題の判読可能なサマリーを提供します。
object
- sitePlans(optional): array sitePlans
テーマを使用するサイト・プラン。
リリース23.6.1で導入されました。 - sites(optional): array sites
テーマを使用するサイト。
リリース19.4.1.での導入。 - templates(optional): array templates
テーマを使用するテンプレート。
リリース19.4.1.での導入。 - theme(optional): string
使用中のため削除できないテーマ。
リリース19.4.1.での導入。 - usedBy(optional): object usedBy
テーマを使用しているサイト・リソース。
リリース22.6.2で導入されました。
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
object
テーマを使用しているサイト・リソース。
リリース22.6.2で導入されました。- sitePlans(optional): array sitePlans
サイト・プラン。
リリース23.6.1で導入されました。 - sites(optional): array sites
サイト
リリース22.6.2で導入されました。 - templates(optional): array templates
テンプレート
リリース22.6.2で導入されました。 - translationConnectors(optional): array translationConnectors
翻訳コネクタ。
リリース22.8.2で導入されました。 - types(optional): array types
コンテンツ・タイプ
リリース22.6.2で導入されました。
object
- name: string
最大長:
242
サイト名
リリース22.6.2で導入されました。 - site: string
関連付けられたサイト・リソース。
リリース22.6.2で導入されました。
object
- name: string
最大長:
242
テンプレート名
リリース22.6.2で導入されました。 - template: string
関連付けられたテンプレート・リソース。
リリース22.6.2で導入されました。
object
- name: string
コンテンツ・タイプ名。
リリース22.7.2で導入されました。 - type: string
関連コンテンツ・タイプ・リソース。
リリース22.7.2で導入されました。
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Theme In Use",
"status":"409",
"detail":"Theme cannot be deleted because it is being used by one or more sites, site plans or templates.",
"o:errorCode":"OCE-SITEMGMT-009056",
"theme":{
"id":"FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC"
},
"templates":[
{
"id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
}
],
"sites":[
{
"id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
}
],
"usedBy":{
"sites":[
{
"name":"MyNewProduct",
"site":{
"id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
}
}
],
"templates":[
{
"name":"CafeSupremo",
"template":{
"id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
}
}
],
"types":[
{
"name":"value",
"type":{
"name":"Video"
}
}
],
"translationConnectors":[
{
"name":"value"
}
],
"sitePlans":[
{
"name":"value"
}
]
},
"sitePlans":[
"value"
]
}