|
static const char * | DELETE (const char *collectionName, int id=-1) |
| コレクションまたはドキュメントを削除します。 [詳解]
|
|
static const char * | GET (const char *collectionName, int id) |
| ドキュメントを取得します。 [詳解]
|
|
static const char * | GET (const char *collectionName, int id, char *blob, int blobSize, int documentBlobOffset=0, int documentBlobLength=0) |
| ドキュメントを取得します。 [詳解]
|
|
static const char * | GET (const char *collectionName, const char *query=NULL) |
| ドキュメント ID を取得します。 [詳解]
|
|
static const char * | POST (const char *collectionName, const char *json=NULL) |
| コレクションまたはドキュメントを作成します。 [詳解]
|
|
static const char * | POST (const char *collectionName, const char *json, const char *blob, int blobLength) |
| コレクションまたはドキュメントを作成します。 [詳解]
|
|
static const char * | PUT (const char *collectionName, int id, const char *json) |
| ドキュメントを更新します。 [詳解]
|
|
static const char * | PUT (const char *collectionName, int id, const char *json, const char *blob, int blobLength) |
| ドキュメントを更新します。 [詳解]
|
|
BRestful クラス。
- 覚え書き
- このクラスは現在ベータ リリースです。使用法に関するフィードバックや改善のためのご提案を求めておりますので、 https://communities.actian.com/s/actian-zen までお送りください。
BRestful クラスは RESTful HTTP API 開発者を対象としています。そのため、HTTP メソッドのサブセットがサポートされています。これらのメソッドには DELETE、GET、POST、および PUT があります。
HTTP メソッド | BRestful メソッド | 説明 | 必須パラメーター | オプション パラメーター | 戻り値 |
DELETE | BRestful::DELETE | コレクションを削除します | コレクション名 | | ステータス |
DELETE | BRestful::DELETE | ドキュメントを削除します | コレクション名およびドキュメント ID | | ステータス |
GET | BRestful::GET | コレクションを照会します | コレクション名 | クエリ | ステータスおよびドキュメント ID の配列 |
GET | BRestful::GET | ドキュメントを取得します | コレクション名およびドキュメント ID | ユーザー BLOB バッファー | ステータス、ドキュメントの JSON、およびオプションのドキュメント BLOB |
POST | BRestful::POST | コレクションを作成します | コレクション名 | | ステータス |
POST | BRestful::POST | ドキュメントを作成します | コレクション名およびドキュメントの JSON コンテンツ | ドキュメントの BLOB コンテンツ | ステータスおよびドキュメント ID |
PUT | BRestful::PUT | ドキュメントを更新します | コレクション名およびドキュメント ID | ドキュメントの JSON および BLOB コンテンツ | ステータス |
すべてのメソッドは JSON を返します。 BtrieveCollection に挙げられている予約済み JSON フィールド名に加え、次の予約済み JSON フィールド名が定義されています。
フィールド名 | ユーザー設定可能 | 型 | 説明 |
_collectionName | いいえ | 文字列 | コレクション名 |
_ids | いいえ | 数値の配列 | ドキュメント ID の配列 |
_statusCode | いいえ | 数値 | ステータス コード |
_statusString | いいえ | 文字列 | ステータス文字列 |
BRestful::GET 、 BRestful::POST 、および BRestful::PUT では、ユーザー設定可能でない JSON フィールド名があっても通知されません。 BtrieveCollection と上に挙げた以外の予約済み JSON フィールド名を使用すると、エラーが発生します。
- 参照
- BtrieveCollection