2022-09-20
目录

模板

# 概述

模板

类名

TemplateApi.java

成员方法

名称 方法 Method Path
创建模板 addTemplate POST /api-business/template/addTemplate
复制模板 copyTemplate POST /api-business/template/copyTemplate
删除模板 deleteTemplate POST /api-business/template/deleteTemplate
获取关联关系 getProjectByTemplateId POST /api-business/template/getProjectByTemplateId
获取模板组态编辑主页url getTemplateConfigurationEditUrl POST /api-business/template/getTemplateConfigurationEditUrl
查询模板列表 getTemplateList POST /api-business/template/getTemplateList
获取模板组态主页url getTemplateMainConfigurationRuntimeUrl POST /api-business/template/getTemplateMainConfigurationRuntimeUrl
修改模板 updateTemplate POST /api-business/template/updateTemplate

# 创建模板

ResultObject addTemplate(id, name)

只可选自由项目进行创建 模板将会复制一份与之相同的变量信息等

# 请求参数

名称 类型 描述 备注
id String 项目Id
name String 模板名

# 返回参数

ResultObject

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

# java-sdk 调用示例

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

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

# HTTP 调用示例

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

请求参数：

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

# 复制模板

ResultObject copyTemplate(id, name)

根据传入的模板Id 复制一份相同的模板信息

# 请求参数

名称 类型 描述 备注
id String 模板Id
name String 模板名

# 返回参数

ResultObject

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

# java-sdk 调用示例

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

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

# HTTP 调用示例

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

请求参数：

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

# 删除模板

ResultObject deleteTemplate(id)

根据传入的模板Id 删除对应的模板信息

# 请求参数

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

# 返回参数

ResultObject

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

# java-sdk 调用示例

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

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

# HTTP 调用示例

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

请求参数：

{
	"id":""
}
1
2
3

# 获取关联关系

ResultListString getProjectByTemplateId(id)

根据模板Id 获取与之关联的项目ID

# 请求参数

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

# 返回参数

ResultListString

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

# java-sdk 调用示例

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

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

# HTTP 调用示例

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

请求参数：

{
	"id":""
}
1
2
3

# 获取模板组态编辑主页url

ResultString getTemplateConfigurationEditUrl(id)

获取模板组态编辑主页url

# 请求参数

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

# 返回参数

ResultString

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

# java-sdk 调用示例

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

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

# HTTP 调用示例

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

请求参数：

{
	"id":""
}
1
2
3

# 查询模板列表

ResultListTemplateVo getTemplateList()

获取当前登录用户下的所有模板列表

# 请求参数

请求参数为空.

# 返回参数

ResultListTemplateVo

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

TemplateVo

名称 类型 描述 备注
companyId String 企业Id -
createdTime OffsetDateTime 模板创建时间 用于排序 -
deviceFrom String 模板设备来源 0：内部的设备，1：第三方的设备 -
id String 模板Id -
name String 模板名称 -
remark String 模板备注 -

# java-sdk 调用示例

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

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

# HTTP 调用示例

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

请求参数：

{}
1

# 获取模板组态主页url

ResultString getTemplateMainConfigurationRuntimeUrl(id)

获取模板组态主页

# 请求参数

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

# 返回参数

ResultString

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

# java-sdk 调用示例

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

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

# HTTP 调用示例

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

请求参数：

{
	"id":""
}
1
2
3

# 修改模板

ResultObject updateTemplate(updateTemplateForm)

根据传入的 修改模板Form类 修改对应的模板信息

# 请求参数

名称 类型 描述 备注
updateTemplateForm UpdateTemplateForm updateTemplateForm

# UpdateTemplateForm

名称 类型 描述 备注
id String 模板Id
name String 模板名称
remark String 模板备注 -

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
TemplateApi apiInstance = new TemplateApi(token);
//实例化请求参数
UpdateTemplateForm updateTemplateForm = new UpdateTemplateForm();

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

# HTTP 调用示例

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

请求参数：

{
	"name":"",
	"remark":"",
	"id":""
}
1
2
3
4
5
变量
系统

← 系统→

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