## 概要 APIを使用してグループを更新する事ができます。 ## 対応バージョン プリザンター 1.2.24.0以降 #### GroupMembers プリザンター 1.3.4.0 以降 ## 事前準備 APIの操作を行う前に[APIキーの作成](/manual/api-key)を実施してください。また、この機能はテナント管理者でないと行えないため、ユーザ管理からテナント管理者の設定を行ってください。 ## リクエスト 下記のリクエスト形式で、jsonデータを送信します。 |設定項目|値| |:--|:--| |HTTPメソッド|POST| |Content-Type |application/json| |文字コード|UTF-8| |URL|http://{サーバー名}/api/groups/{レコードId}/update(※1)| |Body|以下のjsonデータを参考のこと| (※1){サーバー名}、{レコードId}の部分は、適宜、環境に合わせて編集してください。 　　pleasanter.netの場合は以下の形式になります。 　　https\://pleasanter.net/fs/api/groups/{レコードId}/update ##### JSON ``` { "ApiVersion": 1.1, "ApiKey": "026dfsS19fds1y7ayR1R5b67..", "GroupName": "[更新後のグループの名前]", "Body": "APIによるグループ更新サンプルです。", "GroupMembers": [ "User,1,True", "Dept,1,False" ], "GroupChildren": [ "Group,1," ] } ``` #### GroupMembersについて 1. カンマ区切りにてグループメンバーとするユーザ、組織の情報を配列で指定します。 1. グループメンバーの更新は洗い替えで行われます。新規追加するグループメンバーと、所属を変更しないグループメンバーの情報をすべて配列に記述してください。 |カラム|設定例|設定内容| |:--|:--|:--| |1カラム目|User|ユーザを登録する場合は'User'、組織を登録する場合は'Dept'を指定します。| |2カラム目|1|ユーザ・組織のIDを指定します。| |3カラム目|True|管理者権限を付与する場合Trueを設定、付与しない場合はFalseを設定します。| #### GroupChildrenについて 1. カンマ区切りにて子グループに追加するグループの情報を配列で指定します。 1. 子グループの更新は洗い替えで行われます。新規追加するグループと、変更しないグループの情報をすべて配列に記述してください。 |カラム|設定内容| |:--|:--| |1カラム目|'Group'固定。| |2カラム目|グループのIDを指定します。| |3カラム目|ブランク固定。| ## レスポンス 下記の形式のjsonデータが返却されます。 ##### JSON ``` { "Id": 12345, "StatusCode": 200, "Message": "\" 新しいグループの名前 \" を更新しました。" } ``` ## エラー時の確認事項 [・API使用時の注意点やエラーが発生する場合の確認事項](/manual/faq-api) [・FAQ:変更後の設定ファイルやAPIリクエスト(JSON形式)が正しく認識されない場合の確認事項](/manual/faq-json-format) ## 仕様変更について **※ 2019年10月よりAPIの仕様が一部変更となりました。** - 分類, 数値, 日付, 説明, チェック項目はjsonにそのまま記載する方法から「～Hash」の中に記載する方法へ変更されました。 **※ 2018年11月よりAPIの仕様が一部変更となりました。** - URLの形式が '/pleasanter/api_items/xxxx' から '/pleasanter/api/items/xxxx' に変更されました。 - Content-Type の指定が'application/x-www-form-urlencoded' から 'application/json'に変更されました。