システム設定API

ユーザ設定API

ユーザ設定APIのレスポンス

QuserEntryの構造

正常応答の例(1ユーザ)

 {"quser":{"email":"Sato@localhost.localdomain","id":0,"name":"佐藤"}}

正常応答の例(複数ユーザ)

 {"qusers":[
   {"email":"Sato@localhost.localdomain","id":0,"name":"佐藤"},
   {"email":"Suzuki@localhost.localdomain","id":1,"name":"鈴木"},
   {"email":"Takahashi@localhost.localdomain","id":2,"name":"高橋"},
   {"email":"Tanaka@localhost.localdomain","id":3,"name":"田中"},
   {"email":"Watanabe@localhost.localdomain","id":4,"name":"渡辺"},
   {"email":"Ito@localhost.localdomain","id":5,"name":"伊藤"},
   {"email":"Yamamoto@localhost.localdomain","id":6,"name":"山本"},
   {"email":"Nakamura@localhost.localdomain","id":7,"name":"中村"},
   {"email":"Kobayashi@localhost.localdomain","id":8,"name":"小林"},
   {"email":"Kato@localhost.localdomain","id":9,"name":"加藤"}
 ]}

ユーザ設定API詳細

ユーザを追加する: /API/UGA/Quser/add

リクエストパラメータ

レスポンス

ユーザ情報を取得する: /API/User/Quser/find

リクエストパラメータ

レスポンス

自身のユーザ情報を取得する: /API/User/Quser/self

リクエストパラメータ

• なし

レスポンス

ユーザ一覧を取得する: /API/User/Quser/list

リクエストパラメータ

レスポンス

ユーザ情報を更新する: /API/UGA/Quser/update

リクエストパラメータ

レスポンス

ユーザを削除する: /API/UGA/Quser/delete

リクエストパラメータ

レスポンス

• なし

発生する可能性のあるエラー

組織設定API

組織設定APIのレスポンス

QgroupEntryの構造

正常応答の例(1組織)

 {"qgroup":
   {"email":"accounting@localhost.localdomain","id":2,"name":"経理部",
    "parentQgroupEmail":"org@localhost.localdomain","parentQgroupId":1,"parentQgroupName":"全社"}
 }

正常応答の例(複数組織)

 {"qgroups":[
   {"email":"org@localhost.localdomain","id":1,"name":"全社",
    "parentQgroupEmail":null,"parentQgroupId":null,"parentQgroupName":null},
   {"email":"accounting@localhost.localdomain","id":2,"name":"経理部",
    "parentQgroupEmail":"org@localhost.localdomain","parentQgroupId":1,"parentQgroupName":"全社"},
   {"email":"sales@localhost.localdomain","id":3,"name":"営業部",
    "parentQgroupEmail":"org@localhost.localdomain","parentQgroupId":1,"parentQgroupName":"全社"},
   {"email":"marketing@localhost.localdomain","id":4,"name":"マーケティング部",
    "parentQgroupEmail":"org@localhost.localdomain","parentQgroupId":1,"parentQgroupName":"全社"},
   {"email":"production@localhost.localdomain","id":5,"name":"製造部",
    "parentQgroupEmail":"org@localhost.localdomain","parentQgroupId":1,"parentQgroupName":"全社"}
 ]}

組織設定API詳細

組織を追加する: /API/UGA/Qgroup/add

リクエストパラメータ

レスポンス

組織情報を取得する: /API/User/Qgroup/find

リクエストパラメータ

レスポンス

組織一覧を取得する: /API/User/Qgroup/list

リクエストパラメータ

レスポンス

組織情報を更新する: /API/UGA/Qgroup/update

リクエストパラメータ

レスポンス

組織を削除する: /API/UGA/Qgroup/delete

リクエストパラメータ

レスポンス

• なし

発生する可能性のあるエラー

メンバーシップ設定API

メンバーシップ設定APIのレスポンス

MembershipEntryの構造

正常応答の例(1メンバ)

 {"membership":
   {"qgroupEmail":"marketing@localhost.localdomain","qgroupId":4,"qgroupName":"マーケティング部",
    "quserEmail":"Ito@localhost.localdomain","quserId":5,"quserName":"伊藤","role":"_leader"}
 }

正常応答の例(複数メンバ)

 {"memberships":[
   {"qgroupEmail":"marketing@localhost.localdomain","qgroupId":4,"qgroupName":"マーケティング部",
    "quserEmail":"Ito@localhost.localdomain","quserId":5,"quserName":"伊藤","role":"_leader"},
   {"qgroupEmail":"marketing@localhost.localdomain","qgroupId":4,"qgroupName":"マーケティング部",
    "quserEmail":"Yamamoto@localhost.localdomain","quserId":6,"quserName":"山本","role":null},
   {"qgroupEmail":"marketing@localhost.localdomain","qgroupId":4,"qgroupName":"マーケティング部",
    "quserEmail":"Nakamura@localhost.localdomain","quserId":7,"quserName":"中村","role":null}
 ]}

メンバーシップ設定API詳細

組織にメンバを追加する: /API/UGA/Membership/add

リクエストパラメータ

レスポンス

組織に所属するメンバ一覧を取得する: /API/UGA/Membership/listByQgroup

リクエストパラメータ

レスポンス

メンバが所属する組織一覧を取得する: /API/UGA/Membership/listByQuser

レスポンス

組織のリーダ設定を更新する: /API/UGA/Membership/update

レスポンス

組織からメンバを外す: /API/UGA/Membership/delete

レスポンス

• なし

発生する可能性のあるエラー