## 概要 添付ファイル項目に添付したファイルや、内容や説明項目およびコメントに貼り付けた画像ファイルの情報を取得するAPIです。 ## 制限事項 1. このAPIではファイルの情報を取得します。実際のファイルを取得するためには変換処理（Base64デコード）を行ってください。変換処理は以下のFAQを参照してください。 [FAQ：サンプルコード：添付ファイルをダウンロードする](https://pleasanter.org/manual/faq-download-attachment) ## 事前準備 1. APIの操作を行う前に[APIキーの作成](/manual/api-key)を実施してください。 |設定項目|値| |:--|:--| |HTTPメソッド|POST| |Content-Type |application/json| |文字コード|UTF-8| |URL|http://{サーバー名}/api/binaries/{Guid}/get(※1)| |Body|以下のjsonデータを参考のこと| (※1) {サーバー名}、{Guid}の部分は、適宜、環境に合わせて編集してください。 pleasanter.netの場合は以下の形式になります。 https\://pleasanter.net/fs/api/binaries/{Guid}/get (※2) 添付ファイルのあるGuidを含むレコード情報が取得したい場合は以下のリンク先に従って取得してください。 [API機能：単一レコード取得](/manual/api-record-get) ## リクエスト ##### JSON ``` { "ApiVersion": 1.1, "ApiKey": "234S567dStfghjkA..." } ``` ## レスポンス 下記の形式のjsonデータが返却されます。 |取得項目|説明| |:--|:--| |Id|取得したBinariesテーブルのレコードのIDが格納されます。| |StatusCode|完了時のステータスコードが格納されます。正常終了時は200です。| |Message|完了時のメッセージが格納されます。| |ReferenceId|ファイルが紐づいているレコードのIDが格納されます。| |BinaryType|添付ファイルの場合Attachments、画像の場合Imagesが格納されます。| |Base64|Base64にエンコードされたファイルの内容が格納されます。実際のファイルを取得するにはこの値をBase64デコードしてください。| |Guid|ファイルのGUIDが格納されます。| |FileName|ファイル名が格納されます。| |Extension|拡張子が格納されます。| |Size|ファイルサイズがバイト単位で格納されます。| |ContentType|ファイルのMimeTypeが格納されます。| |Creator|ファイル作成者のユーザIDが格納されます。| |Updator|ファイル更新者のユーザIDが格納されます。| |CreatedTime|ファイル作成日時が格納されます。| |UpdatedTime|ファイル更新日時が格納されます。| ##### JSON ``` { "Id": 123, "StatusCode": 200, "Message": "Test用ファイルを取得しました。", "Response": { "ReferenceId": 30, "BinaryType": "Attachments", "Base64": "dGVzdA==...", "Guid": "5E23245...", "FileName": "テスト用ファイル", "Extension": ".txt", "Size": 54, "ContentType": "text/plain", "Creator": 1, "Updator": 1, "CreatedTime": "2023/08/16 12:00:00", "UpdatedTime": "2023/08/17 12:00:00" } } ``` ## エラー時の確認事項 [・API使用時の注意点やエラーが発生する場合の確認事項](/manual/faq-api) [・FAQ:変更後の設定ファイルやAPIリクエスト(JSON形式)が正しく認識されない場合の確認事項](/manual/faq-json-format) ## 仕様変更について **※ 2018年11月よりAPIの仕様が一部変更となりました。** - URLの形式が '/pleasanter/api_items/xxxx' から '/pleasanter/api/items/xxxx' に変更されました。 - Content-Type の指定が'application/x-www-form-urlencoded' から 'application/json'に変更されました。