操作文档
2022-09-20
目录

看板

# 概述

看板

类名

ProjectBoardApi.java

成员方法

名称 方法 Method Path
新增看板 addProjectBoard POST /api-organization/projectBoard/addProjectBoard
删除项目看板 deleteProjectBoard POST /api-organization/projectBoard/deleteProjectBoard
查询所有项目看板列表 getAllProjectBoardList POST /api-organization/projectBoard/getAllProjectBoardList
查询单条看板信息 getProjectBoard POST /api-organization/projectBoard/getProjectBoard
查询可用项目看板列表 getVisibleProjectBoardList POST /api-organization/projectBoard/getVisibleProjectBoardList
修改项目看板 updateProjectBoard POST /api-organization/projectBoard/updateProjectBoard

# 新增看板

ResultObject addProjectBoard(addProjectBoardForm)

根据传入的Form 添加看板信息

# 请求参数

名称 类型 描述 备注
addProjectBoardForm AddProjectBoardForm addProjectBoardForm

# AddProjectBoardForm

名称 类型 描述 备注
name String 项目看板名称 -
remark String 项目看板备注 -
sort Integer 项目看板序列号 -
structureType String 项目看板数据结构类型 [0:树结构, 1:过滤列表, 2:分组结构] -
useEnable Boolean 是否使用项目看板 [true：使用, false:不使用] -

# 返回参数

ResultObject

名称 类型 描述 备注
code String 响应码 -
data Object 响应数据 -
msg String 响应消息 -
time OffsetDateTime 响应时间 -

# java-sdk 调用示例

//实例化api类，传入token
ProjectBoardApi apiInstance = new ProjectBoardApi(token);
//实例化请求参数
AddProjectBoardForm addProjectBoardForm = new AddProjectBoardForm();

try {
    ResultObject result = apiInstance.addProjectBoard(addProjectBoardForm);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用ProjectBoardApi.addProjectBoard异常: " + e.getMessage());
    e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性 名称
HTTP请求地址 http://[server]:[port]/api-organization/projectBoard/addProjectBoard
请求方式 POST
Content-Type application/json
header:key Authorization
header:value Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"name":"",
	"remark":"",
	"sort":0,
	"structureType":"",
	"useEnable":false
}
1
2
3
4
5
6
7

# 删除项目看板

ResultObject deleteProjectBoard(id)

根据传入的看板Id 删除该看板下的所有信息

# 请求参数

名称 类型 描述 备注
id String 看板Id -

# 返回参数

ResultObject

名称 类型 描述 备注
code String 响应码 -
data Object 响应数据 -
msg String 响应消息 -
time OffsetDateTime 响应时间 -

# java-sdk 调用示例

//实例化api类，传入token
ProjectBoardApi apiInstance = new ProjectBoardApi(token);
//实例化请求参数
String id = "id_example";

