システム設定API

ユーザ設定API

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

QuserEntryの構造

属性	型	説明
email	文字列	ユーザのe-mailアドレス
id	整数	ユーザのID
name	文字列	ユーザの名前
primaryQgroup	QgroupEntry	主として属する組織の情報 APIによっては、レスポンスされません。

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

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

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

 {
   "count":10,
   "qusers":[
     {
       "email":"Sato@localhost.localdomain",
       "id":0,
       "name":"佐藤"
     },
     {
       "email":"Suzuki@localhost.localdomain",
       "id":1,
       "name":"鈴木"
     },
     {
       "email":"Takahashi@localhost.localdomain",
       "id":2,
       "name":"高橋"
     }
   ]
 }

正常応答の例(primaryQgroupあり)

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

ユーザ設定API詳細

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

POST リクエストパラメータ

レスポンス

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

GET/POST リクエストパラメータ

レスポンス

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

GET/POST リクエストパラメータ

• なし

レスポンス

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

GET/POST リクエストパラメータ

レスポンス

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

POST リクエストパラメータ

レスポンス

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

POST リクエストパラメータ

レスポンス

• なし

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

組織設定API

組織設定APIのレスポンス

QgroupEntryの構造

正常応答の例(1組織)

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

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

 {
   "count":5,
   "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":"全社"
     }
   ]
 }

組織設定API詳細

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

POST リクエストパラメータ

レスポンス

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

GET/POST リクエストパラメータ

レスポンス

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

GET/POST リクエストパラメータ

レスポンス

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

POST リクエストパラメータ

レスポンス

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

POST リクエストパラメータ

レスポンス

• なし

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

メンバーシップ設定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

POST リクエストパラメータ

レスポンス

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

GET/POST リクエストパラメータ

レスポンス

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

GET/POST リクエストパラメータ

レスポンス

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

POST リクエストパラメータ

レスポンス

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

POST リクエストパラメータ

レスポンス

• なし

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

ロール設定API

ロール設定APIのレスポンス

QroleEntryの構造

正常応答の例(1ロール)

 {
   "qrole":{
     "id":32,
     "name":"ロールA"
   }
 }

正常応答の例(複数ロール)

 {
   "count":10,
   "qroles":[
     {
       "id":32,
       "name":"ロールA"
     },
     {
       "id":33,
       "name":"ロールB"
     },
     {
       "id":34,
       "name":"ロールC"
     }
   ]
 }

ロール設定API詳細

ロールを追加する: /API/UGA/Qrole/add

POST リクエストパラメータ

レスポンス

ロール情報を取得する: /API/User/Qrole/find

GET/POST リクエストパラメータ

レスポンス

ロール一覧を取得する: /API/User/Qrole/list

GET/POST リクエストパラメータ

レスポンス

ロールを更新する: /API/UGA/Qrole/update

POST リクエストパラメータ

レスポンス

ロールを削除する: /API/UGA/Qrole/delete

POST リクエストパラメータ

レスポンス

• なし

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

ロールメンバ設定API

ロールメンバ設定APIのレスポンス

RoleMembershipEntryの構造

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

 {
   "roleMembership":{
     "qroleId":1,
     "qroleName":"ロールA",
     "quserEmail":"Sato@localhost.localdomain",
     "quserId":0,
     "quserName":"佐藤"
   }
 }

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

 {
   "roleMemberships":[
     {
       "qroleId":1,
       "qroleName":"ロールA",
       "quserEmail":"Sato@localhost.localdomain",
       "quserId":0,
       "quserName":"佐藤"
     },
     {
       "qroleId":1,
       "qroleName":"ロールA",
       "quserEmail":"Suzuki@localhost.localdomain",
       "quserId":1,
       "quserName":"鈴木"
     }
   ]
 }

ロールメンバ設定API詳細

ロールにメンバを追加する: /API/UGA/RoleMembership/add

POST リクエストパラメータ

レスポンス

ロールからメンバを削除する: /API/UGA/RoleMembership/delete

POST リクエストパラメータ

レスポンス

• なし

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

ロールに所属するメンバ一覧を取得する: /API/User/RoleMembership/listByQrole

GET/POST リクエストパラメータ

レスポンス

ユーザの所属するロール一覧を取得する: /API/User/RoleMembership/listByQuser

GET/POST リクエストパラメータ

レスポンス

システム権限設定API

