添付ファイルのダウンロード¶
GET /api/v1/attachment/{attachment_uuid}/download
概要¶
添付ファイル ID を使用して、現在のワークスペース内の元のファイルをダウンロードします。成功レスポンスにはファイルのバイナリデータが含まれます。
呼び出し前の準備と使用手順¶
- 添付ファイルのアップロードの成功レスポンスにある content.attachmentUuid から取得します。
- 読み取り権限を持つワークスペースの API Key を使用し、添付ファイル ID をリクエストパスに指定します。
- まず HTTP ステータスを確認します。200 の場合はレスポンスをファイルとして保存します。元のファイル名は Content-Disposition に記載されています。コマンドが失敗した場合は、まずステータスを確認してください。エラー JSON を確認する必要がある場合は、curl -i を使用して同じ添付ファイルパスにリクエストできます。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| attachment_uuid | string | Y | 添付ファイル ID null 許可: False 例: att_00000000000000000000000000000000取得または入力方法: 添付ファイルのアップロードの成功レスポンスにある content.attachmentUuid から取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | AK 識別子、AK uuid 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理で、この API の権限を持つ Key を取得します。 |
リクエスト例¶
curl --fail --dump-header response-headers.txt --output downloaded.bin 'https://openapi.guance.com/api/v1/attachment/att_00000000000000000000000000000000/download' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/octet-stream; charset=UTF-8。レスポンスボディは元のファイルのバイト列です。
| レスポンスヘッダー | 型 | 説明 |
|---|---|---|
| Content-Type | string | application/octet-stream; charset=UTF-8。 |
| Content-Disposition | string | attachment; filename=<URL エンコードされた元のファイル名>。 |
HTTP/1.1 200 OK
Content-Type: application/octet-stream; charset=UTF-8
Content-Disposition: attachment; filename=report.pdf
<ファイルのバイト列>
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては、共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 404 | ft.NotFoundAttachment | 添付ファイルが存在しない、削除済み、または現在のワークスペースに対応するレコードがない | 対応する添付ファイルリソース情報が見つかりません。 | 添付ファイル ID と API Key のワークスペースを確認し、必要に応じて再アップロードします。 |