try {
    ResultObject result = apiInstance.deleteProjectBoard(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用ProjectBoardApi.deleteProjectBoard异常: " + e.getMessage());
    e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性 名称
HTTP请求地址 http://[server]:[port]/api-organization/projectBoard/deleteProjectBoard
请求方式 POST
Content-Type application/json
header:key Authorization
header:value Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"id":""
}
1
2
3

# 查询所有项目看板列表

ResultListProjectBoardVo getAllProjectBoardList()

查询所有看板信息

# 请求参数

请求参数为空.

# 返回参数

ResultListProjectBoardVo

名称 类型 描述 备注
code String 响应码 -
data List<ProjectBoardVo> 响应数据 -
msg String 响应消息 -
time OffsetDateTime 响应时间 -

ProjectBoardVo

名称 类型 描述 备注
boardType String 项目看板类型 {0=系统 1=企业}
createdTime OffsetDateTime 项目看板创建时间 -
id String 项目看板ID -
name String 项目看板名称 -
phoneEnable Boolean 项目看板是否在移动端使用 {0=不使用 1= 使用}
remark String 项目看板备注 -
sort Integer 项目看板排序号 -
structureType String 项目看板数据结构类型 {0=树结构 1=列表
useEnable Boolean 项目看板是否使用 {0=不使用 1=使用}

# java-sdk 调用示例

//实例化api类，传入token
ProjectBoardApi apiInstance = new ProjectBoardApi(token);

try {
    ResultListProjectBoardVo result = apiInstance.getAllProjectBoardList();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用ProjectBoardApi.getAllProjectBoardList异常: " + e.getMessage());
    e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10

# HTTP 调用示例

属性 名称
HTTP请求地址 http://[server]:[port]/api-organization/projectBoard/getAllProjectBoardList
请求方式 POST
Content-Type application/json
header:key Authorization
header:value Bearer YOUR_ACCESS_TOKEN

请求参数：

{}
1

# 查询单条看板信息

ResultProjectBoard getProjectBoard(id)

查询单条看板信息

# 请求参数

名称 类型 描述 备注
id String id -

# 返回参数

ResultProjectBoard

名称 类型 描述 备注
code String 响应码 -
data ProjectBoard 响应数据 -
msg String 响应消息 -
time OffsetDateTime 响应时间 -

ProjectBoard

名称 类型 描述 备注
boardType String 项目看板类型 -
companyId String 项目看板所属企业ID -
createdBy String 项目看板创建人 -
createdTime OffsetDateTime 项目看板创建时间 -
id String 项目看板ID -
name String 项目看板名称 -
phoneEnable Boolean 项目看板是否移动端显示 -
remark String 项目看板备注 -
sort Integer 项目看板排序号 -
structureType String 项目看板结构类型 -
updatedTime OffsetDateTime 项目看板修改时间 -
useEnable Boolean 是否使用项目看板 -

# java-sdk 调用示例

//实例化api类，传入token
ProjectBoardApi apiInstance = new ProjectBoardApi(token);
//实例化请求参数
String id = "id_example";

try {
    ResultProjectBoard result = apiInstance.getProjectBoard(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用ProjectBoardApi.getProjectBoard异常: " + e.getMessage());
    e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性 名称
HTTP请求地址 http://[server]:[port]/api-organization/projectBoard/getProjectBoard
请求方式 POST
Content-Type application/json
header:key Authorization
header:value Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"id":""
}
1
2
3

# 查询可用项目看板列表

ResultListProjectBoardVo getVisibleProjectBoardList()

查询当前登录用户可见的的项目看板列表

# 请求参数

请求参数为空.

# 返回参数

ResultListProjectBoardVo

名称 类型 描述 备注
code String 响应码 -
data List<ProjectBoardVo> 响应数据 -
msg String 响应消息 -
time OffsetDateTime 响应时间 -

ProjectBoardVo

名称 类型 描述 备注
boardType String 项目看板类型 {0=系统 1=企业}
createdTime OffsetDateTime 项目看板创建时间 -
id String 项目看板ID -
name String 项目看板名称 -
phoneEnable Boolean 项目看板是否在移动端使用 {0=不使用 1= 使用}
remark String 项目看板备注 -
sort Integer 项目看板排序号 -
structureType String 项目看板数据结构类型 {0=树结构 1=列表
useEnable Boolean 项目看板是否使用 {0=不使用 1=使用}

# java-sdk 调用示例

//实例化api类，传入token
ProjectBoardApi apiInstance = new ProjectBoardApi(token);

try {
    ResultListProjectBoardVo result = apiInstance.getVisibleProjectBoardList();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用ProjectBoardApi.getVisibleProjectBoardList异常: " + e.getMessage());
    e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10

# HTTP 调用示例

属性 名称
HTTP请求地址 http://[server]:[port]/api-organization/projectBoard/getVisibleProjectBoardList
请求方式 POST
Content-Type application/json
header:key Authorization
header:value Bearer YOUR_ACCESS_TOKEN

请求参数：

{}
1

# 修改项目看板

ResultObject updateProjectBoard(updateProjectBoardForm)

只可修改 该看板的[名称, 是否使用, 排序号, 备注]

# 请求参数

名称 类型 描述 备注
updateProjectBoardForm UpdateProjectBoardForm updateProjectBoardForm

# UpdateProjectBoardForm

名称 类型 描述 备注
id String 项目看板Id
name String 项目看板名称
phoneEnable Boolean 是否在移动端使用项目看板 true:使用 false:不使用 -
remark String 项目看板备注 -
sort Integer 项目看板序列号 -
useEnable Boolean 是否使用项目看板 true:使用 false:不使用

# 返回参数

ResultObject

名称 类型 描述 备注
code String 响应码 -
data Object 响应数据 -
msg String 响应消息 -
time OffsetDateTime 响应时间 -

# java-sdk 调用示例

//实例化api类，传入token
ProjectBoardApi apiInstance = new ProjectBoardApi(token);
//实例化请求参数
UpdateProjectBoardForm updateProjectBoardForm = new UpdateProjectBoardForm();

try {
    ResultObject result = apiInstance.updateProjectBoard(updateProjectBoardForm);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用ProjectBoardApi.updateProjectBoard异常: " + e.getMessage());
    e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性 名称
HTTP请求地址 http://[server]:[port]/api-organization/projectBoard/updateProjectBoard
请求方式 POST
Content-Type application/json
header:key Authorization
header:value Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"phoneEnable":false,
	"useEnable":false,
	"name":"",
	"remark":"",
	"id":"",
	"sort":0
}
1
2
3
4
5
6
7
8
标签
看板分组

← 看板分组→

最近更新
01
菜单栏里找不到“BOX配置”如何处理
 06-06
02
购买了新型号的BOX，在配置软件里找不到该型号
 06-06
03
部分电脑安装BoxConfig后无法运行
 06-06
更多文章>
Copyright © 2021-2024