削除¶
GET /api/v1/wksp_share/delete
概要¶
認可設定 UUID に基づいて、現在のワークスペースが発行した認可を一括で論理削除します。
呼び出し前の準備と使用手順¶
作成/変更/削除にはデータ認可元ワークスペースの API Key を使用し、読み取りは現在の Key のワークスペースの認可方向に従って操作します。このグループで認可するのはワークスペース間のデータクエリ機能であり、メンバーの招待、アカウントロールの付与、データのコピーではありません。レスポンスの workspaceUUID は認可元、toWorkspaceUUID は認可先です。追加時の Body.workspaceUUID のみが認可先の対象ワークスペースを表し、レスポンスの同名フィールドとは方向が異なります。クエリが有効になるかは、データドメイン、ログインデックス、フィルター条件、実際の認可状態、およびソースワークスペースの状態によっても制限されます。
作成/変更/削除には dataRightsManage.workspaceConfigManage が必要です。まず 認可リスト の type=grant で現在のワークスペース自身が発行したレコードを読み取り、content.data[].uuid を取得します。認可リスト内の他のソースワークスペースの UUID を、自分が変更可能な設定とみなさないでください。結果が不明な場合は、まず設定を読み戻し、重複認可や、失敗してまったく実行されなかったという誤解を避けてください。
これは削除の副作用があるレガシーな GET エンドポイントであり、読み取り専用クエリ、プリフェッチ、ヘルスチェックとして使用できません。deleteUUIDs には認可設定 UUID を半角カンマで区切って指定します。被認可ワークスペースの UUID ではありません。現在のワークスペースが発行した一致レコードのみを論理削除します。不明、他のソースワークスペース、削除済み、または空の集合の場合は操作なしで成功 true となることがあり、true を削除件数の集計に使用できません。
設定は 1 件ずつ独立して送信されます。クロスサイトのレコードは revoked とマークされ、ローカルサイトのアクセスキャッシュがクリアされます。古いリモート側に削除を能動的に要求することはなく、リモートリストの一時保持はソース認可が依然として有効であることを意味しません。このエンドポイントは、参照しているすべてのモニターを能動的に無効化することはなく、元データも削除しません。削除バッチの後続のキャッシュ/サイト通知の準備に失敗すると、先行する項目がすでに削除されている可能性があります。エラー時は認可リストを再読み取りして残りの項目を確認し、再試行するかどうかを判断してください。通知の内部エラーは記録のみとなる場合があり、配信は保証されません。
リクエストヘッダー¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメーター¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| deleteUUIDs | commaArray | Y | 必須のカンマ区切り文字列で、各項目の先頭と末尾の空白は除去されます。不明/一致なしの場合は操作なしで成功することがあります。ワークスペース UUID、大文字キーの DeleteUUIDs、JSON 配列は指定できません。 null を許可: False 例: grant_example取得または入力方法: type=grant の認可リスト の content.data[].uuid から項目ごとに取得します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/wksp_share/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode deleteUUIDs=grant_example
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | ルーティングに成功した場合は固定で true となり、影響件数はありません。すべての入力が存在すること/すべての関連付けが収束したことと同義ではありません。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
現在のソースワークスペースの status=0 のモデルレコードのみに一致し、認可双方のワークスペースがともにアクティブであることは保証されません。一致しない場合でも必ず 404 になるわけではなく、バッチはオール・オア・ナッシングのトランザクションではありません。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメーターを使用した場合、またはパラメーターが規則に違反した場合 | パラメーター解析失敗 | Query パラメーターテーブルと例を確認してください。 |
| 500 | ft.InternalServerError | ストレージ、1 件ずつの送信後のキャッシュ失効、またはサイト通知の準備異常 | 内部エラー | まず type=grant リストを読み取り、どの項目がすでに削除されたかを確認してから、残りの対象に対して再試行してください。traceId を保持してください。 |