Docs Developers License

レコードを取得する

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

IDを指定してレコードを取得する

メソッド

GET

URI

[your kumaneko domain]/api/records.php

認証

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

Content-Type

application/json

パラメーター

パラメータ名	指定する値	説明
app	文字列	アプリID
id	文字列	レコードID

戻り値

レコードオブジェクト

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

関連ページ：: フィールド形式

サンプル

JavaScript

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

curl

curl -X GET '[your kumaneko domain]/api/records.php?app=1&id=1' \
	-H 'X-Authorization: L08xCvTh7A1EVm3rZimF98R8VLP3k4lMlzELqyCx'

クエリを指定してレコードを取得する

メソッド

GET

URI

[your kumaneko domain]/api/records.php

認証

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

Content-Type

application/json

パラメーター

パラメータ名	指定する値	説明
app	文字列	アプリID
query	文字列	レコードの条件を指定するクエリ文字列関連ページ：クエリ文字列を使用してレコードを取得する
offset	数値	スキップされるレコードの数初期値は「0」
limit	数値	取得するレコードの数条件に該当するすべてのレコードを取得したい場合は、limitパラメータを指定しないか、「0」を指定して下さい。

戻り値

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

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

関連ページ：: フィールド形式

サンプル

JavaScript

fetch('[your kumaneko domain]/api/records.php?app=1&query='+encodeURIComponent('field_1_ > 100 and field_2_ = TODAY()'), {
	method: 'GET',
	headers: {
		'X-Authorization': window.btoa(pd.kumaneko.users.login().account.value+':'+pd.kumaneko.users.login().pwd.value)
	}
})
.then(response => {
	response.json().then((json) => {
		switch (response.status)
		{
			case 200:
				console.log(json.records);
				break;
			default:
				console.error('Error:', json);
				break;
		}
	});
})
.catch(error => {
	console.error('Error:', error);
});

curl

curl -X GET '[your kumaneko domain]/api/records.php?app=1&query=field_1_%20%3E%20100%20and%20field_2_%20%3D%20TODAY()' \
	-H 'X-Authorization: L08xCvTh7A1EVm3rZimF98R8VLP3k4lMlzELqyCx'

次へ