レコード作成APIの機能仕様です。
APIを使用して新規にレコードを作成する事ができます。
■事前準備
APIの操作を行う前にAPIキーの作成を実施してください。
■URL
下記のURLを使用します。
{SiteId}はレコードを作成するテーブルのサイトIDに置換してください。
https://ks01.shelterdb.net/api/items/{SiteId}/create
■リクエスト(添付ファイルなし)
HTTP POSTで下記の形式のjsonデータを送信してください。
Content-Type は'application/json'、文字コードはUTF-8を使用してください。
登録するデータのレイアウトはこちらを参照してください。
{
"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
}
}
■リクエスト(添付ファイルあり)
HTTP POSTで下記の形式のjsonデータを送信してください。
Content-Type は'application/json'、文字コードはUTF-8を使用してください。
添付ファイルなしのjsonデータに下記のようなAttachmentsHashを追記してください。
{
"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データが返却されます。
{
"Id": 12345,
"StatusCode": 200,
"LimitPerDate": 10000,
"LimitRemaining": 9996,
"Message": "\" 新機能XXを開発する \" を作成しました。"
}
※"Message"
内の\
表記はバックスラッシュです。