操作文档
2022-09-20
目录

标签

# 概述

条件储存标签

类名

TagApi.java

成员方法

名称 方法 Method Path
添加条件储存标签 addConditionTag POST /api-business/conditionTag/addConditionTag
项目条件储存 绑定条件标签 addProjectConditionTagRel POST /api-business/conditionTag/addProjectConditionTagRel
项目变量绑定标签 addProjectVariantTagRel POST /api-business/variantTag/addProjectVariantTagRel
模板条件储存 绑定条件标签 addTemplateConditionTagRel POST /api-business/conditionTag/addTemplateConditionTagRel
模板变量绑定标签 addTemplateVariantTagRel POST /api-business/variantTag/addTemplateVariantTagRel
添加变量标签信息 addVariantTag POST /api-business/variantTag/addVariantTag
删除项目条件储存关联关系 delProjectConditionTagRel POST /api-business/conditionTag/delProjectConditionTagRel
删除模板条件储存关联关系 delTemplateConditionTagRel POST /api-business/conditionTag/delTemplateConditionTagRel
删除条件储存标签 deleteConditionTag POST /api-business/conditionTag/deleteConditionTag
删除变量标签信息 deleteVariantTagByTagId POST /api-business/variantTag/deleteVariantTagByTagId
获取条件储存标签信息 getConditionTagList POST /api-business/conditionTag/getConditionTagList
获取变量标签信息 getVariantTagList POST /api-business/variantTag/getVariantTagList
修改储存标签 updateConditionTag POST /api-business/conditionTag/updateConditionTag
修改变量标签信息 updateVariantTag POST /api-business/variantTag/updateVariantTag
修改变量标签指标类型 updateVariantTagIndexType POST /api-business/variantTag/updateVariantTagIndexType

# 添加条件储存标签

ResultObject addConditionTag(name, sort)

根据传入的信息 添加对应的 条件储存标签

# 请求参数

名称 类型 描述 备注
name String 标签名 -
sort Integer 排序号 -

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
TagApi apiInstance = new TagApi(token);
//实例化请求参数
String name = "name_example";
Integer sort = 56;

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

# HTTP 调用示例

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

请求参数：

{
	"name":"",
	"sort":0
}
1
2
3
4

# 项目条件储存 绑定条件标签

ResultObject addProjectConditionTagRel(projectConditionTagStorageRelForm)

# 请求参数

名称 类型 描述 备注
projectConditionTagStorageRelForm ProjectConditionTagStorageRelForm projectConditionTagStorageRelForm

# ProjectConditionTagStorageRelForm

名称 类型 描述 备注
id String 项目Id -
storageId String 条件储存Id -
tagId String 条件标签Id -

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
TagApi apiInstance = new TagApi(token);
//实例化请求参数
ProjectConditionTagStorageRelForm projectConditionTagStorageRelForm = new ProjectConditionTagStorageRelForm();

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

# HTTP 调用示例

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

请求参数：

{
	"id":"",
	"tagId":"",
	"storageId":""
}
1
2
3
4
5

# 项目变量绑定标签

ResultObject addProjectVariantTagRel(variantBindingTagForm)

根据传入的 Form类 项目变量绑定标签

# 请求参数

名称 类型 描述 备注
variantBindingTagForm VariantBindingTagForm variantBindingTagForm

# VariantBindingTagForm

名称 类型 描述 备注
deviceId String 设备Id -
resourceId String 项目/模板Id -
variantId Integer 变量Id -
variantTagId String 变量标签Id -

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
TagApi apiInstance = new TagApi(token);
//实例化请求参数
VariantBindingTagForm variantBindingTagForm = new VariantBindingTagForm();

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

# HTTP 调用示例

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

请求参数：

{
	"resourceId":"",
	"variantId":0,
	"deviceId":"",
	"variantTagId":""
}
1
2
3
4
5
6

# 模板条件储存 绑定条件标签

ResultObject addTemplateConditionTagRel(templateConditionTagStorageRelForm)

# 请求参数

