Group

[GET] /api/v1/groups

Get all groups.

Response

Status Code: 200

Success

[POST] /api/v1/groups

Add a new group.

Request Schema

AddGroupBizModel

Response

Status Code: 200

Success

[GET] /api/v1/groups/tree

Get the group tree.

Response

Status Code: 200

Success

[GET] /api/v1/groups/{id}

Get specified group's information.

Parameters

Name	Type	Located In	Description
idRequired	string	path

Response

Status Code: 200

Success

[DELETE] /api/v1/groups/{id}

Delete the specified group.

Parameters

Name	Type	Located In	Description
idRequired	string	path

Response

Status Code: 200

Success

[POST] /api/v1/groups/{id}/rename

Rename the specified group.

Parameters

Name	Type	Located In	Description
idRequired	string	path

Request Schema

RenameGroupBizModel

Response

Status Code: 200

Success

[POST] /api/v1/groups/{id}/move

Move the specified group.

Parameters

Name	Type	Located In	Description
idRequired	string	path

Request Schema

SetParentGroupBizModel

Response

Status Code: 200

Success

[GET] /api/v1/groups/{id}/users

Get the users who belongs to the specified group.

Parameters

Name	Type	Located In	Description
idRequired	string	path

Response

Status Code: 200

Success

[POST] /api/v1/groups/{id}/users

Add users to specified group.

Parameters

Name	Type	Located In	Description
idRequired	string	path

Request Schema

OperateGroupUsersBizModel

Response

Status Code: 200

Success

[PUT] /api/v1/groups/{id}/users

Update the users who belongs to the specified group.

Parameters

Name	Type	Located In	Description
idRequired	string	path

Request Schema

OperateGroupUsersBizModel

Response

Status Code: 200

Success

[DELETE] /api/v1/groups/{id}/users/{userId}

Remove the user from specified group.

Parameters

Name	Type	Located In	Description
idRequired	string	path
userIdRequired	string	path

Response

Status Code: 200

Success

[GET] /api/v1/groups/{userId}/paths

Get all the groups' paths which the specified user belongs to.

Parameters

Name	Type	Located In	Description
userIdRequired	string	path

Response

Status Code: 200

Success

Models

Ƭ AddGroupBizModel

Name	Type	Description	Example
nameNullable	string
parentGroupIdNullable	string

Ƭ RenameGroupBizModel

Name	Type	Description	Example
newNameNullable	string

Ƭ SetParentGroupBizModel

Name	Type	Description	Example
parentGroupIdNullable	string

Ƭ OperateGroupUsersBizModel

Name	Type	Description	Example
userIdsNullable	Array<string>