2022-09-20
目录

项目

# 概述

项目信息

类名

ProjectApi.java

成员方法

名称 方法 Method Path
添加项目 addProject POST /api-organization/project/addProject
添加项目属性 addProjectProperties POST /api-organization/projectProperties/addProjectProperties
添加枚举属性 addProjectPropertiesEnum POST /api-organization/projectProperties/addProjectPropertiesEnum
属性关联项目 addProjectPropertiesRel POST /api-organization/projectProperties/addProjectPropertiesRel
复制项目属性 copyProjectProperties POST /api-organization/projectProperties/copyProjectProperties
删除项目 deleteProject POST /api-organization/project/deleteProject
删除项目属性 deleteProjectProperties POST /api-organization/projectProperties/deleteProjectProperties
属性取消关联项目 deleteProjectPropertiesRel POST /api-organization/projectProperties/deleteProjectPropertiesRel
删除枚举属性 deletePropertiesEnum POST /api-organization/projectProperties/deletePropertiesEnum
获取当前用户拥有权限的项目列表 getAuthProjectList POST /api-organization/project/getAuthProjectList
根据用户id获取用户拥有权限的项目 getAuthProjectListByUserId POST /api-organization/project/getAuthProjectListByUserId
获取项目菜单的权限码 getPermissionCodeListByProjectId POST /api-organization/project/getPermissionCodeListByProjectId
获取app项目主页配置 getProjectAppMainMenu POST /api-organization/project/getProjectAppMainMenu
获取项目关注状态 getProjectAttentionStatusList POST /api-organization/project/getProjectAttentionStatusList
获取客户被授权的项目列表 getProjectAuthInfoListByClientId POST /api-organization/project/getProjectAuthInfoListByClientId
获取组态编辑URL getProjectConfigurationEditUrl POST /api-organization/project/getProjectConfigurationEditUrl
获取项目组态组态运行URL getProjectConfigurationRuntimeUrlList POST /api-organization/project/getProjectConfigurationRuntimeUrlList
查询项目信息列表 getProjectInfoList POST /api-business/projectInfo/getProjectInfoList
根据项目id获取项目列表 getProjectListByIds POST /api-organization/project/getProjectListByIds
查询属性 getProjectPropertiesList POST /api-organization/projectProperties/getProjectPropertiesList
查询项目属性关联项目的信息 getProjectPropertiesRelList POST /api-organization/projectProperties/getProjectPropertiesRelList
获取项目和项目属性值属性以及属性值之间的关系 getProjectPropertiesValueList POST /api-organization/project/getProjectPropertiesValueList
获取报表编辑URL getProjectReportEditUrl POST /api-organization/project/getProjectReportEditUrl
获取报表列表 getProjectReportList POST /api-organization/project/getProjectReportList
获取用户对项目变量的操作级别列表 getProjectRoleLevelList POST /api-organization/project/getProjectRoleLevelList
查询项目状态列表 getProjectStatusList POST /api-business/projectInfo/getProjectStatusList
根据看板id获取项目树结构数据 getProjectTreeList POST /api-organization/project/getProjectTreeList
查询枚举属性 getPropertiesEnumList POST /api-organization/projectProperties/getPropertiesEnumList
查询属性值信息 getPropertiesValueList POST /api-organization/projectProperties/getPropertiesValueList
获取系统项目列表 getSysProjectList POST /api-organization/project/getSysProjectList
修改项目关注状态 updateAttentionStatus POST /api-organization/project/updateAttentionStatus
修改枚举属性 updateEnumProperties POST /api-organization/projectProperties/updateEnumProperties
修改项目信息 updateProject POST /api-organization/project/updateProject
修改app项目主页配置 updateProjectAppMainMenu POST /api-organization/project/updateProjectAppMainMenu
修改项目定位信息 updateProjectInfo POST /api-business/projectInfo/updateProjectInfo
修改项目经纬度 updateProjectLonLat POST /api-organization/project/updateProjectLonLat
修改项目的权限组id updateProjectPermissionGroupId POST /api-organization/project/updateProjectPermissionGroupId
修改项目属性 updateProjectProperties POST /api-organization/projectProperties/updateProjectProperties
修改项目和项目属性值属性以及属性值之间的关系 updateProjectPropertiesValue POST /api-organization/project/updateProjectPropertiesValue

