## 概要 APIを使用してレコードを更新する事ができます。レコードの内容の変更に加え、[添付ファイル](/ja/manual/table-record-attachment-upload)の追加、削除や[レコードのアクセス制御](/ja/manual/table-record-access-control)の変更が可能です。 ## 制限事項 1. 対象の「レコード」に「更新」権限が必要です。 1. [レコードのアクセス制御](/ja/manual/table-record-access-control)を変更するには「権限の管理」権限が必要です。 1. レコードのアクセス制御の更新機能は、プリザンター 1.1.36.0 以降、プリザンター .NET Framweork版 0.50.260 以降のバージョンが必要です。 ## 事前準備 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 #### Insert Image by API You can insert an image into the "[Body](/en/manual/table-management-body)", "[Comment](/en/manual/table-management-comments)" and "[Description](/en/manual/table-management-column-description)" column by specifying an ImageHash in the Body. When updating a record using this function with an update API (update/upsert), the corresponding column of the existing record will be overwritten in the "[Body](/en/manual/table-management-body)" and "[Description](/en/manual/table-management-column-description)" columns, and added in the "[Comment](/en/manual/table-management-comments)" column. In addition, if you specify only ImageHash without specifying Body or DescriptionHash, which specify the string to be registered in the description field in an update API, it will be added rather than overwritten. ##### How to Specify ImageHash <style type="text/css"> .tg {border-collapse:collapse;border-spacing:0;} .tg td{border-color:black;border-style:solid;border-width:1px;font-family:Arial, sans-serif;font-size:14px; overflow:hidden;padding:10px 5px;word-break:normal;} .tg th{border-color:black;border-style:solid;border-width:1px;font-family:Arial, sans-serif;font-size:14px; font-weight:normal;overflow:hidden;padding:10px 5px;word-break:normal;} .tg .tg-0lax{text-align:left;vertical-align:top} </style> <table class="tg"> <thead> <tr> <th class="tg-0lax">1st Level</th> <th class="tg-0lax">2nd Level</th> <th class="tg-0lax">3rd Level</th> <th class="tg-0lax">Description</th> <th class="tg-0lax">Example</th> </tr> </thead> <tbody> <tr> <td class="tg-0lax" rowspan="9">ImageHash</td> <td class="tg-0lax" rowspan="6">Body</td> <td class="tg-0lax">HeadNewLine</td> <td class="tg-0lax">Specify whether to insert a newline at the beginning of the image with true/false. If omitted, there will be no newline.</td> <td class="tg-0lax">true</td> </tr> <tr> <td class="tg-0lax">EndNewLine</td> <td class="tg-0lax">Specifies whether to insert a newline at the end of the image with true/false. If omitted, there will be no newline.</td> <td class="tg-0lax">true</td> </tr> <tr> <td class="tg-0lax">Position</td> <td class="tg-0lax">Specifies the position of the image to insert when setting a string in the target item in the same request. If -1 is specified or omitted, it will be inserted at the end.</td> <td class="tg-0lax">3</td> </tr> <tr> <td class="tg-0lax">Alt</td> <td class="tg-0lax">Specifies the string to insert into the alt attribute (text displayed instead of the image when the image cannot be displayed in the web browser). If omitted, "image" will be set.</td> <td class="tg-0lax">hayato</td> </tr> <tr> <td class="tg-0lax">Extension</td> <td class="tg-0lax">Specifies the file extension to register in the Binaries table. If omitted, ".png" will be set.</td> <td class="tg-0lax">.jpeg</td> </tr> <tr> <td class="tg-0lax">Base64</td> <td class="tg-0lax">Specify the Base64 encoded binary data of the image as a string. If you specify ImageHash, this cannot be omitted.</td> <td class="tg-0lax">iVBORw0KG…（the following omitted）</td> </tr> <tr> <td class="tg-0lax">Comments</td> <td class="tg-0lax">（same as above）</td> <td class="tg-0lax">（same as above）</td> <td class="tg-0lax">-</td> </tr> <tr> <td class="tg-0lax">DescriptionA</td> <td class="tg-0lax">（same as above）</td> <td class="tg-0lax">（same as above）</td> <td class="tg-0lax">-</td> </tr> <tr> <td class="tg-0lax">DescriptionB</td> <td class="tg-0lax">（same as above）</td> <td class="tg-0lax">（same as above）</td> <td class="tg-0lax">-</td> </tr> </tbody> </table> #### APIによるプロセスの実行について リクエストデータに、プロセスIDを指定し、プロセスを実行することが可能です。 ##### 事前準備 事前に[プロセス](/ja/manual/process)を設定してください。 ##### 制限事項 APIからプロセスを実行する場合、プロセスで設定した入力検証は適用されません。 ##### プロセスの指定方法 |設定項目|説明|例| |:--|:--|:--| |ProccessId|プロセスのIDを指定します。|1| ### (a)通常の更新 ClassやNum等の項目を設定する際は以下のように"{項目名}Hash"と記載してください。 ##### JSON ``` { "ApiVersion": 1.1, "ApiKey": "ad7816s5sD2safFafaD...", "Title": "新機能XXを開発する2", "Body": "ボディ2", "CompletionTime": "2018/3/31", "ProcessId": 1, "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..." } ] }, "ImageHash": { "Body": { "HeadNewLine": true, "EndNewLine": true, "Position": 3, "Alt": "imageBody", "Extension": ".jpeg", "Base64": "iVBORw0KG…" }, "DescriptionA": { "HeadNewLine": true, "EndNewLine": true, "Position": 3, "Alt": "imageDescriptionA", "Extension": ".jpeg", "Base64": "iVBORw0KG..." } } } ``` (日付項目をNULLにするには[FAQ：APIで日付項目をNULLに設定したい](/manual/faq-api-set-date-to-null)を参照) ### (b)添付ファイル削除 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が記載されているのでその値を使用してください。 ### (c)レコードのアクセス制御の設定 レコードのアクセス制御を変更するにはRecordPermissionsを指定します。「権限の管理」権限を持ったApiKeyを指定する必要があります。下記の例では、組織ID:1に書き込み権限、グループID:1に管理権限、ユーザID:10に読み取り権限を付与しています。レコードのアクセス制御を指定すると、既存の設定を削除し、指定したものに置き換えます。追加や一部を削除することはできません。 ##### JSON ``` { "ApiVersion": 1.1, "ApiKey": "2bcb8a909da1d8827c99c...", "RecordPermissions": [ "Dept,1,31", "Group,1,511", "User,10,1" ] } ``` ### 権限の種類 権限の種類は下記のとおりです。与える権限の値の合計値を計算し設定してください。例えば読み取りと作成と更新を与えるには、1+2+4で7とします。すべての権限を与えるには511とします。 |No|権限|値| |:----|:----|:----| |1|読み取り|1| |2|作成|2| |3|更新|4| |4|削除|8| |5|メール送信|16| |6|エクスポート|32| |7|インポート|64| |8|サイトの管理|128| |9|権限の管理|256| ## レスポンス 下記の形式の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'に変更されました。