返信の削除¶
DELETE /api/v1/issue/reply/{reply_uuid}/delete
概要¶
現在のワークスペース内の通常の返信を 1 件削除し、関連する添付ファイルと後続の通知を処理します。
呼び出し前の確認と使用手順¶
返信一覧から返信の UUID を取得し、確認してから DELETE を送信します。リクエストボディは不要です。成功すると返信レコードが削除済みとしてマークされ、関連する添付ファイルは削除フローに従ってクリーンアップされます。この API はワークスペースと返信レコードの状態に基づいて対象を特定し、実際の操作権限は API の権限によって制御されます。返信の変更とは異なり、creator が現在の呼び出し元と等しいことを追加で要求しません。重複削除は通常、リソースが存在しないことを返すため、先に現在の状態を確認してください。削除通知は、Issue に関連付けられたチャンネルの通知ポリシーとそのスケジュールに従って非同期で送信されます。通常のチャンネル購読、担当者、および今回の @ メンションは、削除通知の受信者に直接追加されません。成功しても通知が配信されたことを意味しません。書き込みと後続の通知、添付ファイルの処理は段階的に実行されます。失敗またはタイムアウト後は、まずリソースが作成または更新済みかどうかを照会してから再試行を決定し、レコードと通知の重複を避けてください。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| reply_uuid | string | Y | 単一の返信 UUID。Issue の UUID は使用しないでください。 例: repim_example取得方法または入力方法: 返信一覧の content.data[].uuid、または返信を作成の content.uuid から取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得方法または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
パラメータの補足説明¶
返信の削除は Issue の削除とは異なります。異常が返された場合は、まず返信がまだ存在するかを確認してから、再試行するかどうかを判断してください。
リクエスト例¶
curl --request DELETE 'https://openapi.guance.com/api/v1/issue/reply/repim_example/delete' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例では、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 削除処理が成功した場合は true を返します。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーの詳細は共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 404 | ft.ObjectNotExists | 指定されたリソースが現在のワークスペースに存在しない、または検索条件に一致しない | 指定されたオブジェクトが存在しません | 同じワークスペースのリソース UUID を再取得し、すでに削除されているか確認してください。 |
| 500 | ft.InternalServerError | レベルまたは設定の保存、監査、その他の内部処理に失敗 | 内部エラー | まず現在のレベルまたは設定を読み取って結果を確認してから、再試行するかどうかを判断してください。失敗が続く場合は traceId を提供してください。 |