# 添加项目

ResultObject addProject(addProjectForm)

添加项目

# 请求参数

名称 类型 描述 备注
addProjectForm AddProjectForm addProjectForm

# AddProjectForm

名称 类型 描述 备注
createdType Integer 创建类型 0 自由项目，1 模板项目，2 复制项目
deviceFrom Integer 设备来源 0 内部设备 1 第三方设备
name String 项目名称
permissionGroupId String 项目权限组Id
remark String 备注 -
sort Integer 排序号 -
sourceId String 模板id或项目id -

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
AddProjectForm addProjectForm = new AddProjectForm();

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

# HTTP 调用示例

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

请求参数：

{
	"permissionGroupId":"",
	"sourceId":"",
	"name":"",
	"deviceFrom":0,
	"remark":"",
	"sort":0,
	"createdType":0
}
1
2
3
4
5
6
7
8
9

# 添加项目属性

ResultObject addProjectProperties(addProjectPropertiesForm)

新增项目属性 根据Form参数类 添加

# 请求参数

名称 类型 描述 备注
addProjectPropertiesForm AddProjectPropertiesForm addProjectPropertiesForm

# AddProjectPropertiesForm

名称 类型 描述 备注
format String 日期属性值 {只有是日期属性 该属性才会有值} -
name String 项目属性名称
remark String 属性备注 -
sort Integer 排序号 -
type String 属性值类型 = 0：枚举、1：文本、2：日期、3：数字

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
AddProjectPropertiesForm addProjectPropertiesForm = new AddProjectPropertiesForm();

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

# HTTP 调用示例

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

请求参数：

{
	"format":"",
	"name":"",
	"remark":"",
	"sort":0,
	"type":""
}
1
2
3
4
5
6
7

# 添加枚举属性

ResultObject addProjectPropertiesEnum(addProjectPropertiesEnums)

根据传入的Form类 新增枚举属性

# 请求参数

名称 类型 描述 备注
addProjectPropertiesEnums List<AddProjectPropertiesEnum> addProjectPropertiesEnums

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
List<AddProjectPropertiesEnum> addProjectPropertiesEnums = Arrays.asList(new AddProjectPropertiesEnum());

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

# HTTP 调用示例

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

请求参数：

{
	"addProjectPropertiesEnums":[
		{
			"propertiesId":"",
			"remark":"",
			"sort":0,
			"enumName":""
		}
	]
}
1
2
3
4
5
6
7
8
9
10

# 属性关联项目

ResultObject addProjectPropertiesRel(projectPropertiesRelParam)

项目属性关联项目 一个项目属性可同时关联多个项目

# 请求参数

名称 类型 描述 备注
projectPropertiesRelParam ProjectPropertiesRelParam projectPropertiesRelParam

# ProjectPropertiesRelParam

名称 类型 描述 备注
projectIds List<String> N个项目Id -
propertiesId String 属性Id -

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
ProjectPropertiesRelParam projectPropertiesRelParam = new ProjectPropertiesRelParam();

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

# HTTP 调用示例

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

请求参数：

{
	"propertiesId":""
}
1
2
3

# 复制项目属性

ResultObject copyProjectProperties(copyProjectPropertiesForm)

复制项目属性 将该属性的 枚举或关联关系复制

# 请求参数

名称 类型 描述 备注
copyProjectPropertiesForm CopyProjectPropertiesForm copyProjectPropertiesForm

# CopyProjectPropertiesForm

名称 类型 描述 备注
id String 目标属性Id -
name String 新属性名 -

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
CopyProjectPropertiesForm copyProjectPropertiesForm = new CopyProjectPropertiesForm();

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

# HTTP 调用示例

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

请求参数：

{
	"name":"",
	"id":""
}
1
2
3
4

# 删除项目

ResultObject deleteProject(projectId)

删除项目

# 请求参数

名称 类型 描述 备注
projectId String 项目的id

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
String projectId = "projectId_example";

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

# HTTP 调用示例

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

请求参数：

