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}/create (※1)| |Body|以下のjsonデータを参考のこと| (※1){サーバー名}、{サイトID}の部分は、適宜、環境に合わせて編集してください。   pleasanter.netの場合は以下の形式になります。   https\://pleasanter.net/fs/api/items/{サイトID}/create ### (a)添付ファイルなし ##### JSON ``` { "ApiVersion": 1.1, "ApiKey": "XXXXXXXXXX...", "Title": "新機能XXを開発する", "Body": "ボディ", "CompletionTime": "2018/3/31", "ClassHash": { "ClassA": "分類", "ClassB": "未分類", "ClassC": "その他" }, "NumHash": { "NumA": 100, "NumB": 200 }, "DateHash": { "DateA": "2019/01/01", "DateB": "2020/01/01" }, "DescriptionHash": { "DescriptionA": "説明", "DescriptionB": "概要", "DescriptionC": "補足" }, "CheckHash": { "CheckA": true, "CheckB": false } } ``` ### (b)添付ファイルあり ##### JSON ``` { "ApiVersion": 1.1, "ApiKey": "XXXXXXXXXX...", "Title": "新機能XXを開発する", "CompletionTime": "2018/3/31", "ClassHash": { "ClassA": "分類", "ClassB": "未分類", "ClassC": "その他" }, "NumHash": { "NumA": 100, "NumB": 200 }, "DateHash": { "DateA": "2019/01/01", "DateB": "2020/01/01" }, "DescriptionHash": { "DescriptionA": "説明", "DescriptionB": "概要", "DescriptionC": "補足" }, "CheckHash": { "CheckA": true, "CheckB": false }, "AttachmentsHash": { "AttachmentsA": [ { "ContentType": "text/plain", "Name": "Readme.txt", "Base64": "5yY5Trfi4…" } ] } } ``` ## レスポンス(添付ファイルあり、なし両方) 下記の形式のjsonデータが返却されます。 ##### JSON ``` { "Id": 12345, "StatusCode": 200, "LimitPerDate": 10000, "LimitRemaining": 9996, "Message": "\" 新機能XXを開発する \" を作成しました。" } ``` ## エラー時の確認事項 [・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'に変更されました。
このページをシェアする