变量收藏
## 概述
> 变量收藏
类名
`
VariantFavoriteApi.java
`
成员方法
名称 | 方法 | Method | Path
------------- | ------------- | ------------- | -------------
[新增变量收藏分组](#addVariantFavorite) | [**addVariantFavorite**](#addVariantFavorite) | POST | /api-business/variantFavorite/addVariantFavorite
[删除变量收藏组](#deleteVariantGroup) | [**deleteVariantGroup**](#deleteVariantGroup) | POST | /api-business/variantFavorite/deleteVariantFavorite
[获取变量收藏组列表](#getVariantFavoriteList) | [**getVariantFavoriteList**](#getVariantFavoriteList) | POST | /api-business/variantFavorite/getVariantFavoriteList
[修改变量收藏分组](#updateVariantFavorite) | [**updateVariantFavorite**](#updateVariantFavorite) | POST | /api-business/variantFavorite/updateVariantFavorite
<a id="addVariantFavorite"></a>
## **新增变量收藏分组**
> ResultObject addVariantFavorite(saveVariantFavoriteForm)
### 请求参数
名称 | 类型 | 描述 | 备注
------------- | ------------- | ------------- | -------------
**saveVariantFavoriteForm** | **SaveVariantFavoriteForm**| saveVariantFavoriteForm |
#### SaveVariantFavoriteForm
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**favoriteId** | **String** | 收藏组id（修改时需要） | -
**resourceId** | **String** | 资源id 可传projectId或templateId |
**resourceType** | **String** | 资源类型 project或template |
**variantFavoriteName** | **String** | 收藏分组名称 |
**variantIds** | **List<String>** | 变量Id与设备Id拼接, 拼接内容 = 'deviceId:variantId' |
### 返回参数
ResultObject
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**code** | **String** | 响应码 | -
**data** | **Object** | 响应数据 | -
**msg** | **String** | 响应消息 | -
**time** | **OffsetDateTime** | 响应时间 | -
### java-sdk 调用示例
```java
//实例化api类，传入token
VariantFavoriteApi apiInstance = new VariantFavoriteApi(token);
//实例化请求参数
SaveVariantFavoriteForm saveVariantFavoriteForm = new SaveVariantFavoriteForm();
try {
ResultObject result = apiInstance.addVariantFavorite(saveVariantFavoriteForm);
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用VariantFavoriteApi.addVariantFavorite异常: " + e.getMessage());
e.printStackTrace();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-business/variantFavorite/addVariantFavorite|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{
"favoriteId":"",
"resourceId":"",
"resourceType":"",
"variantFavoriteName":""
}
```
<a id="deleteVariantGroup"></a>
## **删除变量收藏组**
> ResultObject deleteVariantGroup(deleteVariantFavoriteGroupForm)
### 请求参数
名称 | 类型 | 描述 | 备注
------------- | ------------- | ------------- | -------------
**deleteVariantFavoriteGroupForm** | **DeleteVariantFavoriteGroupForm**| deleteVariantFavoriteGroupForm |
#### DeleteVariantFavoriteGroupForm
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**favoriteId** | **String** | 收藏组id |
**resourceType** | **String** | 指定收藏组id所属的类型。可选[project,template] |
### 返回参数
ResultObject
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**code** | **String** | 响应码 | -
**data** | **Object** | 响应数据 | -
**msg** | **String** | 响应消息 | -
**time** | **OffsetDateTime** | 响应时间 | -
### java-sdk 调用示例
```java
//实例化api类，传入token
VariantFavoriteApi apiInstance = new VariantFavoriteApi(token);
//实例化请求参数
DeleteVariantFavoriteGroupForm deleteVariantFavoriteGroupForm = new DeleteVariantFavoriteGroupForm();
try {
ResultObject result = apiInstance.deleteVariantGroup(deleteVariantFavoriteGroupForm);
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用VariantFavoriteApi.deleteVariantGroup异常: " + e.getMessage());
e.printStackTrace();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-business/variantFavorite/deleteVariantFavorite|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{
"favoriteId":"",
"resourceType":""
}
```
<a id="getVariantFavoriteList"></a>
## **获取变量收藏组列表**
> ResultListVariantFavoriteVo getVariantFavoriteList(queryVariantGroupParam)
### 请求参数
名称 | 类型 | 描述 | 备注
------------- | ------------- | ------------- | -------------
**queryVariantGroupParam** | **QueryVariantGroupParam**| queryVariantGroupParam |
#### QueryVariantGroupParam
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**resourceId** | **String** | 资源id |
**resourceType** | **String** | 指定资源id的类型。可选[project,template] |
### 返回参数
ResultListVariantFavoriteVo
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**code** | **String** | 响应码 | -
**data** | **List<VariantFavoriteVo>** | 响应数据 | -
**msg** | **String** | 响应消息 | -
**time** | **OffsetDateTime** | 响应时间 | -
VariantFavoriteVo
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**createdBy** | **String** | 创建人 | -
**createdTime** | **OffsetDateTime** | 创建时间 | -
**id** | **String** | 收藏组id | -
**name** | **String** | 收藏组名称 | -
**remark** | **String** | 描述 | -
**updatedTime** | **OffsetDateTime** | 修改时间 | -
### java-sdk 调用示例
```java
//实例化api类，传入token
VariantFavoriteApi apiInstance = new VariantFavoriteApi(token);
//实例化请求参数
QueryVariantGroupParam queryVariantGroupParam = new QueryVariantGroupParam();
try {
ResultListVariantFavoriteVo result = apiInstance.getVariantFavoriteList(queryVariantGroupParam);
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用VariantFavoriteApi.getVariantFavoriteList异常: " + e.getMessage());
e.printStackTrace();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-business/variantFavorite/getVariantFavoriteList|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{
"resourceId":"",
"resourceType":""
}
```
<a id="updateVariantFavorite"></a>
## **修改变量收藏分组**
> ResultObject updateVariantFavorite(saveVariantFavoriteForm)
### 请求参数
名称 | 类型 | 描述 | 备注
------------- | ------------- | ------------- | -------------
**saveVariantFavoriteForm** | **SaveVariantFavoriteForm**| saveVariantFavoriteForm |
#### SaveVariantFavoriteForm
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**favoriteId** | **String** | 收藏组id（修改时需要） | -
**resourceId** | **String** | 资源id 可传projectId或templateId |
**resourceType** | **String** | 资源类型 project或template |
**variantFavoriteName** | **String** | 收藏分组名称 |
**variantIds** | **List<String>** | 变量Id与设备Id拼接, 拼接内容 = 'deviceId:variantId' |
### 返回参数
ResultObject
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**code** | **String** | 响应码 | -
**data** | **Object** | 响应数据 | -
**msg** | **String** | 响应消息 | -
**time** | **OffsetDateTime** | 响应时间 | -
### java-sdk 调用示例
```java
//实例化api类，传入token
VariantFavoriteApi apiInstance = new VariantFavoriteApi(token);
//实例化请求参数
SaveVariantFavoriteForm saveVariantFavoriteForm = new SaveVariantFavoriteForm();
try {
ResultObject result = apiInstance.updateVariantFavorite(saveVariantFavoriteForm);
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用VariantFavoriteApi.updateVariantFavorite异常: " + e.getMessage());
e.printStackTrace();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-business/variantFavorite/updateVariantFavorite|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{
"favoriteId":"",
"resourceId":"",
"resourceType":"",
"variantFavoriteName":""
}
```