{
	"projectId":""
}
1
2
3

# 删除项目属性

ResultObject deleteProjectProperties(id)

删除项目属性 根据传入的属性Id 删除

# 请求参数

名称 类型 描述 备注
id String 属性Id -

# 返回参数

ResultObject

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

# java-sdk 调用示例

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

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

# HTTP 调用示例

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

请求参数：

{
	"id":""
}
1
2
3

# 属性取消关联项目

ResultObject deleteProjectPropertiesRel(projectPropertiesRelParam)

取消与项目的关联关系

# 请求参数

名称 类型 描述 备注
projectPropertiesRelParam ProjectPropertiesRelParam projectPropertiesRelParam

# ProjectPropertiesRelParam

名称 类型 描述 备注
projectIds List<String> N个项目Id -
propertiesId String 属性Id -

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
ProjectPropertiesRelParam projectPropertiesRelParam = new ProjectPropertiesRelParam();

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

# HTTP 调用示例

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

请求参数：

{
	"propertiesId":""
}
1
2
3

# 删除枚举属性

ResultObject deletePropertiesEnum(propertiesEnumId)

根据传入的 枚举属性Id 删除对应的枚举属性

# 请求参数

名称 类型 描述 备注
propertiesEnumId String 枚举属性Id -

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
String propertiesEnumId = "propertiesEnumId_example";

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

# HTTP 调用示例

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

请求参数：

{
	"propertiesEnumId":""
}
1
2
3

# 获取当前用户拥有权限的项目列表

ResultListProjectVo getAuthProjectList(param)

获取当前用户拥有权限的项目列表

# 请求参数

名称 类型 描述 备注
param QueryProjectListParam param

# QueryProjectListParam

名称 类型 描述 备注
alarmStatus String 报警状态：0未报警，1报警 -
area String 地区搜索，格式: 省、 省:市、 省:市:区 -
bindSerialNumber String 是否都绑定序列号：0未绑定，1已绑定 -
clientId String 客户id -
clientKeyword String 关键字:客户名称模糊搜索 -
isAttention String 项目关注状态：0未关注，1关注 -
keyword String 关键字:搜索项目名称 -
onlineStatus String 项目在线状态：0离线，1在线 -
permissionGroupId String 权限组id -
plcConnectionStatus String plc链接状态：0连接失败，1连接成功 -
projectType String 项目类型0：自由项目，1模板项目 -
propertiesId String 属性id -
propertiesValueId String 属性值id -
serialNumberKeyword String 关键字:设备序列号模糊搜索 -
templateId String 模板id -

# 返回参数

ResultListProjectVo

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

ProjectVo

名称 类型 描述 备注
authCompanyId String 授权企业id -
city String 市 -
country String 国家 -
createdTime OffsetDateTime 项目的创建时间 -
district String 区/县 -
id String 项目ID -
lat String 项目的纬度(地球经纬度) -
lon String 项目的经度(地球经纬度) -
name String 项目名称 -
permissionGroupId String 项目所在的权限组Id -
province String 省 -
remark String 项目备注 -
sort Integer 项目排序号 -

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
QueryProjectListParam param = new QueryProjectListParam();

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

# HTTP 调用示例

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

请求参数：

