## 概要 APIを使用して添付ファイルをアップロードする事ができます。 ## 事前準備 APIの操作を行う前に[APIキーの作成](/manual/api-key)を実施してください。 |設定項目|値| |:--|:--| |HTTPメソッド|POST| |Content-Type |multipart/form-data; boundary={Boundary}(※1)| |Authorization |Bearer {ApiKey}| |URL|http://{サーバー名}/api/binaries/{Guid}/upload(※2)| |Body|以下のform-dataを参考のこと| |Query Params|以下のQuery Paramsを参考のこと| (※1){Boundary}は、任意の文字列を指定してください。 (※2){サーバー名}、{Guid}の部分は、適宜、環境に合わせて編集してください。 　　添付ファイルを新規登録する場合、{Guid}は省略可能です。 　　pleasanter.netの場合は以下の形式になります。 　　https\://pleasanter.net/fs/api/binaries/{Guid}/get ## リクエスト ##### form-data ``` --{Boundary} Content-Disposition: form-data; filename={FileName} Content-Type: {ContentType} {Data} --{Boundary}-- ``` |設定項目|値| |:--|:--| |{Boundary}|(※1)で記載した値を指定してください。| |{FileName}|アップロードするファイルパスを指定してください| |{ContentType}|アップロードするファイルのContentTypeを指定してください。| |{Data}|アップロードするファイルの内容を指定してください。| ##### Query Params |設定項目|値| |:--|:--| |overwrite|同名ファイルを上書きする場合は"1"を指定してください。| |verup|新バージョンとして保存する場合は"true"を指定してください。| |id|添付ファイルをアップロードするレコードIDを指定してください。(※2)で、{Guid}を省略する場合は必須。| ## レスポンス ##### JSON ※URLにGuidの指定あり ``` { "Id": 8406, "StatusCode": 200, "Message": "\" タイトル無し \" を更新しました。" } ``` ※URLにGuidの指定なし ``` { "Id": 8406, "StatusCode": 200, "Message": "D1D475DDBB674D999BB4CC733F5BDD73" } ``` - Idには取得したBinariesテーブルのレコードのIDが格納されます。 - StatusCodeには完了時のステータスコードが格納されます。正常終了時は200です。 - Messageには完了時のメッセージが格納されます。 リクエストURLにGuidを指定しない場合、Messageには新規作成されたGuidが格納されます。 ## エラー時の確認事項 [・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'に変更されました。