名称 类型 描述 备注
templateConditionTagStorageRelForm TemplateConditionTagStorageRelForm templateConditionTagStorageRelForm

# TemplateConditionTagStorageRelForm

名称 类型 描述 备注
id String 模板Id -
storageId String 条件储存Id -
tagId String 条件标签Id -

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
TagApi apiInstance = new TagApi(token);
//实例化请求参数
TemplateConditionTagStorageRelForm templateConditionTagStorageRelForm = new TemplateConditionTagStorageRelForm();

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

# HTTP 调用示例

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

请求参数：

{
	"id":"",
	"tagId":"",
	"storageId":""
}
1
2
3
4
5

# 模板变量绑定标签

ResultObject addTemplateVariantTagRel(variantBindingTagForm)

根据传入的 Form类 模板变量绑定标签

# 请求参数

名称 类型 描述 备注
variantBindingTagForm VariantBindingTagForm variantBindingTagForm

# VariantBindingTagForm

名称 类型 描述 备注
deviceId String 设备Id -
resourceId String 项目/模板Id -
variantId Integer 变量Id -
variantTagId String 变量标签Id -

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
TagApi apiInstance = new TagApi(token);
//实例化请求参数
VariantBindingTagForm variantBindingTagForm = new VariantBindingTagForm();

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

# HTTP 调用示例

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

请求参数：

{
	"resourceId":"",
	"variantId":0,
	"deviceId":"",
	"variantTagId":""
}
1
2
3
4
5
6

# 添加变量标签信息

ResultObject addVariantTag(name, sort)

根据传入的参数 添加变量标签

# 请求参数

名称 类型 描述 备注
name String 标签名 -
sort Integer 排序号 -

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
TagApi apiInstance = new TagApi(token);
//实例化请求参数
String name = "name_example";
Integer sort = 56;

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

# HTTP 调用示例

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

请求参数：

{
	"name":"",
	"sort":0
}
1
2
3
4

# 删除项目条件储存关联关系

ResultObject delProjectConditionTagRel(projectConditionTagStorageRelForm)

根据传入的 条件储存以及条件标签Id 与项目Id 删除对应的关联关系信息

# 请求参数

名称 类型 描述 备注
projectConditionTagStorageRelForm ProjectConditionTagStorageRelForm projectConditionTagStorageRelForm

# ProjectConditionTagStorageRelForm

名称 类型 描述 备注
id String 项目Id -
storageId String 条件储存Id -
tagId String 条件标签Id -

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
TagApi apiInstance = new TagApi(token);
//实例化请求参数
ProjectConditionTagStorageRelForm projectConditionTagStorageRelForm = new ProjectConditionTagStorageRelForm();

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

# HTTP 调用示例

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

请求参数：

{
	"id":"",
	"tagId":"",
	"storageId":""
}
1
2
3
4
5

# 删除模板条件储存关联关系

ResultObject delTemplateConditionTagRel(templateConditionTagStorageRelForm)

根据传入的 条件储存以及条件标签Id 与模板Id 删除对应的关联关系信息

# 请求参数

名称 类型 描述 备注
templateConditionTagStorageRelForm TemplateConditionTagStorageRelForm templateConditionTagStorageRelForm

# TemplateConditionTagStorageRelForm

名称 类型 描述 备注
id String 模板Id -
storageId String 条件储存Id -
tagId String 条件标签Id -

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
TagApi apiInstance = new TagApi(token);
//实例化请求参数
TemplateConditionTagStorageRelForm templateConditionTagStorageRelForm = new TemplateConditionTagStorageRelForm();

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

# HTTP 调用示例

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

请求参数：

{
	"id":"",
	"tagId":"",
	"storageId":""
}
1
2
3
4
5

# 删除条件储存标签

ResultObject deleteConditionTag(id)

根据传入的 条件储存标签Id 删除对应的条件储存信息

# 请求参数

名称 类型 描述 备注
id String 标签Id -

# 返回参数

ResultObject

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

# java-sdk 调用示例

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

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

# HTTP 调用示例

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

请求参数：

{
	"id":""
}
1
2
3

