コンポーネントのソフト削除
/sites/management/api/v1/components/{id}
コンポーネントをソフト削除します。 ソフト削除されたコンポーネントに対応するフォルダは、コンポーネントの所有者のごみ箱フォルダに移動されます。 ソフト削除されたコンポーネントはリストアまたはハード削除できます。
リリース19.4.1.での導入。
認可
この操作を起動するには、認証されたユーザーまたはクライアント・アプリケーションがリソースと共有され、次のいずれかの「共有」ロールを持っている必要があります:
- 所有者
- マネージャ
コンポーネントの使用
コンポーネントまたはレイアウトがテンプレートで使用されている場合、削除できません。サイトまたはサイトの更新(テンプレート、サイト、ごみ箱内の更新を含む)です。
削除したコンポーネントのリストア
ソフト削除されたコンポーネントは、所有者またはコンポーネントを削除したユーザーがリストアできます。
詳細は、「削除したコンポーネントの削除を元に戻す」を参照してください。
コンポーネントの完全に削除
ソフト削除されたコンポーネントは、ハード削除を使用して永久に削除できます。
詳細は、「コンポーネントのハード削除」を参照してください。
パス代替識別子
「コンポーネント」リソースのデフォルトの識別子は、「コンポーネント識別子」です。 コンポーネント・リソースは代替識別子をサポートします。
nameコンポーネント名
コンポーネント識別子のかわりに、コンポーネント名を使用してリソース・パスのコンポーネントを一意に識別できます。 コンポーネントのデフォルトのリソース・パス・パラメータはコンポーネント識別子ですが、コンポーネントを操作するときには、判読可能なコンポーネント名が簡単になる場合があります。
http://api.example.com/sites/management/api/v1/components/name:FooterBar
リリース19.4.1.での導入。
成功したレスポンスの例
この操作は、次の成功(2xx)のレスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。
204No Content - Soft Deleted
リソースが削除されると、204
ステータス・コードが返されます。
クライアント・エラー・レスポンスの例
この操作は、レスポンス本文に例外の詳細が含まれている次のクライアント・エラー(4xx)レスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。
403Forbidden - Component Operation Forbidden
コンポーネント内で共有ロールを使用しても、この操作を実行できません。
エラー・コード
OCE-SITEMGMT-009055
解決 - 共有ロールの変更
認証ユーザーに指定されたロールを必要なロール以上に変更します。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
component | 操作が実行されているコンポーネント。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのComponentOperationForbiddenExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Component Operation Forbidden", "status": "403", "detail": "You do have a sharing role in this component, but your role does not allow you to use this operation.", "o:errorCode": "OCE-SITEMGMT-009055", "component": { "id": "F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8" } }
リリース19.4.1.での導入。
404Not Found - Component Not Found
サイト・コンポーネントが存在しないか、削除されたか、認証済ユーザーまたはクライアント・アプリケーションがコンポーネントへのアクセス権を持っていません。
エラー・コード
OCE-SITEMGMT-009045
解決 - 識別子のチェック
コンポーネント識別子が有効であることを確認してください。
解決 - メンバーシップのチェック
認証されたユーザーがコンポーネントのメンバーであることを確認します。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
component | 存在しないか、認証されたユーザーから見えないコンポーネントです。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのComponentNotFoundExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Component Not Found", "status": "404", "detail": "Component does not exist or has been deleted, or the authenticated user or client application does not have access to the component.", "o:errorCode": "OCE-SITEMGMT-009045", "component": { "id": "F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8" } }
リリース19.4.1.での導入。
409Conflict - Component In Use
コンポーネントは1つ以上のサイト、テンプレートまたはアセット・タイプで使用されているため、削除できません。
エラー・コード
OCE-SITEMGMT-009057
解決 - ハード削除サイト
コンポーネントに関連付けられたサイトをハード削除します。
解決 - ハード削除テンプレート
コンポーネントに関連付けられているテンプレートをハード削除します。
解決 - テンプレートまたはサイトからのコンポーネント使用状況の削除
そのコンポーネントを使用しているサイトまたはテンプレートから、コンポーネントを削除します。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
component | 使用中のため削除できないコンポーネントです。 |
templates | コンポーネントを使用するテンプレート。 |
sites | コンポーネントを使用するサイト。 |
usedBy | コンポーネントを使用しているサイト・リソース。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのComponentInUseExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Component In Use", "status": "409", "detail": "Component cannot be deleted because it is being used by one or more sites, templates or asset types.", "o:errorCode": "OCE-SITEMGMT-009057", "component": { "id": "F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8" }, "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" } ] } }
リリース19.4.1.での導入。
リクエスト
- id: string
コンポーネントの不変の識別子。
レスポンス
204レスポンス
400レスポンス
401レスポンス
403レスポンス
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- object ComponentOperationForbiddenExceptionDetail-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
- component(オプション): string
操作が実行されているコンポーネント。
リリース19.4.1.での導入。
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Component Operation Forbidden",
"status":"403",
"detail":"You do have a sharing role in this component, but your role does not allow you to use this operation.",
"o:errorCode":"OCE-SITEMGMT-009055",
"component":{
"id":"F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
}
}
404レスポンス
- Cache-Control: string
キャッシュ・メカニズムのディレクティブ。
- Content-Length: string
レスポンス本文のサイズ。
- Content-Type: string
レスポンスのコンテンツ・タイプ。
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- object ComponentNotFoundExceptionDetail-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
- component(オプション): string
存在しないか、認証されたユーザーから見えないコンポーネントです。
リリース19.4.1.での導入。
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Component Not Found",
"status":"404",
"detail":"Component does not exist or has been deleted, or the authenticated user or client application does not have access to the component.",
"o:errorCode":"OCE-SITEMGMT-009045",
"component":{
"id":"F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
}
}
409レスポンス
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- object ComponentInUseExceptionDetail-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
- component(オプション): string
使用中のため削除できないコンポーネントです。
リリース19.4.1.での導入。 - sites(optional): array sites
コンポーネントを使用するサイト。
リリース19.4.1.での導入。 - templates(optional): array templates
コンポーネントを使用するテンプレート。
リリース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":"Component In Use",
"status":"409",
"detail":"Component cannot be deleted because it is being used by one or more sites, templates or asset types.",
"o:errorCode":"OCE-SITEMGMT-009057",
"component":{
"id":"F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
},
"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"
}
]
}
}