設定情報を取得または変更する – cybozu developer network

設定情報を取得する

メッセージの設定をレスポンスとして返すAPIです。個人設定だけを取得するか、システム設定を含めて取得するかを指定できます。

API名

MessageGetProfiles

使用可能なガルーンのバージョン

クラウド版 Garoon
パッケージ版 Garoon バージョン 3.0.0以降

リクエスト

パラメーター名	型	パラメーター数	説明
include_system_profile	xsd:boolean	0 ～ 1	システム設定の取得 true：取得する false：取得しない

例

<parameters include_system_profile="true"></parameters>

レスポンス

パラメーター名	型	パラメーター数	説明
personal_profile	message:MessagePersonalProfileType	1	メッセージの個人設定
system_profile	message:MessageSystemProfileType	0 ～ 1	メッセージのシステム設定

例

<returns xmlns=""> 
  <personal_profile use_trash="true" trash_duration="5" /> 
  <system_profile check_send_confirm="false" confirm_action="Manual" /> 
</returns>

設定情報を変更する

個人設定をリクエストのパラメーターとして受け取り、個人設定を変更し、設定内容をレスポンスとして返す API です。

API名

MessageSetProfiles

使用可能なガルーンのバージョン

クラウド版 Garoon
パッケージ版 Garoon バージョン 3.0.0以降

リクエスト

パラメーター名	型	パラメーター数	説明
personal_profile	message:MessagePersonalProfileType	1	設定するメッセージの個人設定

例

<parameters> 
  <personal_profile use_trash="true" trash_duration="10"></personal_profile> 
</parameters>

レスポンス

パラメーター名	型	パラメーター数	説明
personal_profile	message:MessagePersonalProfileType	1	設定したメッセージの個人設定

例

<returns xmlns=""> 
  <personal_profile use_trash="true" trash_duration="10" /> 
</returns>

記事に関するフィードバック

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。