機械翻訳について

移動先

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

バッチ共有解除ユーザー、アプリケーションまたはグループ

delete

/sites/management/api/v1/components/{id}/members

COLLECTION

このコンポーネントが共有されている1人以上のユーザー、アプリケーションまたはグループを共有解除します。 メンバー識別子は、memberId問合せパラメータを使用して指定され、1つのリクエストで1つ以上のユーザー、アプリケーションまたはグループを共有解除します。

リリース19.4.1.での導入。

認可

この操作を起動するには、認証されたユーザーまたはクライアント・アプリケーションがリソースと共有され、次のいずれかの「共有」ロールを持っている必要があります:

• 所有者
• マネージャ

バッチ処理

この操作では、DELETEリクエストのバッチ処理がサポートされます。 memberId問合せパラメータを使用してリソース識別子のカンマ区切りリストを指定することで、単一のバッチ・レスポンスで最大50個のリソース・インスタンスを削除できます。 レスポンスには、各DELETEレスポンスの詳細が含まれ、レスポンス・ステータス・コード、ヘッダーおよびレスポンス本文が表示されます。

パス代替識別子

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

nameコンポーネント名

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

http://api.example.com/sites/management/api/v1/components/name:FooterBar/members

リリース19.4.1.での導入。

成功したレスポンスの例

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

204No Content - Unshare a User and a Group

ユーザーjsmithを削除し、marketingをコンポーネントMyComponentからグループ化します。

リクエスト

DELETE https://api.example.com/sites/management/api/v1/components/name:MyComponent/members?memberId=user:jsmith,group:marketing

204No Content - Unshare a Client Application

テーマMyComponentからクライアント・アプリケーションMyProductAPPIDを削除します。

リクエスト

DELETE https://api.example.com/sites/management/api/v1/components/name:MyComponent/members?memberId=user:MyProduct_APPID

リリース20.3.3で導入されました。

204No Content - Unshare Multiple Groups

コンポーネントMyComponentからグループengineeringおよびmarketingを削除します。

リクエスト

DELETE https://api.example.com/sites/management/api/v1/components/name:MyComponent/members?memberId=group:engineering,group:marketing

204No Content - Unshare Multiple Users

コンポーネントMyComponentからユーザーjsmith1およびjsmith2を削除します。

リクエスト

DELETE https://api.example.com/sites/management/api/v1/components/name:MyComponent/members?memberId=user:jsmith1,user:jsmith2

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

この操作は、レスポンス本文に例外の詳細が含まれている次のクライアント・エラー(4xx)レスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。

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.での導入。

リクエスト

パス・パラメータ

• id: string

  コンポーネントの不変の識別子。

問合せパラメータ

• memberId(optional): string

  バッチ処理されたリクエストで使用するリソース識別子のリスト。 構文では、リソース識別子のカンマ区切りの順序を使用します。

トップに戻る

レスポンス

サポートされているメディア・タイプ

• application/json

204レスポンス

内容なし

400レスポンス

不正なリクエスト

401レスポンス

未認可

403レスポンス

禁止

404レスポンス

見つかりません

ヘッダー

• Cache-Control: string

  キャッシュ・メカニズムのディレクティブ。

• Content-Length: string

  レスポンス本文のサイズ。

• Content-Type: string

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

本文()

ルート・スキーマ: schema

すべてに一致

ソースを表示

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

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

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

リリース19.4.1.での導入。

すべてに一致

ソースを表示

• object ExceptionDetail

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

• object ComponentNotFoundExceptionDetail-allOf[1]

{
    "description":"<small>Introduced in release 19.4.1.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "component":{
                    "description":"<p>Component that does not exist or is not visible to the authenticated user.</p><small>Introduced in release 19.4.1.</small>",
                    "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"
                    }
                ]
            }
        }
    }
}

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

型: object

ソースを表示

• component(オプション): string

  存在しないか、認証されたユーザーから見えないコンポーネントです。

  リリース19.4.1.での導入。

{
    "properties":{
        "component":{
            "description":"<p>Component that does not exist or is not visible to the authenticated user.</p><small>Introduced in release 19.4.1.</small>",
            "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":"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レスポンス

競合

413 レスポンス

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

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

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

先頭に戻る