2021/06/12

MANUAL

開発者向け機能:API:テーブル操作:添付ファイル取得

## 概要 APIを使用してユーザーのレコードを取得する事ができます。 ## 事前準備 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 - 添付ファイルのあるGuidを含むレコード情報が取得したい場合は以下のリンク先に従って取得してください。  [API機能:単一レコード取得](/manual/api-record-get) ## リクエスト ##### JSON ``` { "ApiVersion": 1.1, "ApiKey": "234S567dStfghjkA..." } ``` ## レスポンス ##### JSON ``` { "Id": 28, "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": "2020/10/20 10:20:22", "UpdatedTime": "2020/10/20 19:55:47" } } ``` - Idには取得したBinariesテーブルのレコードのIDが格納されます。 - StatusCodeには完了時のステータスコードが格納されます。正常終了時は200です。 - Messageには完了時のメッセージが格納されます。 - ReferenceIdにはファイルが紐づいているレコードのIDが格納されます。 - BinaryTypeには添付ファイルの場合Attachments、画像の場合Imagesが格納されます。 - Base64にはBase64にエンコードされたファイルの内容が格納されます。 - GuidにはファイルのGUIDが格納されます。 - FileNameにはファイル名が格納されます。 - Extensionには拡張子が格納されます。 - Sizeにはファイルサイズがバイト単位で格納されます。 - ContentTypeにはファイルのMimeTypeが格納されます。 - Creatorにはファイル作成者のユーザIDが格納されます。 - Updatorにはファイル更新者のユーザIDが格納されます。 - CreatedTimeにはファイル作成日時が格納されます。 - UpdatedTimeにはファイル更新日時が格納されます。 ## エラー時の確認事項 [・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'に変更されました。
このページをシェアする