レコード取得APIの機能仕様です。
APIを使用して条件に合致した複数のレコードを取得することができます。「サイト統合」を設定しているテーブルの場合は、統合された各レコードの情報もあわせて取得します。
単一のレコードを取得する場合には「単一レコード取得API」を使用してください。
■事前準備
APIの操作を行う前にAPIキーの作成を実施してください。
■リクエスト
下記のリクエスト形式で、jsonデータを送信します。レコードの「フィルタ」条件や「並べ替え」の指定は「JSONデータレイアウト：View」に指定してください。Viewは省略可能です。
＜設定項目＞
| 設定項目 | 値 |
|---|---|
| HTTPメソッド | POST |
| Content-Type | application/json |
| 文字コード | UTF-8 |
| URL | https://ks01.shelterdb.net/api/items/{SiteId}/get {SiteId}はレコードを取得するテーブルのサイトIDに置換してください。 |
| Body | 以下のjsonデータを参考のこと |
＜jsonデータ＞
{
"ApiVersion": 1.1,
"ApiKey": "345yuAjA6789dA09d8uj6...",
}
■レスポンス
下記の形式のjsonデータが条件に合致したレコードの数だけ返却されます。
Response部分のデータのレイアウトはこちらを参照してください。
{
"StatusCode": 200,
"Response": {
"Offset": 0,
"PageSize": 200,
"TotalCount": 2,
"Data": [
{
"SiteId": 6,
"UpdatedTime": "2021-06-11T21:26:34",
"ResultId": 335,
"Ver": 2,
"Title": "Webデータベース開発株式会社",
"Body": "",
"Status": 0,
"Manager": 10,
"Owner": 10,
"Locked": false,
"Comments": "[]",
"Creator": 10,
"Updator": 12,
"CreatedTime": "2021-05-25T16:56:00",
"ItemTitle": "Webデータベース開発株式会社",
"ApiVersion": 1.1,
"ClassHash": {
"ClassA": "東京都練馬区",
"ClassB": "789-789-789"
},
"NumHash": {},
"DateHash": {},
"DescriptionHash": {},
"CheckHash": {},
"AttachmentsHash": {
"AttachmentsA": []
}
},
{
"SiteId": 6,
"UpdatedTime": "2021-06-09T21:23:00",
"ResultId": 336,
"Ver": 1,
"Title": "情報共有イノベーション研究所",
"Body": "",
"Status": 0,
"Manager": 11,
"Owner": 11,
"Locked": false,
"Comments": "[]",
"Creator": 11,
"Updator": 11,
"CreatedTime": "2021-05-25T16:56:00",
"ItemTitle": "情報共有イノベーション研究所",
"ApiVersion": 1.1,
"ClassHash": {
"ClassA": "東京都新宿区",
"ClassB": "333-333-333"
},
"NumHash": {},
"DateHash": {},
"DescriptionHash": {},
"CheckHash": {},
"AttachmentsHash": {
"AttachmentsA": []
}
}
]
}
}