User Manual

08.14.2024

MANUAL

Developer Function: API: Table Operation: Retrieve Multiple Records

## Overview The "[API](/ja/manual/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](/en/manual/api-record-get)". ## Preparation 1. In order to use the "[API](/ja/manual/api)", you need to create an "[API Key](/en/manual/api-key)". If you access from a logged-in browser session, you can use it without specifying an "[API Key](/en/manual/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](/en/manual/api-url)" and change it as appropriate. Specify the "[Filter](/en/manual/table-record-search)" conditions and "Sort" of records in "「JSON Data Layout: View」". View is optional. |Setting item|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](/en/manual/api-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](https://pleasanter.org/manual/faq-api-paging). ##### 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": [] } } ] } } ``` ## Related Information <div id="ManualList"><ul><li><a href="/en/manual/table-record-search">Table Function: Search for Record (Filter)</a><span>08.13.2024 up</span></li></ul></article> <ul><li><a href="/en/manual/api">Developer Function: API</a><span>08.14.2024 up</span></li> <li><a href="/en/manual/api-url">Developer Features: API: API URL</a><span>08.14.2024 up</span></li> <li><a href="/en/manual/api-key">Developer Function: API: Create an API Key</a><span>08.14.2024 up</span></li> <li><a href="/en/manual/api-record-get">Developer Function: API: Table Operation: Retrieve Single Record</a><span>08.14.2024 up</span></li></ul></article> <ul><li><a href="/en/manual/extended-sql-api">Developer Function: Extensions: Extended SQL: Executing Extended SQL from the API</a><span>08.14.2024 up</span></li></ul></article> <ul><li><a href="/en/manual/api-item">Developer Function: JSON Data Layout: Item</a><span>08.14.2024 up</span></li></ul></article> <ul><li><a href="/en/manual/faq-api-paging">FAQ: I want to retrieve data exceeding 200 records via API</a><span>08.14.2024 up</span></li> <li><a href="/en/manual/faq-api">FAQ: An error occurs when executing the API</a><span>08.14.2024 up</span></li> <li><a href="/en/manual/faq-json-format">FAQ: What to check if modified configuration files or API requests (JSON format) are not recognized correctly</a><span>08.14.2024 up</span></li></ul></article></div><input id="SearchTextHidden" type="hidden" value="" />
TOP
このページをシェアする
記載された商品名、各製品名は各社の登録商標または商標です。 © Implem Inc.