2021/06/12

MANUAL

開発者向け機能:API:テーブル操作:レコード更新

## 概要 APIを使用してレコードを更新する事ができます。 ## 事前準備 APIの操作を行う前に[APIキーの作成](/manual/api-key)を実施してください。 ## リクエスト 下記のリクエスト形式で、jsonデータを送信します。 |設定項目|値| |:--|:--| |HTTPメソッド|POST| |Content-Type |application/json| |文字コード|UTF-8| |URL|http://{サーバー名}/api/items/{レコードID}/update(※1)| |Body|以下のjsonデータを参考のこと| (※1){サーバー名}、{レコードID}の部分は、適宜、環境に合わせて編集してください。   pleasanter.netの場合は以下の形式になります。   https\://pleasanter.net/fs/api/items/{レコードID}/update ### (a)添付ファイルなし ClassやNum等の項目を設定する際は以下のように"{項目名}Hash"と記載してください。 ##### JSON ``` { "ApiVersion": 1.1, "ApiKey": "145Afa9AF2A10SafaA21641...", "Title": "新機能XXを開発する2", "Body": "ボディ2", "CompletionTime": "2018/3/31", "ClassHash": { "ClassA": "分類2", "ClassB": "未分類2", "ClassC": "その他2" }, "NumHash": { "NumA": 100, "NumB": 200 }, "DateHash": { "DateA": "2019/01/01", "DateB": "2020/01/01" }, "DescriptionHash": { "DescriptionA": "説明2", "DescriptionB": "概要2", "DescriptionC": "補足2" }, "CheckHash": { "CheckA": false, "CheckB": true } } ``` ### (b)添付ファイルあり 添付ファイルなしのjsonデータに下記のようなAttachmentsHashを追記してください。 ##### JSON ``` { "ApiVersion": 1.1, "ApiKey": "ad7816s5sD2safFafaD...", "Title": "新機能XXを開発する2", "Body": "ボディ2", "CompletionTime": "2018/3/31", "ClassHash": { "ClassA": "分類2", "ClassB": "未分類2", "ClassC": "その他2" }, "NumHash": { "NumA": 100, "NumB": 200 }, "DateHash": { "DateA": "2019/01/01", "DateB": "2020/01/01" }, "DescriptionHash": { "DescriptionA": "説明2", "DescriptionB": "概要2", "DescriptionC": "補足2" }, "CheckHash": { "CheckA": false, "CheckB": true }, "AttachmentsHash": { "AttachmentsA": [ { "ContentType": "text/plain", "Name": "Readme.txt", "Base64": "4O5O4jjfui…" } ] } } ``` ### (c)添付ファイル削除 AttachmentsA内のGuidにはファイルのGUIDを指定してください。 **添付ファイルを削除する場合、GUIDの指定は必ず大文字で記載してください。** また、AttachmentsA内のDeletedには1を指定してください。 ##### JSON ``` { "ApiVersion": 1.1, "ApiKey": "2bcb8a909da1d8827c99c…", "AttachmentsHash": { "AttachmentsA": [ { "Guid": "7AB84732…", "Deleted" : 1 } ] } } ``` ### Guidの取得方法 添付ファイルのあるレコードを以下のリンク先に従って取得します。 [API機能:単一レコード取得](/manual/api-record-get) 取得したjsonファイルの"Attachments"項目に添付ファイルのGuidが記載されているのでその値を使用してください。 ## レスポンス(添付ファイルあり、なし両方) 下記の形式のjsonデータが返却されます。 ##### JSON ``` { "Id": 12345, "StatusCode": 200, "LimitPerDate": 10000, "LimitRemaining": 9994, "Message": "\" 新機能XXを開発する2 \" を更新しました。" } ``` ## エラー時の確認事項 [・API使用時の注意点やエラーが発生する場合の確認事項](/manual/faq-api) [・FAQ:変更後の設定ファイルやAPIリクエスト(JSON形式)が正しく認識されない場合の確認事項](/manual/faq-json-format) ## 仕様変更について **※ 2019年10月よりAPIの仕様が一部変更となりました。** - 分類, 数値, 日付, 説明, チェック項目はjsonにそのまま記載する方法から「~Hash」の中に記載する方法へ変更されました。 **※ 2018年11月よりAPIの仕様が一部変更となりました。** - URLの形式が '/pleasanter/api_items/xxxx' から '/pleasanter/api/items/xxxx' に変更されました。 - Content-Type の指定が'application/x-www-form-urlencoded' から 'application/json'に変更されました。
このページをシェアする