# 删除变量标签信息

ResultObject deleteVariantTagByTagId(tagId)

根据传入的变量标签Id 删除对应的变量标签信息与关联关系

# 请求参数

名称 类型 描述 备注
tagId String 标签Id -

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
TagApi apiInstance = new TagApi(token);
//实例化请求参数
String tagId = "tagId_example";

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

# HTTP 调用示例

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

请求参数：

{
	"tagId":""
}
1
2
3

# 获取条件储存标签信息

ResultListConditionTagVo getConditionTagList(conditionStorageParam)

根据传入的查询参数信息 查询对应的(所有|或可用)条件储存信息

# 请求参数

名称 类型 描述 备注
conditionStorageParam ConditionStorageParam conditionStorageParam

# ConditionStorageParam

名称 类型 描述 备注
resourceId String 项目或模板Id -
resourceType String project: 项目, template: 模板 all: 企业 -

# 返回参数

ResultListConditionTagVo

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

ConditionTagVo

名称 类型 描述 备注
id String 条件标签id -
isBind Boolean 是否已被绑定 false = 已绑定 -
name String 条件标签名称 -
sort Integer 条件标签排序号 -

# java-sdk 调用示例

//实例化api类，传入token
TagApi apiInstance = new TagApi(token);
//实例化请求参数
ConditionStorageParam conditionStorageParam = new ConditionStorageParam();

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

# HTTP 调用示例

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

请求参数：

{
	"resourceId":"",
	"resourceType":""
}
1
2
3
4

# 获取变量标签信息

ResultListVariantTagVo getVariantTagList(resourceId, resourceType)

type [project， template， all] 除all外 传入对应type将查询 该type可绑定的标签信息

# 请求参数

名称 类型 描述 备注
resourceId String 与resourceType 与之对应 -
resourceType String [template: '模板', project: '项目', all: '企业] -

# 返回参数

ResultListVariantTagVo

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

VariantTagVo

名称 类型 描述 备注
id String 变量标签id -
indexType String 指标 -
isBind Boolean 是否已被绑定 -
name String 变量标签名称 -
sort Integer 排序号 -

# java-sdk 调用示例

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

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

# HTTP 调用示例

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

请求参数：

{
	"resourceId":"",
	"resourceType":""
}
1
2
3
4

# 修改储存标签

ResultObject updateConditionTag(updateConditionTagForm)

根据传入的 储存条件修改 对应的条件储存标签信息

# 请求参数

名称 类型 描述 备注
updateConditionTagForm UpdateConditionTagForm updateConditionTagForm

# UpdateConditionTagForm

名称 类型 描述 备注
id String 标签Id -
name String 标签名 -
sort Integer 排序号 -

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
TagApi apiInstance = new TagApi(token);
//实例化请求参数
UpdateConditionTagForm updateConditionTagForm = new UpdateConditionTagForm();

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

# HTTP 调用示例

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

请求参数：

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

# 修改变量标签信息

ResultObject updateVariantTag(updateVariantTagForm)

根据传入的标签Id 修改对应的标签信息

# 请求参数

名称 类型 描述 备注
updateVariantTagForm UpdateVariantTagForm updateVariantTagForm

# UpdateVariantTagForm

名称 类型 描述 备注
id String 变量标签Id -
name String 标签名 -
sort Integer 排序号 -

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
TagApi apiInstance = new TagApi(token);
//实例化请求参数
UpdateVariantTagForm updateVariantTagForm = new UpdateVariantTagForm();

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

# HTTP 调用示例

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

请求参数：

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

# 修改变量标签指标类型

ResultObject updateVariantTagIndexType(id, variantTagIndexType)

根据传入的标签Id 修改对应的变量指标信息

# 请求参数

名称 类型 描述 备注
id String 标签Id -
variantTagIndexType String 变量标签指标 -

# 返回参数

ResultObject

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

# java-sdk 调用示例

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

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

# HTTP 调用示例

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

请求参数：

{
	"variantTagIndexType":"",
	"id":""
}
1
2
3
4
报警
看板

← 看板→

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