User domain
danger
ONES API 已废 弃。请使用Open API。
通用说明
用户域模型
| 参数名 | 是否必须 | 值类型 | 取值范围 | 说明 |
|---|---|---|---|---|
| user_domain_type | 是 | string | 下方说明 | 用户域类型 |
| user_domain_param | 是 | 下方说明 | 用户域参数 |
用户域取值范围
| type | param 值 | param 说明 |
|---|---|---|
| single_user | string | 用户 uuid |
| group | string | 用户组 uuid |
| department | string | 部门 uuid |
| everyone | 不需要 | 团队内所有用户 |
| task_watchers | 不需要 | 任务关注者 |
| project_administrators | 不需要 | 项目管理员，即拥有当前项目 manage_project 权限的人 |
| team_owner | 不需要 | 团队创建者 |
| role | string | 角色 uuid |
| task_owner | 不需要 | 任务创建者 |
| task_assign | 不需要 | 任务负责人 |
| testcase_administrators | 不需要 | testcase 管理员 |
| project_assign | 不需要 | 项目负责人 |
| testcase_plan_assign | 不需要 | |
| plan_administrators | 不需要 | plan 管理员 |
| program_assign | 不需要 | 项目集负责人 |
| program_role | string | 项目集角色 uuid |
用户组模型
| 参数名 | 值类型 | 允许空值 | 取值范围 | 说明 |
|---|---|---|---|---|
| uuid | string | F | len=8 | 用户组 uuid |
| name | string | T | len<=32 | 用户组名称 |
| desc | string | T | len<=? | 用户组描述 |
| members | array | T | 用户组中包含的用户 uuid 列表 |
API 说明
1. 创建用户组
创建一个用户组
URL
https://your-host-name/project/api/project/team/:teamUUID/usergroups/add
HTTP Method
POST
调用权限
administer_do
传值方式
JSON
参数列表
参考顶端的用户组模型，但不需要提供 uuid
返回参数列表
| 参数名 | 值类型 | 取值范围 | 说明 |
|---|---|---|---|
| uuid | string | len=8 | 用户组 uuid |
| name | string | len<=32 | 用户组名称 |
| desc | string | len<=? | 用户组描述 |
| server_update_stamp | int64 | 用户组信息更新时间戳 | |
| members | array | 用户组中包含的用户 uuid 列表 |
2. 修改用户组
修改一个用户组
URL
https://your-host-name/project/api/project/team/:teamUUID/usergroup/:usergroupUUID/update
HTTP Method
POST
调用权限
administer_do
传值方式
JSON
参数列表
参考顶端的用户组模型
返回参数列表
| 参数名 | 值类型 | 取值范围 | 说明 |
|---|---|---|---|
| uuid | string | len=8 | 用户组 uuid |
| name | string | len<=32 | 用户组名称 |
| desc | string | len<=? | 用户组描述 |
| server_update_stamp | int64 | 用户组信息更新时间戳 | |
| members | array | 用户组中包含的用户 uuid 列表 |
3. 删除用户组
删除一个用户组
URL
https://your-host-name/project/api/project/team/:teamUUID/usergroup/:usergroupUUID/delete
调用权限
administer_do
HTTP Method
POST
传值方式
JSON
参数列表
无
返回返回参数列表
| 参数名 | 值类型 | 取值范围 | 说明 |
|---|---|---|---|
| server_update_stamp | int64 | 用户组信息更新时间戳 |
4. 获取用户组列表
列出当前团队下的所有用户组
URL
https://your-host-name/project/api/project/team/:teamUUID/usergroups
HTTP Method
GET
调用权限
无
传值方式
URL
参数列表
无
返回参数列表
| 参数名 | 值类型 | 取值范围 | 说明 |
|---|---|---|---|
| groups | array | 用户组列表，参考顶端用户组 | |
| server_update_stamp | int64 | 用户组信息更新时间戳模型 |