グループAPI

グループ情報の取得、登録、更新、削除が行えます。

共通

認証

ユーザ認証が完了している必要があります。
グループの登録、更新、削除は以下の権限を持つユーザーである必要があります。

• SuperAdmin
• Admin

URL

http://{AppPot Server name}:{Port}/{Context root}/api/{companyId}/{appId}/{appVersion}/groups

groupオブジェクト

"group":
{
 "groupId":29,
 "groupName":"testGroup029",
 "description":"test group 029"
}

グループ情報の取得

グループ一覧を返却します。

URL

• GETメソッド

http://{AppPot Server name}:{Port}/{Context root}/api/{companyId}/{appId}/{appVersion}/groups

Header

なし

Request parameters

Name	Data Format	Description
Token	string	(Required) user token

Response example

{
    "errCode": 0,
    "status":"OK",
    "description":null,
    "groups":[
    {
        "groupId":1,
        "groupName":"Group 1",
        "description":"This is group 1"
     }
    ]
}

Response properties

Name	Data Format	Description
errCode	int	Response error code: 0, 105, 110, 120, 121
status	String	(Required) API result status value.
description	String	(Optional) Detail error
groups	String	(Optional) List group info if request paramters are valid.

グループ情報の新規追加

グループを新規追加します。

URL

• POSTメソッド

http://{AppPot Server name}:{Port}/{Context root}/api/{companyId}/{appId}/{appVersion}/groups

Header

• Content-Type: application/json
• apppot-token: token

Name	Data Format	Description
apppot-token	String	(Required) Login APIの結果得られたユーザートークン

Request parameters

Name	Data Format	Description
groupName	string	(Required) group name
description	string	description
isAddCurrentApp	boolean	trueの場合、現在ログインしているアプリにグループを紐付けます。falseの場合、アプリとの紐付けは行いません。このパラメタを省略した場合は、falseと同様の動きをします。

Request example

{
 "groupName":"testGroup029",
 "description":"test group 029",
 "isAddCurrentApp":true
}

Response example

{
 "errCode":0,
 "status":"OK",
 "description":null,
 "group":
 {
  "groupId":29,
  "groupName":"testGroup029",
  "description":"test group 029"
 }
}

Response properties

Name	Data Format	Description
errCode	int	Response error code: 0, 105, 110, 120, 121
status	String	(Required) API result status value.
description	String	(Optional) Detail error
group	String	(Optional) group info if request paramters are valid.

グループ情報の更新

指定したグループIDの情報を更新します。

URL

• PUTメソッド

http://{AppPot Server name}:{Port}/{Context root}/api/{companyId}/{appId}/{appVersion}/groups/{groupId}`

Header

• Content-Type: application/json
• apppot-token: token

Name	Data Format	Description
apppot-token	String	(Required) Login APIの結果得られたユーザートークン

Request parameters

Name	Data Format	Description
Token	string	(Required) user token
groupName	string	(Required) group name
description	string	description

Request example

{
 "token":"0ea2f1aa345f450eaeacea2e6507cf76",
 "groupName":"TESTGroup003",
 "description":"testgroup003"
}

Response example

{
 "errCode":0,
 "status":"OK",
 "description":null,
 "group":
 {
  "groupId":3,
  "groupName":"TESTGroup003",
  "description":"testgroup003"
 }
}

Response properties

Name	Data Format	Description
errCode	int	Response error code: 0, 105, 110, 120, 121
status	String	(Required) API result status value.
description	String	(Optional) Detail error
group	String	(Optional) group info if request paramters are valid.

グループ情報の削除

指定したグループIDの情報を削除します。

URL

• DELETEメソッド

http://{AppPot Server name}:{Port}/{Context root}/api/{companyId}/{appId}/{appVersion}/groups/{groupId}?token=XXX

Header

なし

Request parameters

Name	Data Format	Description
Token	string	(Required) user token

Response example

{
 "errCode":0,
 "status":"OK",
 "description":null
}

Response properties

Name	Data Format	Description
errCode	int	Response error code: 0, 105, 110, 120, 121
status	String	(Required) API result status value.
description	String	(Optional) Detail error