コンテンツにスキップ

添付ファイル削除



POST /api/v1/attachment/delete

概要

現在のワークスペースの添付ファイルを削除済みとしてマークします。削除後、この識別子を使用して添付ファイルダウンロード API からファイルを取得することはできません。

呼び出し前の準備と使用手順

  1. 添付ファイルアップロードの成功レスポンスの content.attachmentUuid から値を取得します。
  2. 添付ファイル管理権限を持つワークスペースの API Key を使用します。この添付ファイルが不要になったことを確認したうえで、例に従って JSON を送信します。
  3. 削除済みの場合、または現在のワークスペースに一致するレコードがない場合も true を返します。同じ識別子を重複して送信しても、新しいレコードは作成されません。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y AK 識別子、AK uuid
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理で、この API の権限を持つ Key を取得します。

リクエストボディパラメータ

パラメータ名 型 必須 説明
attachmentUUID string Y 添付ファイル UUID
null を許可: False
例: att_00000000000000000000000000000000
取得または入力方法: 添付ファイルアップロードの成功レスポンスの content.attachmentUuid から値を取得します。

リクエスト例

curl 'https://openapi.guance.com/api/v1/attachment/delete' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"attachmentUUID":"att_00000000000000000000000000000000"}'

レスポンス

HTTP 200、application/json。

フィールド 型 説明
content boolean 処理が完了した場合は true です。現在のワークスペースに一致するレコードがない場合も含まれます。
{
    "code": 200,
    "content": true,
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

認証、レート制限、および共通リクエストエラーについては、共通エラー定義を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed JSON オブジェクトに必須の添付ファイル識別子がない、または型が一致しない メッセージに attachmentUUID またはその検証ルールが示されます。 フィールド名の大文字と小文字を確認し、文字列を渡してください。
400 ft.RequestJsonFormatError リクエスト JSON の構文エラー リクエスト JSON の形式エラーです。reason、line、column を返します。 位置に基づいて JSON を修正してください。

フィードバック

このページは役に立ちましたか?