レコードを削除する

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

IDを指定してレコードを削除する

メソッド

DELETE

URI

[your kumaneko domain]/api/records.php

認証

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

Content-Type

application/json

パラメーター

パラメータ名	指定する値	説明
app	文字列	アプリID
id	文字列	レコードID
notify	真偽値	処理完了後に各クライアントに向けて変更通知を行う場合は「true」を、変更通知を行わない場合は「false」指定します。パラメータを指定しなかった場合は「false」扱いになります。

戻り値

ありません。

サンプル

JavaScript

fetch('[your kumaneko domain]/api/records.php', {
	method: 'DELETE',
	headers: {
		'X-Authorization': window.btoa(pd.kumaneko.users.login().account.value+':'+pd.kumaneko.users.login().pwd.value)
	},
	body: JSON.stringify({
		app: '1',
		id: '1'
	})
})
.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 DELETE '[your kumaneko domain]/api/records.php?app=1&id=1' \
	-H 'X-Authorization: L08xCvTh7A1EVm3rZimF98R8VLP3k4lMlzELqyCx'

クエリを指定してレコードを削除する