レコードを登録する

このページでは、レコードの登録に関するAPIを紹介します。

レコードを登録する

メソッド

POST

URI
[your kumaneko domain]/api/records.php
認証

リクエストヘッダに「X-Authorization」を追加し、「account:password」をBase64エンコードしたものを値に指定します。

Content-Type

application/json

パラメーター
パラメータ名 指定する値 説明
app 文字列

アプリID

records 配列

レコードオブジェクトの配列

レコードオブジェクトとは、フィールドコードとフィールドの値などのレコードの情報を含むオブジェクトです。

関連ページ:

フィールド形式

notify 真偽値

処理完了後に各クライアントに向けて変更通知を行う場合は「true」を、変更通知を行わない場合は「false」指定します。

パラメータを指定しなかった場合は「false」扱いになります。

戻り値

登録したレコードのうちの最後のレコードのレコードIDと、automenberフィールドの設定を元にした各レコードの採番結果データを持つオブジェクト

{
	id: 8,
	autonumbers: {
		6: 'PD_B00005',
		7: 'PD_B00006',
		8: 'PD_B00007'
	}
}
サンプル

JavaScript

fetch('[your kumaneko domain]/api/records.php', {
	method: 'POST',
	headers: {
		'X-Authorization': window.btoa(pd.kumaneko.users.login().account.value+':'+pd.kumaneko.users.login().pwd.value)
	},
	body: JSON.stringify({
		app: '1',
		records: [
			pd.kumaneko.record.get(APP_ID, event.container).record
		]
	})
})
.then(response => {
	response.json().then((json) => {
		switch (response.status)
		{
			case 200:
				console.log(json);
				break;
			default:
				console.error('Error:', json);
				break;
		}
	});
})
.catch(error => {
	console.error('Error:', error);
});

curl

curl -X POST '[your kumaneko domain]/api/records.php' \
	-H 'X-Authorization: L08xCvTh7A1EVm3rZimF98R8VLP3k4lMlzELqyCx' \
	-H 'Content-Type: application/json' \
	-d '{
		"app": "1",
		"records": [
			{
				"field_1_": {
					"value": "Sample"
				},
				"field_2_": {
					"value": 100
				}
			}
		]
	}'

ルックアップを自動取得する

lookupフィールドのlookupプロパティにtrueを入力すると、それらのlookupフィールドの取得を自動で行います。

lookupフィールドをクリアする場合は、valueプロパティを空値にした状態で、lookupプロパティにtrueを入力します。

サンプル
"field_10_": {
	"serach": "Sample",
	"value": 1,
	"lookup": true
}