看板分组
# 概述
看板分组
类名
ProjectBoardGroupApi.java
成员方法
| 名称 | 方法 | Method | Path |
|---|---|---|---|
| 添加项目看板分组节点 | addProjectGroupNode | POST | /api-organization/projectBoardGroup/addProjectBoardGroupNode |
| 分组节点绑定项目 | addProjectGroupRel | POST | /api-organization/projectBoardGroup/addProjectGroupRel |
| 删除项目看板分组节点 | deleteProjectGroupNode | POST | /api-organization/projectBoardGroup/deleteProjectBoardGroupNode |
| 分组节点取消绑定项目 | deleteProjectGroupRel | POST | /api-organization/projectBoardGroup/deleteProjectGroupRel |
| 获取节点关联的项目信息 | getBindGroupProjectList | POST | /api-organization/projectBoardGroup/getBindGroupProjectList |
| 获取看板分组信息 | getProjectBoardTheRootNodeList | POST | /api-organization/projectBoardGroup/getProjectBoardTheRootNode |
| 获取指定节点信息 | getProjectGroupNodeList | POST | /api-organization/projectBoardGroup/getProjectBoardGroup |
| 获取可关联的项目 | getUnbindGroupProjectList | POST | /api-organization/projectBoardGroup/getUnbindGroupProjectList |
| 修改项目分组节点 | updateProjectGroup | POST | /api-organization/projectBoardGroup/updateProjectGroup |
# 添加项目看板分组节点
ResultObject addProjectGroupNode(addProjectBoardGroupNodeForm)
根据Form参数 添加分组节点
# 请求参数
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| addProjectBoardGroupNodeForm | AddProjectBoardGroupNodeForm | addProjectBoardGroupNodeForm |
# AddProjectBoardGroupNodeForm
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| name | String | 项目分组名称 | |
| parentId | String | 项目分组父节点ID [创建根节点:0, 创建子节点:上级节点Id] | - |
| projectBoardId | String | 所属项目看板Id | - |
| remark | String | 备注 | - |
| sort | Integer | 排序号 | - |
# 返回参数
ResultObject
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| code | String | 响应码 | - |
| data | Object | 响应数据 | - |
| msg | String | 响应消息 | - |
| time | OffsetDateTime | 响应时间 | - |
# java-sdk 调用示例
//实例化api类,传入token
ProjectBoardGroupApi apiInstance = new ProjectBoardGroupApi(token);
//实例化请求参数
AddProjectBoardGroupNodeForm addProjectBoardGroupNodeForm = new AddProjectBoardGroupNodeForm();
try {
ResultObject result = apiInstance.addProjectGroupNode(addProjectBoardGroupNodeForm);
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用ProjectBoardGroupApi.addProjectGroupNode异常: " + e.getMessage());
e.printStackTrace();
}
2
3
4
5
6
7
8
9
10
11
12
# HTTP 调用示例
| 属性 | 名称 |
|---|---|
| HTTP请求地址 | http://[server]:[port]/api-organization/projectBoardGroup/addProjectBoardGroupNode |
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization |
| header:value | Bearer YOUR_ACCESS_TOKEN |
请求参数:
{
"name":"",
"remark":"",
"sort":0,
"projectBoardId":"",
"parentId":""
}
2
3
4
5
6
7
# 分组节点绑定项目
ResultObject addProjectGroupRel(projectBoardGroupRelForm)
通过传入的节点Id 与N个项目Id 进行节点与项目的绑定
# 请求参数
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| projectBoardGroupRelForm | ProjectBoardGroupRelForm | projectBoardGroupRelForm |
# ProjectBoardGroupRelForm
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| nodeId | String | 项目看板分组节点Id | |
| projectIds | List<String> | N个项目Id |
# 返回参数
ResultObject
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| code | String | 响应码 | - |
| data | Object | 响应数据 | - |
| msg | String | 响应消息 | - |
| time | OffsetDateTime | 响应时间 | - |
# java-sdk 调用示例
//实例化api类,传入token
ProjectBoardGroupApi apiInstance = new ProjectBoardGroupApi(token);
//实例化请求参数
ProjectBoardGroupRelForm projectBoardGroupRelForm = new ProjectBoardGroupRelForm();
try {
ResultObject result = apiInstance.addProjectGroupRel(projectBoardGroupRelForm);
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用ProjectBoardGroupApi.addProjectGroupRel异常: " + e.getMessage());
e.printStackTrace();
}
2
3
4
5
6
7
8
9
10
11
12
# HTTP 调用示例
| 属性 | 名称 |
|---|---|
| HTTP请求地址 | http://[server]:[port]/api-organization/projectBoardGroup/addProjectGroupRel |
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization |
| header:value | Bearer YOUR_ACCESS_TOKEN |
请求参数:
{
"nodeId":""
}
2
3
# 删除项目看板分组节点
ResultObject deleteProjectGroupNode(id)
根据传入的节点Id 删除该节点以及对应的关联关系
# 请求参数
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| id | String | 看板分组Id | - |
# 返回参数
ResultObject
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| code | String | 响应码 | - |
| data | Object | 响应数据 | - |
| msg | String | 响应消息 | - |
| time | OffsetDateTime | 响应时间 | - |
# java-sdk 调用示例
//实例化api类,传入token
ProjectBoardGroupApi apiInstance = new ProjectBoardGroupApi(token);
//实例化请求参数
String id = "id_example";
try {
ResultObject result = apiInstance.deleteProjectGroupNode(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用ProjectBoardGroupApi.deleteProjectGroupNode异常: " + e.getMessage());
e.printStackTrace();
}
2
3
4
5
6
7
8
9
10
11
12
# HTTP 调用示例
| 属性 | 名称 |
|---|---|
| HTTP请求地址 | http://[server]:[port]/api-organization/projectBoardGroup/deleteProjectBoardGroupNode |
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization |
| header:value | Bearer YOUR_ACCESS_TOKEN |
请求参数:
{
"id":""
}
2
3
# 分组节点取消绑定项目
ResultObject deleteProjectGroupRel(projectBoardGroupRelForm)
根据节点Id 与N个项目Id 取消该节点与该项目的关联关系
# 请求参数
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| projectBoardGroupRelForm | ProjectBoardGroupRelForm | projectBoardGroupRelForm |
# ProjectBoardGroupRelForm
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| nodeId | String | 项目看板分组节点Id | |
| projectIds | List<String> | N个项目Id |
# 返回参数
ResultObject
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| code | String | 响应码 | - |
| data | Object | 响应数据 | - |
| msg | String | 响应消息 | - |
| time | OffsetDateTime | 响应时间 | - |
# java-sdk 调用示例
//实例化api类,传入token
ProjectBoardGroupApi apiInstance = new ProjectBoardGroupApi(token);
//实例化请求参数
ProjectBoardGroupRelForm projectBoardGroupRelForm = new ProjectBoardGroupRelForm();
try {
ResultObject result = apiInstance.deleteProjectGroupRel(projectBoardGroupRelForm);
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用ProjectBoardGroupApi.deleteProjectGroupRel异常: " + e.getMessage());
e.printStackTrace();
}
2
3
4
5
6
7
8
9
10
11
12
# HTTP 调用示例
| 属性 | 名称 |
|---|---|
| HTTP请求地址 | http://[server]:[port]/api-organization/projectBoardGroup/deleteProjectGroupRel |
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization |
| header:value | Bearer YOUR_ACCESS_TOKEN |
请求参数:
{
"nodeId":""
}
2
3
# 获取节点关联的项目信息
ResultProjectBoardGroupRelVo getBindGroupProjectList(id)
根据节点Id 查询对应的项目关联关系信息
# 请求参数
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| id | String | 看板分组节点Id |
# 返回参数
ResultProjectBoardGroupRelVo
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| code | String | 响应码 | - |
| data | ProjectBoardGroupRelVo | 响应数据 | - |
| msg | String | 响应消息 | - |
| time | OffsetDateTime | 响应时间 | - |
ProjectBoardGroupRelVo
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| project | List<ProjectBoardGroupRelevanceVo> | N个项目信息 | |
| projectGroupId | String | 项目看板分组节点ID |
ProjectBoardGroupRelevanceVo
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| projectId | String | 项目Id | - |
| projectName | String | 项目名称 | - |
# java-sdk 调用示例
//实例化api类,传入token
ProjectBoardGroupApi apiInstance = new ProjectBoardGroupApi(token);
//实例化请求参数
String id = "id_example";
try {
ResultProjectBoardGroupRelVo result = apiInstance.getBindGroupProjectList(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用ProjectBoardGroupApi.getBindGroupProjectList异常: " + e.getMessage());
e.printStackTrace();
}
2
3
4
5
6
7
8
9
10
11
12
# HTTP 调用示例
| 属性 | 名称 |
|---|---|
| HTTP请求地址 | http://[server]:[port]/api-organization/projectBoardGroup/getBindGroupProjectList |
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization |
| header:value | Bearer YOUR_ACCESS_TOKEN |
请求参数:
{
"id":""
}
2
3
# 获取看板分组信息
ResultListProjectBoardGroupNodeVo getProjectBoardTheRootNodeList(boardId)
根据传入的看板Id 查询看板分组
# 请求参数
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| boardId | String | 项目看板Id |
# 返回参数
ResultListProjectBoardGroupNodeVo
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| code | String | 响应码 | - |
| data | List<ProjectBoardGroupNodeVo> | 响应数据 | - |
| msg | String | 响应消息 | - |
| time | OffsetDateTime | 响应时间 | - |
ProjectBoardGroupNodeVo
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| children | List<ProjectBoardGroupNodeVo> | 项目看板分组子节点 | - |
| createdTime | OffsetDateTime | 创建时间 | - |
| id | String | 项目分组节点ID | - |
| label | String | 项目分组节点名称 | - |
| parentId | String | 项目分组父节点ID (根节点=0,子节点=父节点ID) | - |
| projectBoardId | String | 节点所属的项目看板ID | - |
| remark | String | 备注 | - |
| sort | Integer | 排序号 | - |
ProjectBoardGroupNodeVo
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| children | List<ProjectBoardGroupNodeVo> | 项目看板分组子节点 | - |
| createdTime | OffsetDateTime | 创建时间 | - |
| id | String | 项目分组节点ID | - |
| label | String | 项目分组节点名称 | - |
| parentId | String | 项目分组父节点ID (根节点=0,子节点=父节点ID) | - |
| projectBoardId | String | 节点所属的项目看板ID | - |
| remark | String | 备注 | - |
| sort | Integer | 排序号 | - |
# java-sdk 调用示例
//实例化api类,传入token
ProjectBoardGroupApi apiInstance = new ProjectBoardGroupApi(token);
//实例化请求参数
String boardId = "boardId_example";
try {
ResultListProjectBoardGroupNodeVo result = apiInstance.getProjectBoardTheRootNodeList(boardId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用ProjectBoardGroupApi.getProjectBoardTheRootNodeList异常: " + e.getMessage());
e.printStackTrace();
}
2
3
4
5
6
7
8
9
10
11
12
# HTTP 调用示例
| 属性 | 名称 |
|---|---|
| HTTP请求地址 | http://[server]:[port]/api-organization/projectBoardGroup/getProjectBoardTheRootNode |
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization |
| header:value | Bearer YOUR_ACCESS_TOKEN |
请求参数:
{
"boardId":""
}
2
3
# 获取指定节点信息
ResultListProjectBoardGroupNodeVo getProjectGroupNodeList(id)
根据分组节点Id 查询该节点的所有子节点信息
# 请求参数
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| id | String | 项目看板分组节点Id |
# 返回参数
ResultListProjectBoardGroupNodeVo
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| code | String | 响应码 | - |
| data | List<ProjectBoardGroupNodeVo> | 响应数据 | - |
| msg | String | 响应消息 | - |
| time | OffsetDateTime | 响应时间 | - |
ProjectBoardGroupNodeVo
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| children | List<ProjectBoardGroupNodeVo> | 项目看板分组子节点 | - |
| createdTime | OffsetDateTime | 创建时间 | - |
| id | String | 项目分组节点ID | - |
| label | String | 项目分组节点名称 | - |
| parentId | String | 项目分组父节点ID (根节点=0,子节点=父节点ID) | - |
| projectBoardId | String | 节点所属的项目看板ID | - |
| remark | String | 备注 | - |
| sort | Integer | 排序号 | - |
ProjectBoardGroupNodeVo
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| children | List<ProjectBoardGroupNodeVo> | 项目看板分组子节点 | - |
| createdTime | OffsetDateTime | 创建时间 | - |
| id | String | 项目分组节点ID | - |
| label | String | 项目分组节点名称 | - |
| parentId | String | 项目分组父节点ID (根节点=0,子节点=父节点ID) | - |
| projectBoardId | String | 节点所属的项目看板ID | - |
| remark | String | 备注 | - |
| sort | Integer | 排序号 | - |
# java-sdk 调用示例
//实例化api类,传入token
ProjectBoardGroupApi apiInstance = new ProjectBoardGroupApi(token);
//实例化请求参数
String id = "id_example";
try {
ResultListProjectBoardGroupNodeVo result = apiInstance.getProjectGroupNodeList(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用ProjectBoardGroupApi.getProjectGroupNodeList异常: " + e.getMessage());
e.printStackTrace();
}
2
3
4
5
6
7
8
9
10
11
12
# HTTP 调用示例
| 属性 | 名称 |
|---|---|
| HTTP请求地址 | http://[server]:[port]/api-organization/projectBoardGroup/getProjectBoardGroup |
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization |
| header:value | Bearer YOUR_ACCESS_TOKEN |
请求参数:
{
"id":""
}
2
3
# 获取可关联的项目
ResultListProjectBoardGroupRelevanceVo getUnbindGroupProjectList(groupBoardId)
根据传入的 看板分组Id 获取该节点可关联的项目信息
# 请求参数
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| groupBoardId | String | 看板分组Id |
# 返回参数
ResultListProjectBoardGroupRelevanceVo
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| code | String | 响应码 | - |
| data | List<ProjectBoardGroupRelevanceVo> | 响应数据 | - |
| msg | String | 响应消息 | - |
| time | OffsetDateTime | 响应时间 | - |
ProjectBoardGroupRelevanceVo
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| projectId | String | 项目Id | - |
| projectName | String | 项目名称 | - |
# java-sdk 调用示例
//实例化api类,传入token
ProjectBoardGroupApi apiInstance = new ProjectBoardGroupApi(token);
//实例化请求参数
String groupBoardId = "groupBoardId_example";
try {
ResultListProjectBoardGroupRelevanceVo result = apiInstance.getUnbindGroupProjectList(groupBoardId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用ProjectBoardGroupApi.getUnbindGroupProjectList异常: " + e.getMessage());
e.printStackTrace();
}
2
3
4
5
6
7
8
9
10
11
12
# HTTP 调用示例
| 属性 | 名称 |
|---|---|
| HTTP请求地址 | http://[server]:[port]/api-organization/projectBoardGroup/getUnbindGroupProjectList |
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization |
| header:value | Bearer YOUR_ACCESS_TOKEN |
请求参数:
{
"groupBoardId":""
}
2
3
# 修改项目分组节点
ResultObject updateProjectGroup(projectBoardGroupNodeForm)
根据Form参数 修改项目分组节点信息
# 请求参数
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| projectBoardGroupNodeForm | ProjectBoardGroupNodeForm | projectBoardGroupNodeForm |
# ProjectBoardGroupNodeForm
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| id | String | 项目分组节点ID | |
| name | String | 项目分组名称 | |
| remark | String | 备注 | - |
| sort | Integer | 排序号 | - |
# 返回参数
ResultObject
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| code | String | 响应码 | - |
| data | Object | 响应数据 | - |
| msg | String | 响应消息 | - |
| time | OffsetDateTime | 响应时间 | - |
# java-sdk 调用示例
//实例化api类,传入token
ProjectBoardGroupApi apiInstance = new ProjectBoardGroupApi(token);
//实例化请求参数
ProjectBoardGroupNodeForm projectBoardGroupNodeForm = new ProjectBoardGroupNodeForm();
try {
ResultObject result = apiInstance.updateProjectGroup(projectBoardGroupNodeForm);
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用ProjectBoardGroupApi.updateProjectGroup异常: " + e.getMessage());
e.printStackTrace();
}
2
3
4
5
6
7
8
9
10
11
12
# HTTP 调用示例
| 属性 | 名称 |
|---|---|
| HTTP请求地址 | http://[server]:[port]/api-organization/projectBoardGroup/updateProjectGroup |
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization |
| header:value | Bearer YOUR_ACCESS_TOKEN |
请求参数:
{
"name":"",
"remark":"",
"id":"",
"sort":0
}
2
3
4
5
6