システム権限設定APIのレスポンス

SystemAuthorityEntryの構造

正常応答の例(1システム権限)

 {
   "systemAuthority":{
     "id":2,
     "type":1
     "quser":{
       "email":"Sato@localhost.localdomain",
       "id":0,
       "name":"佐藤"
     },
     "qgroup":null,
     "leader":null,
     "descendantQgroups":null,
     "qrole":null
   }
 }

正常応答の例(複数システム権限)

 {
   "systemAuthorities":[
     {
       "id":2,
       "type":1,
       "quser":{
         "email":"Sato@localhost.localdomain",
         "id":0,
         "name":"佐藤"
       },
       "qgroup":null,
       "leader":null,
       "descendantQgroups":null,
       "qrole":null
     },
     {
       "id":3,
       "type":1,
       "quser":{
         "email":"Takahashi@localhost.localdomain",
         "id":2,
         "name":"高橋"
       },
       "qgroup":null,
       "leader":null,
       "descendantQgroups":null,
       "qrole":null
     }
   ]
 }

システム権限設定API詳細

システム権限の一覧を取得する: /API/Admin/SystemAuthority/list

GET/POST リクエストパラメータ

レスポンス

自身のシステム権限を取得する: /API/User/SystemAuthority/self

GET/POST リクエストパラメータ

• なし

レスポンス

• systemAuthorities: システム権限の種別
  • 0: システム管理権限
  • 1: ユーザ管理権限
  • 2: アプリ作成権限


• 正常応答の例
  

  
   {
     "systemAuthorities":[
       0,
       1
     ]
   }
  		

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

• なし

ユーザにシステム権限を付与する: /API/Admin/SystemAuthority/addToQuser

POST リクエストパラメータ

レスポンス

組織にシステム権限を付与する: /API/Admin/SystemAuthority/addToQgroup

POST リクエストパラメータ

レスポンス

ロールにシステム権限を付与する: /API/Admin/SystemAuthority/addToQrole

POST リクエストパラメータ

レスポンス

システム権限を削除する: /API/Admin/SystemAuthority/delete

POST リクエストパラメータ

レスポンス

• なし

発生する可能性のあるエラー(レスポンスコード: 400)

アプリ権限設定API

アプリ権限設定APIのレスポンス

ProcessAuthorityEntryの構造

ProcessModelInfoEntryの構造

正常応答の例(1アプリ権限)

 {
   "ProcessAuthority":{
     "id":0,
     "type":0,
     "processModelInfo":{
       "id":1,
       "name":"Q001-企画書レビュー"
     },
     "quser":{
       "email":"Sato@localhost.localdomain",
       "id":0,
       "name":"佐藤"
     },
     "qgroup":null,
     "leader":null,
     "descendantQgroups":null,
     "qrole":null
   }
 }

正常応答の例(複数アプリ権限)

 {
   "processAuthorities":[
     {
       "id":0,
       "type":0,
       "processModelInfo":{
         "id":1,
         "name":"Q001-企画書レビュー"
       },
       "quser":{
         "email":"Sato@localhost.localdomain",
         "id":0,
         "name":"佐藤"
       },
       "qgroup":null,
       "leader":null,
       "descendantQgroups":null,
       "qrole":null
     },
     {
       "id":1,
       "type":0,
       "processModelInfo":{
         "id":1,
         "name":"Q001-企画書レビュー"
       },
       "quser":{
         "email":"Takahashi@localhost.localdomain",
         "id":2,
         "name":"高橋"
       },
       "qgroup":null,
       "leader":null,
       "descendantQgroups":null,
       "qrole":null
     }
   ]
 }

アプリ権限設定API詳細

アプリ権限の一覧を取得する: /API/Admin/ProcessAuthority/list

GET/POST リクエストパラメータ

レスポンス

ユーザにアプリ権限を付与する: /API/Admin/ProcessAuthority/addToQuser

POST リクエストパラメータ

レスポンス

組織にアプリ権限を付与する: /API/Admin/ProcessAuthority/addToQgroup

POST リクエストパラメータ

レスポンス

ロールにアプリ権限を付与する: /API/Admin/ProcessAuthority/addToQrole

POST リクエストパラメータ

レスポンス

アプリ権限を削除する: /API/Admin/ProcessAuthority/delete

POST リクエストパラメータ

レスポンス

• なし

発生する可能性のあるエラー(レスポンスコード: 400)