## 概要 APIを使用してグループのレコードを取得する事ができます。 ## 事前準備 APIの操作を行う前に[APIキーの作成](/manual/api-key)を実施してください。 ## リクエスト 下記のリクエスト形式で、jsonデータを送信します。 |設定項目|値| |:--|:--| |HTTPメソッド|POST| |Content-Type |application/json| |文字コード|UTF-8| |URL|http://{サーバー名}/api/groups/get (※1)| |Body|以下のjsonデータを参考のこと| (※1){サーバー名}の部分は、適宜、環境に合わせて編集してください。 　　pleasanter.netの場合は以下の形式になります。 　　https\://pleasanter.net/fs/api/groups/get ##### JSON ``` { "ApiVersion": 1.1, "ApiKey": "sad610bHDo04720DoloA356...", "View": { "ColumnFilterHash": { "GroupId": "[11,12]" } } } ``` GroupIdによるフィルタは、複数の値を指定可能な配列となっておりますので上記のように記述してください。 ## レスポンス 下記の形式のjsonデータが選択したGroupIdの数だけ返却されます。 データのレイアウトは[こちら](/manual/api-group)を参照してください。 ##### JSON ``` { "StatusCode": 200, "Response": { "Offset": 0, "PageSize": 200, "TotalCount": 2, "Data": [ { "TenantId": 1, "GroupId": 11, "Ver": 1, "GroupName": "グループA", "Body": "", "Disabled": false, "Comments": "[]", "Creator": 1, "Updator": 1, "CreatedTime": "2023-04-01T12:00:00", "UpdatedTime": "2023-08-15T12:00:00", "GroupMembers": [ "User,1,True", "User,2,False", "Dept,1,True" ], "GroupChildren": [ "Group,1," ], "ApiVersion": 1.1, "ClassHash": { }, "NumHash": { }, "DateHash": { }, "DescriptionHash": { }, "CheckHash": { }, "AttachmentsHash": { } } ] } } ``` ## エラー時の確認事項 [・API使用時の注意点やエラーが発生する場合の確認事項](/manual/faq-api) [・FAQ:変更後の設定ファイルやAPIリクエスト(JSON形式)が正しく認識されない場合の確認事項](/manual/faq-json-format) ## 仕様変更について **※ 2018年11月よりAPIの仕様が一部変更となりました。** - URLの形式が '/pleasanter/api_items/xxxx' から '/pleasanter/api/items/xxxx' に変更されました。 - Content-Type の指定が'application/x-www-form-urlencoded' から 'application/json'に変更されました。