テーマから退出
/sites/management/api/v1/themes/{id}/members/leave
ユーザーまたはクライアント・アプリケーションがテーマに共有ロールを持っている場合、ユーザーまたはクライアント・アプリケーションはテーマから移動できます。
リリース19.4.1.での導入。
共有
テーマと共有されているユーザーまたはクライアント・アプリケーションは、すべて終了できます。 所有者は退出できません。
パス代替識別子
「テーマ」リソースのデフォルトの識別子は、「テーマ識別子」です。 テーマ・リソースは代替識別子をサポートしています。
nameテーマ名
テーマ識別子のかわりに、テーマ名を使用して、リソース・パスのテーマを一意に識別できます。 テーマのデフォルトのリソース・パス・パラメータはテーマ識別子ですが、テーマで作業すると、判読可能なテーマ名の方が簡単になる場合があります。
http://api.example.com/sites/management/api/v1/themes/name:LearnTheme/members/leave
リリース19.4.1.での導入。
成功したレスポンスの例
この操作は、次の成功(2xx)のレスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。
204No Content - User or Application has Left the Theme
ユーザーまたはクライアント・アプリケーションがテーマを離れた場合、コンテンツ・レスポンス・コードは返されません。
クライアント・エラー・レスポンスの例
この操作は、レスポンス本文に例外の詳細が含まれている次のクライアント・エラー(4xx)レスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。
400Bad Request - Owner Member Read-Only
所有者メンバーは読取り専用であり、変更できません。
エラー・コード
OCE-DOCS-001004
解決 - 退出しない
所有者は、自分が所有するリソースから離れることはできません。 リソースを退会できるのは、そのリソースが自分と共有されている場合のみです。
解決 - 削除しない
所有者はメンバーとして削除できません。
解決 - ロールを変更しない
所有者のロールは変更できません。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Owner Member Read-Only", "status": "400", "detail": "The operation cannot be performed as the user is the owner of the resource.", "o:errorCode": "OCE-DOCS-001004" }
リリース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.での導入。
リクエスト
- id: string
テーマの不変識別子。
- includeDeleted(optional): boolean
削除対象としてマークされているリソースでは、この問合せパラメータが
true
に設定されているかぎり、読取り、変更およびサポート対象の拡張操作が可能です。includeDeleted
問合せパラメータを送信しない場合、読取り、変更および拡張操作に対するレスポンスは、リソースが完全に削除された場合に戻されるものと同じです。
レスポンス
204レスポンス
400レスポンス
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
-
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 ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Owner Member Read-Only",
"status":"400",
"detail":"The operation cannot be performed as the user is the owner of the resource.",
"o:errorCode":"OCE-DOCS-001004"
}
401レスポンス
403レスポンス
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"
}
}