機械翻訳について

移動先

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

テンプレートから退出

post

/sites/management/api/v1/templates/{id}/members/leave

EXTENDED OPERATION

ユーザーまたはクライアント・アプリケーションがテンプレート内に共有ロールを持っている場合、ユーザーまたはクライアント・アプリケーションはテンプレートを終了できます。

リリース19.4.1.での導入。

共有

テンプレートと共有されているユーザーまたはクライアント・アプリケーションは、すべて終了できます。 所有者は退出できません。

パス代替識別子

「テンプレート」リソースのデフォルトの識別子は、「テンプレート識別子」です。 テンプレート・リソースは代替識別子をサポートしています。

nameテンプレート名

テンプレート識別子のかわりに、テンプレート名を使用してリソース・パスでテンプレートを一意に識別できます。 テンプレートのデフォルトのリソース・パス・パラメータはテンプレート識別子ですが、テンプレートでの作業時には、判読可能なテンプレート名が簡単になる場合があります。

http://api.example.com/sites/management/api/v1/templates/name:CafeSupremo/members/leave

リリース19.4.1.での導入。

成功したレスポンスの例

この操作は、次の成功(2xx)のレスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。

204No Content - User or Application has Left the Template

ユーザーまたはクライアント・アプリケーションがテンプレートを終了した場合、コンテンツ・レスポンス・コードは返されません。

クライアント・エラー・レスポンスの例

この操作は、レスポンス本文に例外の詳細が含まれている次のクライアント・エラー(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 - Template Not Found

サイト・テンプレートが存在しないか、削除されたか、認証済ユーザーまたはクライアント・アプリケーションがテンプレートへのアクセス権を持っていません。

エラー・コード

OCE-SITEMGMT-009000

解決 - 識別子のチェック

テンプレート識別子が有効であることを確認してください。

解決 - メンバーシップのチェック

認証済ユーザーがテンプレートのメンバーまたはサイト管理者であることを確認してください。

例外詳細フィールド

このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:

フィールド名	説明
template	存在しないか、認証されたユーザーに表示されないテンプレート。

この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのTemplateNotFoundExceptionDetailスキーマを参照してください。

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Template Not Found",
  "status": "404",
  "detail": "Template does not exist or has been deleted, or the authenticated user or client application does not have access to the template.",
  "o:errorCode": "OCE-SITEMGMT-009000",
  "template": {
    "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
  }
}

リクエスト

パス・パラメータ

• id: string

  テンプレートの不変識別子。

問合せパラメータ

• includeDeleted(optional): boolean

  削除対象としてマークされているリソースでは、この問合せパラメータがtrueに設定されているかぎり、読取り、変更およびサポート対象の拡張操作が可能です。 includeDeleted問合せパラメータを送信しない場合、読取り、変更および拡張操作に対するレスポンスは、リソースが完全に削除された場合に戻されるものと同じです。

トップに戻る

レスポンス

204レスポンス

内容なし

400レスポンス

不正なリクエスト

本文()

ルート・スキーマ: schema

すべてに一致

ソースを表示

• allOf OwnerMemberReadOnlyExceptionDetail
  リリース19.4.1.での導入。

{
    "allOf":[
        {
            "$ref":"#/definitions/OwnerMemberReadOnlyExceptionDetail"
        }
    ]
}

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

リリース19.4.1.での導入。

すべてに一致

ソースを表示

• object ExceptionDetail

  HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。

{
    "description":"<small>Introduced in release 19.4.1.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
        }
    ]
}

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

型: 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ページなどの問題の判読可能なサマリーを提供します。

{
    "description":"<p>In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.</p>",
    "properties":{
        "type":{
            "description":"<p>Absolute URI that identifies the problem type. When this URI dereferenced, it <strong>should</strong> provide a human-readable summary of the problem, for example, as a HTML page.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "title":{
            "description":"<p>Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the <code>o:errorCode</code> for this purpose.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>Corresponding HTTP status code for the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "detail":{
            "description":"<p>Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "instance":{
            "description":"<p>URI to the link that provides more detail about the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "o:errorCode":{
            "description":"<p>Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the <code>title</code> or <code>detail</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorPath":{
            "description":"<p>XPath or JSON path to indicate where the error occurs.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorDetails":{
            "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ExceptionDetail"
                    }
                ]
            }
        }
    }
}

ネストされたスキーマ: o:errorDetails

型: array

階層構造に複数のエラーがある場合もあります。

ソースを表示

• Array of: items

{
    "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ExceptionDetail"
            }
        ]
    }
}

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

すべてに一致

ソースを表示

• object ExceptionDetail

  HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。

{
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        }
    ]
}

回答の例(所有者メンバー読取り専用)

{
    "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

  レスポンスのコンテンツ・タイプ。

本文()

ルート・スキーマ: schema

すべてに一致

ソースを表示

• allOf TemplateNotFoundExceptionDetail

{
    "allOf":[
        {
            "$ref":"#/definitions/TemplateNotFoundExceptionDetail"
        }
    ]
}

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

すべてに一致

ソースを表示

• object ExceptionDetail

  HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。

• object TemplateNotFoundExceptionDetail-allOf[1]

{
    "description":"",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "template":{
                    "description":"<p>Template that does not exist or is not visible to the authenticated user.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

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

型: 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ページなどの問題の判読可能なサマリーを提供します。

{
    "description":"<p>In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.</p>",
    "properties":{
        "type":{
            "description":"<p>Absolute URI that identifies the problem type. When this URI dereferenced, it <strong>should</strong> provide a human-readable summary of the problem, for example, as a HTML page.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "title":{
            "description":"<p>Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the <code>o:errorCode</code> for this purpose.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>Corresponding HTTP status code for the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "detail":{
            "description":"<p>Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "instance":{
            "description":"<p>URI to the link that provides more detail about the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "o:errorCode":{
            "description":"<p>Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the <code>title</code> or <code>detail</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorPath":{
            "description":"<p>XPath or JSON path to indicate where the error occurs.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorDetails":{
            "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ExceptionDetail"
                    }
                ]
            }
        }
    }
}

ネストされたスキーマ : TemplateNotFoundExceptionDetail-allOf[1]

型: object

ソースを表示

• template(optional): string

  存在しないか、認証されたユーザーに表示されないテンプレート。

{
    "properties":{
        "template":{
            "description":"<p>Template that does not exist or is not visible to the authenticated user.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

ネストされたスキーマ: o:errorDetails

型: array

階層構造に複数のエラーがある場合もあります。

ソースを表示

• Array of: items

{
    "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ExceptionDetail"
            }
        ]
    }
}

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

すべてに一致

ソースを表示

• object ExceptionDetail

  HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。

{
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        }
    ]
}

レスポンスの例(テンプレートが見つかりません)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Template Not Found",
    "status":"404",
    "detail":"Template does not exist or has been deleted, or the authenticated user or client application does not have access to the template.",
    "o:errorCode":"OCE-SITEMGMT-009000",
    "template":{
        "id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
    }
}

409レスポンス

競合

413 レスポンス

ペイロードが大きすぎます

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

ゲートウェイがタイムアウト

先頭に戻る