{
	"area":"",
	"bindSerialNumber":"",
	"permissionGroupId":"",
	"clientId":"",
	"plcConnectionStatus":"",
	"onlineStatus":"",
	"projectType":"",
	"templateId":"",
	"isAttention":"",
	"propertiesId":"",
	"alarmStatus":"",
	"propertiesValueId":"",
	"keyword":"",
	"serialNumberKeyword":"",
	"clientKeyword":""
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

# 根据用户id获取用户拥有权限的项目

ResultListProjectVo getAuthProjectListByUserId(userId)

根据用户id获取用户拥有权限的项目

# 请求参数

名称 类型 描述 备注
userId String 用户id

# 返回参数

ResultListProjectVo

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

ProjectVo

名称 类型 描述 备注
authCompanyId String 授权企业id -
city String 市 -
country String 国家 -
createdTime OffsetDateTime 项目的创建时间 -
district String 区/县 -
id String 项目ID -
lat String 项目的纬度(地球经纬度) -
lon String 项目的经度(地球经纬度) -
name String 项目名称 -
permissionGroupId String 项目所在的权限组Id -
province String 省 -
remark String 项目备注 -
sort Integer 项目排序号 -

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
String userId = "userId_example";

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

# HTTP 调用示例

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

请求参数：

{
	"userId":""
}
1
2
3

# 获取项目菜单的权限码

ResultListString getPermissionCodeListByProjectId(projectId)

获取项目菜单的权限码

# 请求参数

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

# 返回参数

ResultListString

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

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
String projectId = "projectId_example";

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

# HTTP 调用示例

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

请求参数：

{
	"projectId":""
}
1
2
3

# 获取app项目主页配置

ResultListAppMainMenu getProjectAppMainMenu(projectIds)

获取app项目主页配置

# 请求参数

名称 类型 描述 备注
projectIds List<String> 项目id

# 返回参数

ResultListAppMainMenu

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

AppMainMenu

名称 类型 描述 备注
mainMenu String 0：组态，1：详情，2：报表：3：视频，4：创建保修 -
projectId String 项目id -

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
List<String> projectIds = Arrays.asList(new List<String>());

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

# HTTP 调用示例

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

请求参数：

{
	"projectIds":[]
}
1
2
3

# 获取项目关注状态

ResultListAttentionStatusVo getProjectAttentionStatusList(projectIds)

获取项目关注状态

# 请求参数

名称 类型 描述 备注
projectIds List<String> projectIds -

# 返回参数

ResultListAttentionStatusVo

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

AttentionStatusVo

名称 类型 描述 备注
projectId String 项目id -
status String 关注状态，0：未关注，1：已关注 -

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
List<String> projectIds = Arrays.asList(new List<String>());

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

# HTTP 调用示例

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

请求参数：

{
	"projectIds":[]
}
1
2
3

# 获取客户被授权的项目列表

ResultListClientProjectInfoVo getProjectAuthInfoListByClientId(clientId, keyword)

通过客户企业id获取客户被授权的项目列表

# 请求参数

名称 类型 描述 备注
clientId String 客户企业id
keyword String 模糊搜索项目名称/角色名称 -

# 返回参数

ResultListClientProjectInfoVo

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

ClientProjectInfoVo

名称 类型 描述 备注
clientId String 客户的企业id -
companyId String 本企业id -
projectId String 项目id -
projectName String 项目名称 -
projectRelId String 项目角色关联关系的id -
projectRoleId String 项目授权的角色id -
roleName String 角色名称 -

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
String clientId = "clientId_example";
String keyword = "keyword_example";

try {
    ResultListClientProjectInfoVo result = apiInstance.getProjectAuthInfoListByClientId(clientId, keyword);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用ProjectApi.getProjectAuthInfoListByClientId异常: " + e.getMessage());
    e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10
11
12
13

# HTTP 调用示例

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

请求参数：

{
	"keyword":"",
	"clientId":""
}
1
2
3
4

# 获取组态编辑URL

ResultObject getProjectConfigurationEditUrl(projectId)

获取项目的组态编辑URL

# 请求参数

名称 类型 描述 备注
projectId String 项目id

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
String projectId = "projectId_example";

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

# HTTP 调用示例

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

请求参数：

{
	"projectId":""
}
1
2
3

# 获取项目组态组态运行URL

ResultListConfigurationRuntimeUrlVo getProjectConfigurationRuntimeUrlList(projectIds, type)

获取项目的组态运行URL

# 请求参数

名称 类型 描述 备注
projectIds List<String> 项目ids
type String 获取组态的类型，0：项目主页，1，移动端，2：集中监控 -

# 返回参数

ResultListConfigurationRuntimeUrlVo

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

ConfigurationRuntimeUrlVo

名称 类型 描述 备注
projectId String 项目id -
runtimeUrl String 项目运行态id -

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
List<String> projectIds = Arrays.asList(new List<String>());
String type = "type_example";

try {
    ResultListConfigurationRuntimeUrlVo result = apiInstance.getProjectConfigurationRuntimeUrlList(projectIds, type);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用ProjectApi.getProjectConfigurationRuntimeUrlList异常: " + e.getMessage());
    e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10
11
12
13

# HTTP 调用示例

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

请求参数：

{
	"type":"",
	"projectIds":[]
}
1
2
3
4

# 查询项目信息列表

ResultListProjectInfo getProjectInfoList(projectIds)

查询项目信息

# 请求参数

名称 类型 描述 备注
projectIds List<String> 项目id列表

# 返回参数

ResultListProjectInfo

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

ProjectInfo

名称 类型 描述 备注
deviceFrom String 设备来源； 0：内部的设备，1：第三方的设备 -
locationType Integer 定位方式（1：手动，2：基站定位，3：GPS定位，0：关闭） -
projectId String 项目ID -
projectType Integer 项目类型 0：自由项目，1：引用模板项目 -
templateId String 模板Id,自由项目为空 -
templateName String 模板名称,自由项目为空 -

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
List<String> projectIds = Arrays.asList(new List<String>());

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

# HTTP 调用示例

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

请求参数：

{
	"projectIds":[]
}
1
2
3

# 根据项目id获取项目列表

ResultListProjectVo getProjectListByIds(projectIds)

根据项目id获取项目列表

# 请求参数

名称 类型 描述 备注
projectIds List<String> 项目id

# 返回参数

ResultListProjectVo

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

ProjectVo

名称 类型 描述 备注
authCompanyId String 授权企业id -
city String 市 -
country String 国家 -
createdTime OffsetDateTime 项目的创建时间 -
district String 区/县 -
id String 项目ID -
lat String 项目的纬度(地球经纬度) -
lon String 项目的经度(地球经纬度) -
name String 项目名称 -
permissionGroupId String 项目所在的权限组Id -
province String 省 -
remark String 项目备注 -
sort Integer 项目排序号 -

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
List<String> projectIds = Arrays.asList(new List<String>());

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

# HTTP 调用示例

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

请求参数：

{
	"projectIds":[]
}
1
2
3

# 查询属性

ResultListProjectPropertiesVo getProjectPropertiesList(resourceType)

查询项目属性 根据当前登录用户企业下的所有项目属性信息

# 请求参数

名称 类型 描述 备注
resourceType String 查询类型 [0：枚举,1：文本、2：日期，3：数值], -

# 返回参数

ResultListProjectPropertiesVo

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

ProjectPropertiesVo

名称 类型 描述 备注
createdTime OffsetDateTime 创建时间 -
format String 0： 年，1：年月，2：年月日，3年月日时 -
id String 属性Id -
name String 属性名称 -
remark String 属性备注 -
sort Integer 属性排序号 -
type String 属性类型 [0：枚举、1：文本、2：日期、3：数字] -

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
String resourceType = "resourceType_example";

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

# HTTP 调用示例

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

请求参数：

{
	"resourceType":""
}
1
2
3

# 查询项目属性关联项目的信息

ResultListProjectPropertiesActionVo getProjectPropertiesRelList(propertiesId)

根据属性值Id 获取对应的关联的项目信息

# 请求参数

名称 类型 描述 备注
propertiesId String 属性值Id -

# 返回参数

ResultListProjectPropertiesActionVo

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

ProjectPropertiesActionVo

名称 类型 描述 备注
projectId String 项目Id -
projectName String 项目名 -
propertiesId String 属性Id -
propertiesName String 属性名 -
propertiesValue String 属性值 -

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
String propertiesId = "propertiesId_example";

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

# HTTP 调用示例

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

请求参数：

{
	"propertiesId":""
}
1
2
3

# 获取项目和项目属性值属性以及属性值之间的关系

ResultListProjectPropertiesValueVo getProjectPropertiesValueList(projectId)

获取项目和项目属性值属性以及属性值之间的关系

# 请求参数

名称 类型 描述 备注
projectId String 项目id

# 返回参数

ResultListProjectPropertiesValueVo

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

ProjectPropertiesValueVo

名称 类型 描述 备注
companyId String 企业id -
format String 时间格式 -
name String 属性名称 -
projectId String 项目id -
propertiesId String 属性id -
type String 属性类型 -
value String 属性值 -

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
String projectId = "projectId_example";

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

# HTTP 调用示例

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

请求参数：

{
	"projectId":""
}
1
2
3

# 获取报表编辑URL

ResultString getProjectReportEditUrl(projectId)

获取报表编辑URL

# 请求参数

名称 类型 描述 备注
projectId String 项目id

# 返回参数

ResultString

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

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
String projectId = "projectId_example";

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

# HTTP 调用示例

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

请求参数：

{
	"projectId":""
}
1
2
3

# 获取报表列表

ResultListReportBoardVo getProjectReportList(projectId, type)

获取项目的报表列表

# 请求参数

名称 类型 描述 备注
projectId String 项目id
type String 0:电脑端，1:移动端

# 返回参数

ResultListReportBoardVo

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

ReportBoardVo

名称 类型 描述 备注
id String 报表看板id -
name String 报表看板名称 -
url String 报表看板运行url -

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
String projectId = "projectId_example";
String type = "type_example";

try {
    ResultListReportBoardVo result = apiInstance.getProjectReportList(projectId, type);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用ProjectApi.getProjectReportList异常: " + e.getMessage());
    e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10
11
12
13

# HTTP 调用示例

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

请求参数：

{
	"type":"",
	"projectId":""
}
1
2
3
4

# 获取用户对项目变量的操作级别列表

ResultListString getProjectRoleLevelList(projectId)

获取用户对项目变量的操作级别列表

# 请求参数

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

# 返回参数

ResultListString

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

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
String projectId = "projectId_example";

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

# HTTP 调用示例

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

请求参数：

{
	"projectId":""
}
1
2
3

# 查询项目状态列表

ResultListProjectStatus getProjectStatusList(projectIds)

查询项目状态列表

# 请求参数

名称 类型 描述 备注
projectIds List<String> 项目id列表

# 返回参数

ResultListProjectStatus

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

ProjectStatus

名称 类型 描述 备注
alarmStatus String 报警状态：0:无报警，1：有报警 -
bindSerialNumber String 序列号状态： 0:部分设备未绑定序列号，1：所有设备均已绑定序列号 -
deviceStatus String 设备状态： 0:部分设备离线，1：全部在线 -
hasDevice String 项目有无设备：0:项目无设备，1：项目有设备 -
plcStatus String PLC状态 0:部分离线，1：全部在线 -
projectId String 项目id -
statusInfo Map<String, String> 同步状态： 0:不需要同步，1：需要同步 -
synchronizationStatus String 同步状态： 0:不需要同步，1：需要同步 -

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
List<String> projectIds = Arrays.asList(new List<String>());

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

# HTTP 调用示例

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

请求参数：

{
	"projectIds":[]
}
1
2
3

# 根据看板id获取项目树结构数据

ResultListTreeNodeVo getProjectTreeList(param)

根据看板id获取项目树结构数据

# 请求参数

名称 类型 描述 备注
param QueryProjectParam param

# QueryProjectParam

名称 类型 描述 备注
alarmStatus String 报警状态：0未报警，1报警 -
area String 地区搜索，格式: 省、 省:市、 省:市:区 -
bindSerialNumber String 是否都绑定序列号：0未绑定，1已绑定 -
boardId String 项目看板Id
clientId String 客户id -
isAttention String 项目关注状态：0未关注，1关注 -
keyword String 关键字:搜索项目名称/设备序列号/客户名称 -
onlineStatus String 项目在线状态：0离线，1在线 -
permissionGroupId String 权限组id -
plcConnectionStatus String plc链接状态：0连接失败，1连接成功 -
projectType String 项目类型0：自由项目，1模板项目 -
propertiesId String 属性id -
propertiesValue String 属性值id -
relType String 是否是本企业的项目0：自由项目，1：被授权项目 -
templateId String 模板id -

# 返回参数

ResultListTreeNodeVo

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

TreeNodeVo

名称 类型 描述 备注
children List<Object> 子节点 -
id String 节点唯一id -
isProject Boolean 是否为项目节点 -
name String 节点名称 -
sort Integer 排序号 -

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
QueryProjectParam param = new QueryProjectParam();

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

# HTTP 调用示例

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

请求参数：

{
	"area":"",
	"bindSerialNumber":"",
	"permissionGroupId":"",
	"clientId":"",
	"plcConnectionStatus":"",
	"onlineStatus":"",
	"projectType":"",
	"relType":"",
	"templateId":"",
	"propertiesValue":"",
	"isAttention":"",
	"propertiesId":"",
	"alarmStatus":"",
	"boardId":"",
	"keyword":""
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

# 查询枚举属性

ResultListPropertiesEnumVo getPropertiesEnumList(resourceId)

根据属性Id 或枚举属性Id 查询对应的 枚举

# 请求参数

名称 类型 描述 备注
resourceId String 属性Id/枚举Id -

# 返回参数

ResultListPropertiesEnumVo

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

PropertiesEnumVo

名称 类型 描述 备注
id String 枚举属性Id -
name String 枚举属性名称 -
propertiesId String 属性Id -
remark String 枚举属性备注 -
sort Integer 枚举属性排序号 -

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
String resourceId = "resourceId_example";

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

# HTTP 调用示例

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

请求参数：

{
	"resourceId":""
}
1
2
3

# 查询属性值信息

ResultListPropertiesValueVo getPropertiesValueList(propertiesId)

根据属性Id 以及查询类型 获取对应的属性值 （除枚举类外 其余属性必须与项目存在关联关系并存在值）

# 请求参数

名称 类型 描述 备注
propertiesId String 属性ID -

# 返回参数

ResultListPropertiesValueVo

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

PropertiesValueVo

名称 类型 描述 备注
projectId String 项目id -
propertiesId String 属性id -
propertiesValue String 属性值 -

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
String propertiesId = "propertiesId_example";

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

# HTTP 调用示例

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

请求参数：

{
	"propertiesId":""
}
1
2
3

# 获取系统项目列表

ResultListProjectVo getSysProjectList()

获取系统项目列表

# 请求参数

请求参数为空.

# 返回参数

ResultListProjectVo

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

ProjectVo

名称 类型 描述 备注
authCompanyId String 授权企业id -
city String 市 -
country String 国家 -
createdTime OffsetDateTime 项目的创建时间 -
district String 区/县 -
id String 项目ID -
lat String 项目的纬度(地球经纬度) -
lon String 项目的经度(地球经纬度) -
name String 项目名称 -
permissionGroupId String 项目所在的权限组Id -
province String 省 -
remark String 项目备注 -
sort Integer 项目排序号 -

# java-sdk 调用示例

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

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

# HTTP 调用示例

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

请求参数：

{}
1

# 修改项目关注状态

ResultObject updateAttentionStatus(value, projectIds)

修改项目关注状态

# 请求参数

名称 类型 描述 备注
value String 0:取消关注，1：关注
projectIds List<String> projectIds -

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
String value = "value_example";
List<String> projectIds = Arrays.asList(new List<String>());

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

# HTTP 调用示例

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

请求参数：

{
	"value":"",
	"projectIds":[]
}
1
2
3
4

# 修改枚举属性

ResultObject updateEnumProperties(updateEnumPropertiesForm)

根据传入的Form的 修改对应的枚举属性

# 请求参数

名称 类型 描述 备注
updateEnumPropertiesForm UpdateEnumPropertiesForm updateEnumPropertiesForm

# UpdateEnumPropertiesForm

名称 类型 描述 备注
id String 枚举属性值Id
name String 枚举属性值名称
remark String 枚举备注 -
sort Integer 排序号 -

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
UpdateEnumPropertiesForm updateEnumPropertiesForm = new UpdateEnumPropertiesForm();

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

# HTTP 调用示例

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

请求参数：

{
	"name":"",
	"remark":"",
	"id":"",
	"sort":0
}
1
2
3
4
5
6

# 修改项目信息

ResultObject updateProject(form)

修改项目信息(名称、备注、排序)

# 请求参数

名称 类型 描述 备注
form ProjectForm form

# ProjectForm

名称 类型 描述 备注
id String 项目ID -
name String 项目名称 -
remark String 项目备注 -
sort Integer 项目的排序号 -

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
ProjectForm form = new ProjectForm();

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

# HTTP 调用示例

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

请求参数：

{
	"name":"",
	"remark":"",
	"id":"",
	"sort":0
}
1
2
3
4
5
6

# 修改app项目主页配置

ResultObject updateProjectAppMainMenu(mainMenu, projectId)

修改app项目主页配置

# 请求参数

名称 类型 描述 备注
mainMenu String app主页,0：组态，1：详情，2：报表：3：视频，4：创建保修
projectId String 项目id

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
String mainMenu = "mainMenu_example";
String projectId = "projectId_example";

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

# HTTP 调用示例

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

请求参数：

{
	"mainMenu":"",
	"projectId":""
}
1
2
3
4

# 修改项目定位信息

ResultObject updateProjectInfo(form)

修改项目定位信息

# 请求参数

名称 类型 描述 备注
form ProjectInfoForm form

# ProjectInfoForm

名称 类型 描述 备注
locationType Integer 定位方式（1：手动，2：基站定位，3：GPS定位，0：关闭） -
projectId String 项目ID -

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
ProjectInfoForm form = new ProjectInfoForm();

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

# HTTP 调用示例

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

请求参数：

{
	"locationType":0,
	"projectId":""
}
1
2
3
4

# 修改项目经纬度

ResultObject updateProjectLonLat(form)

修改项目经纬度

# 请求参数

名称 类型 描述 备注
form ProjectLonLatForm form

# ProjectLonLatForm

名称 类型 描述 备注
lat String 项目的纬度(地球经纬度),为空时清除项目的经纬度 -
lon String 项目的经度(地球经纬度),为空时清除项目的经纬度 -
projectId String 项目ID

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
ProjectLonLatForm form = new ProjectLonLatForm();

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

# HTTP 调用示例

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

请求参数：

{
	"lon":"",
	"projectId":"",
	"lat":""
}
1
2
3
4
5

# 修改项目的权限组id

ResultObject updateProjectPermissionGroupId(permissionGroupId, projectId)

修改项目的权限组id

# 请求参数

名称 类型 描述 备注
permissionGroupId String 权限组id
projectId String 项目id

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
String permissionGroupId = "permissionGroupId_example";
String projectId = "projectId_example";

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

# HTTP 调用示例

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

请求参数：

{
	"permissionGroupId":"",
	"projectId":""
}
1
2
3
4

# 修改项目属性

ResultObject updateProjectProperties(updateProjectPropertiesForm)

修改项目属性 根据Form参数类

# 请求参数

名称 类型 描述 备注
updateProjectPropertiesForm UpdateProjectPropertiesForm updateProjectPropertiesForm

# UpdateProjectPropertiesForm

名称 类型 描述 备注
format String 日期属性内容 0： 年，1：年月，2：年月日，3年月日时 -
id String 项目属性ID
name String 项目属性名称 -
remark String 项目属性备注 -
sort Integer 项目属性排序号 -

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
UpdateProjectPropertiesForm updateProjectPropertiesForm = new UpdateProjectPropertiesForm();

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

# HTTP 调用示例

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

请求参数：

{
	"format":"",
	"name":"",
	"remark":"",
	"id":"",
	"sort":0
}
1
2
3
4
5
6
7

# 修改项目和项目属性值属性以及属性值之间的关系

ResultObject updateProjectPropertiesValue(form)

修改项目和项目属性值属性以及属性值之间的关系

# 请求参数

名称 类型 描述 备注
form UpdateProjectPropertiesValueForm form

# UpdateProjectPropertiesValueForm

名称 类型 描述 备注
projectId String 项目id -
propertiesId String 属性id -
value String 项目属性值 -

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
ProjectApi apiInstance = new ProjectApi(token);
//实例化请求参数
UpdateProjectPropertiesValueForm form = new UpdateProjectPropertiesValueForm();

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

# HTTP 调用示例

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

请求参数：

{
	"propertiesId":"",
	"projectId":"",
	"value":""
}
1
2
3
4
5
企业
设备

← 设备→

最近更新
01
OPC UA
 02-02
02
环保协议（HJ212）
 02-02
03
MQTT
 02-02
更多文章>
Copyright © 2021-2024