Skip to content

Developer Function: API: Table Operation: Retrieve Multiple Records

Overview

The "API" retrieves multiple records for the specified site ID. For tables with "Site Integration", information about each integrated record is also retrieved. To retrieve a single record, use the "Record Retrieval API".

Preparation

  1. In order to use the "API", you need to create an "API Key". If you access from a logged-in browser session, you can use it without specifying an "API Key".

Request

Send JSON data in the following request format. The URL will differ depending on your environment, so please refer to "API URL" and change it as appropriate. Specify the "Filter" conditions and "Sort" of records in "JSON Data Layout: View". View is optional.

Setting column Value
HTTP Method POST
Content-Type application/json
Character code UTF-8
URL http://{server name}/api/items/{site ID}/get
Body Please refer to the json data below
JSON
{
     "ApiVersion": 1.1,
     "ApiKey": "63Kfk0ds3d4S2DBsa32..."
}

Response

JSON data in the following format will be returned. For the data layout in the response section, please refer to "JSON Data Layout: Item".
If you want to retrieve more than 200 records, please refer to FAQ: FAQ: I want to retrieve data exceeding 200 records via API.

JSON
{
    "StatusCode": 200,
    "Response": {
        "Offset": 0,
        "PageSize": 200,
        "TotalCount": 2,
        "Data": [
            {
                "SiteId": 6,
                "UpdatedTime": "2021-06-11T21:26:34",
                "ResultId": 335,
                "Ver": 2,
                "Title": "Web Database Development Co., Ltd.",
                "Body": "",
                "Status": 0,
                "Manager": 10,
                "Owner": 10,
                "Locked": false,
                "Comments": "[]",
                "Creator": 10,
                "Updator": 12,
                "CreatedTime": "2021-05-25T16:56:00",
                "ItemTitle": "Web Database Development Co., Ltd.",
                "ApiVersion": 1.1,
                "ClassHash": {
                    "ClassA": "Nerima Ward, Tokyo,
                    "ClassB": "789-789-789"
                },
                "NumHash": {},
                "DateHash": {},
                "DescriptionHash": {},
                "CheckHash": {},
                "AttachmentsHash": {
                    "AttachmentsA": []
                }
            },
            {
                "SiteId": 6,
                "UpdatedTime": "2021-06-09T21:23:00",
                "ResultId": 336,
                "Ver": 1,
                "Title": "Information Sharing Innovation Research Institute",
                "Body": "",
                "Status": 0,
                "Manager": 11,
                "Owner": 11,
                "Locked": false,
                "Comments": "[]",
                "Creator": 11,
                "Updator": 11,
                "CreatedTime": "2021-05-25T16:56:00",
                "ItemTitle": "Information Sharing Innovation Research Institute",
                "ApiVersion": 1.1,
                "ClassHash": {
                    "ClassA": "Shinjuku Ward, Tokyo",
                    "ClassB": "333-333-333"
                },
                "NumHash": {},
                "DateHash": {},
                "DescriptionHash": {},
                "CheckHash": {},
                "AttachmentsHash": {
                    "AttachmentsA": []
                }
            }
        ]
    }
}