看板过滤分组
## 概述
> 看板过滤分组
类名
`
ProjectBoardFilterGroupApi.java
`
成员方法
名称 | 方法 | Method | Path
------------- | ------------- | ------------- | -------------
[添加看板过滤分组](#addProjectBoardFilterGroup) | [**addProjectBoardFilterGroup**](#addProjectBoardFilterGroup) | POST | /api-organization/projectBoardFilterGroup/addProjectBoardFilterGroup
[删除看板过滤分组](#deleteProjectBoardFilterGroup) | [**deleteProjectBoardFilterGroup**](#deleteProjectBoardFilterGroup) | POST | /api-organization/projectBoardFilterGroup/deleteProjectBoardFilterGroup
[获取看板过滤分组信息](#getProjectBoardFilterGroupList) | [**getProjectBoardFilterGroupList**](#getProjectBoardFilterGroupList) | POST | /api-organization/projectBoardFilterGroup/getProjectBoardFilterGroupList
[获取看板过滤分组条件值](#getProjectBoardFilterGroupPropertiesList) | [**getProjectBoardFilterGroupPropertiesList**](#getProjectBoardFilterGroupPropertiesList) | POST | /api-organization/projectBoardFilterGroup/getProjectBoardFilterGroupPropertiesList
[获取默认过滤分组筛选条件](#getProjectBoardFilterList) | [**getProjectBoardFilterList**](#getProjectBoardFilterList) | POST | /api-organization/projectBoardFilterGroup/getProjectBoardFilterList
[获取筛选条件的值](#getProjectBoardFilterValueList) | [**getProjectBoardFilterValueList**](#getProjectBoardFilterValueList) | POST | /api-organization/projectBoardFilterGroup/getProjectBoardFilterValueList
[修改看板过滤分组](#updateProjectBoardFilterGroup) | [**updateProjectBoardFilterGroup**](#updateProjectBoardFilterGroup) | POST | /api-organization/projectBoardFilterGroup/updateProjectBoardFilterGroup
[保存过滤分组筛选值](#updateProjectBoardFilterGroupProperties) | [**updateProjectBoardFilterGroupProperties**](#updateProjectBoardFilterGroupProperties) | POST | /api-organization/projectBoardFilterGroup/updateProjectBoardFilterGroupProperties
<a id="addProjectBoardFilterGroup"></a>
## **添加看板过滤分组**
> ResultObject addProjectBoardFilterGroup(addProjectBoardFilterGroupForm)
根据Form 添加看板过滤分组
### 请求参数
名称 | 类型 | 描述 | 备注
------------- | ------------- | ------------- | -------------
**addProjectBoardFilterGroupForm** | **AddProjectBoardFilterGroupForm**| addProjectBoardFilterGroupForm |
#### AddProjectBoardFilterGroupForm
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**name** | **String** | 过滤分组名称 |
**projectBoardId** | **String** | 所属看板Id |
**remark** | **String** | 备注 | -
**sort** | **Integer** | 排序号 | -
### 返回参数
ResultObject
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**code** | **String** | 响应码 | -
**data** | **Object** | 响应数据 | -
**msg** | **String** | 响应消息 | -
**time** | **OffsetDateTime** | 响应时间 | -
### java-sdk 调用示例
```java
//实例化api类，传入token
ProjectBoardFilterGroupApi apiInstance = new ProjectBoardFilterGroupApi(token);
//实例化请求参数
AddProjectBoardFilterGroupForm addProjectBoardFilterGroupForm = new AddProjectBoardFilterGroupForm();
try {
ResultObject result = apiInstance.addProjectBoardFilterGroup(addProjectBoardFilterGroupForm);
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用ProjectBoardFilterGroupApi.addProjectBoardFilterGroup异常: " + e.getMessage());
e.printStackTrace();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-organization/projectBoardFilterGroup/addProjectBoardFilterGroup|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{
"name":"",
"remark":"",
"sort":0,
"projectBoardId":""
}
```
<a id="deleteProjectBoardFilterGroup"></a>
## **删除看板过滤分组**
> ResultObject deleteProjectBoardFilterGroup(id)
根据过滤分组Id 删除对应的过滤分组 以及关联关系
### 请求参数
名称 | 类型 | 描述 | 备注
------------- | ------------- | ------------- | -------------
**id** | **String**| 过滤分组Id |
### 返回参数
ResultObject
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**code** | **String** | 响应码 | -
**data** | **Object** | 响应数据 | -
**msg** | **String** | 响应消息 | -
**time** | **OffsetDateTime** | 响应时间 | -
### java-sdk 调用示例
```java
//实例化api类，传入token
ProjectBoardFilterGroupApi apiInstance = new ProjectBoardFilterGroupApi(token);
//实例化请求参数
String id = "id_example";
try {
ResultObject result = apiInstance.deleteProjectBoardFilterGroup(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用ProjectBoardFilterGroupApi.deleteProjectBoardFilterGroup异常: " + e.getMessage());
e.printStackTrace();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-organization/projectBoardFilterGroup/deleteProjectBoardFilterGroup|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{
"id":""
}
```
<a id="getProjectBoardFilterGroupList"></a>
## **获取看板过滤分组信息**
> ResultListProjectBoardFilterGroupVo getProjectBoardFilterGroupList(boardId)
根据过滤看板Id 查询该看板下的所有过滤分组信息
### 请求参数
名称 | 类型 | 描述 | 备注
------------- | ------------- | ------------- | -------------
**boardId** | **String**| 看板Id |
### 返回参数
ResultListProjectBoardFilterGroupVo
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**code** | **String** | 响应码 | -
**data** | **List<ProjectBoardFilterGroupVo>** | 响应数据 | -
**msg** | **String** | 响应消息 | -
**time** | **OffsetDateTime** | 响应时间 | -
ProjectBoardFilterGroupVo
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**boardId** | **String** | 看板Id | -
**createdTime** | **OffsetDateTime** | 创建时间 | -
**id** | **String** | 过滤分组Id | -
**name** | **String** | 过滤分组名称 | -
**remark** | **String** | 过滤分组备注 | -
**sort** | **Integer** | 排序号 | -
### java-sdk 调用示例
```java
//实例化api类，传入token
ProjectBoardFilterGroupApi apiInstance = new ProjectBoardFilterGroupApi(token);
//实例化请求参数
String boardId = "boardId_example";
try {
ResultListProjectBoardFilterGroupVo result = apiInstance.getProjectBoardFilterGroupList(boardId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用ProjectBoardFilterGroupApi.getProjectBoardFilterGroupList异常: " + e.getMessage());
e.printStackTrace();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-organization/projectBoardFilterGroup/getProjectBoardFilterGroupList|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{
"boardId":""
}
```
<a id="getProjectBoardFilterGroupPropertiesList"></a>
## **获取看板过滤分组条件值**
> ResultListProjectBoardFilterPropertiesTypeValue getProjectBoardFilterGroupPropertiesList(id)
根据过滤分组Id 获取对应的过滤分组 筛选条件内容
### 请求参数
名称 | 类型 | 描述 | 备注
------------- | ------------- | ------------- | -------------
**id** | **String**| 过滤分组Id | -
### 返回参数
ResultListProjectBoardFilterPropertiesTypeValue
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**code** | **String** | 响应码 | -
**data** | **List<ProjectBoardFilterPropertiesTypeValue>** | 响应数据 | -
**msg** | **String** | 响应消息 | -
**time** | **OffsetDateTime** | 响应时间 | -
ProjectBoardFilterPropertiesTypeValue
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**propertiesId** | **String** | 属性类型的id | -
**type** | **String** | 过滤分组类型（类型：['0: 省', '1: 市', '2: 区', '3: 客户', '4: 年', '5:月', '6:属性'] | -
**value** | **String** | 过滤分组类值 值为类型 （类型为 属性或客户 值=对应的Id） | -
### java-sdk 调用示例
```java
//实例化api类，传入token
ProjectBoardFilterGroupApi apiInstance = new ProjectBoardFilterGroupApi(token);
//实例化请求参数
String id = "id_example";
try {
ResultListProjectBoardFilterPropertiesTypeValue result = apiInstance.getProjectBoardFilterGroupPropertiesList(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用ProjectBoardFilterGroupApi.getProjectBoardFilterGroupPropertiesList异常: " + e.getMessage());
e.printStackTrace();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-organization/projectBoardFilterGroup/getProjectBoardFilterGroupPropertiesList|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{
"id":""
}
```
<a id="getProjectBoardFilterList"></a>
## **获取默认过滤分组筛选条件**
> ResultListProjectBoardFilterGroupPropertiesVo getProjectBoardFilterList()
获取默认过滤分组筛选条件内容（地区，客户，日期，属性）
### 请求参数
请求参数为空.
### 返回参数
ResultListProjectBoardFilterGroupPropertiesVo
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**code** | **String** | 响应码 | -
**data** | **List<ProjectBoardFilterGroupPropertiesVo>** | 响应数据 | -
**msg** | **String** | 响应消息 | -
**time** | **OffsetDateTime** | 响应时间 | -
ProjectBoardFilterGroupPropertiesVo
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**createdTime** | **OffsetDateTime** | 创建时间 | -
**name** | **String** | 筛选名称 地区,客户,日期,属性名称 | -
**propertiesType** | **String** | 属性类型 0：枚举、1：文本、2：日期、3：数字 (type为3时 该属性则不为空) | -
**sort** | **Integer** | 排序号 | -
**type** | **String** | 筛选类型 0=地区 1=客户 2=日期 3=属性 | -
**value** | **String** | 筛选值 [0]=地区,1=客户,[2]=日期,3=属性Id | -
### java-sdk 调用示例
```java
//实例化api类，传入token
ProjectBoardFilterGroupApi apiInstance = new ProjectBoardFilterGroupApi(token);
try {
ResultListProjectBoardFilterGroupPropertiesVo result = apiInstance.getProjectBoardFilterList();
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用ProjectBoardFilterGroupApi.getProjectBoardFilterList异常: " + e.getMessage());
e.printStackTrace();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-organization/projectBoardFilterGroup/getProjectBoardFilterList|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{}
```
<a id="getProjectBoardFilterValueList"></a>
## **获取筛选条件的值**
> ResultListProjectBoardFilterGroupPropertiesValueVo getProjectBoardFilterValueList(propertiesId, type)
根据传入的type编号 获取该type对应的 筛选条件值
### 请求参数
名称 | 类型 | 描述 | 备注
------------- | ------------- | ------------- | -------------
**propertiesId** | **String**| 属性Id | -
**type** | **String**| 筛选条件类型 0:地区,1:年月,2:客户,3:属性 | -
### 返回参数
ResultListProjectBoardFilterGroupPropertiesValueVo
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**code** | **String** | 响应码 | -
**data** | **List<ProjectBoardFilterGroupPropertiesValueVo>** | 响应数据 | -
**msg** | **String** | 响应消息 | -
**time** | **OffsetDateTime** | 响应时间 | -
ProjectBoardFilterGroupPropertiesValueVo
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**children** | **List<ProjectBoardFilterGroupPropertiesValueVo>** | 筛选值下的子节点 | -
**id** | **String** | 筛选值 地区(对应地区名称) 日期(对应年月) 客户(对应客户Id) 属性值(对应属性Id) | -
**name** | **String** | 筛选值名称 地区(对应的地区名称) 日期(根据筛选类型 加上对应的后缀= 值[2022]+‘年’) 客户=客户名称 属性值=属性值名称 | -
**type** | **String** | 筛选值类型 地区为0 日期为1 客户为2 属性值为3 | -
ProjectBoardFilterGroupPropertiesValueVo
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**children** | **List<ProjectBoardFilterGroupPropertiesValueVo>** | 筛选值下的子节点 | -
**id** | **String** | 筛选值 地区(对应地区名称) 日期(对应年月) 客户(对应客户Id) 属性值(对应属性Id) | -
**name** | **String** | 筛选值名称 地区(对应的地区名称) 日期(根据筛选类型 加上对应的后缀= 值[2022]+‘年’) 客户=客户名称 属性值=属性值名称 | -
**type** | **String** | 筛选值类型 地区为0 日期为1 客户为2 属性值为3 | -
### java-sdk 调用示例
```java
//实例化api类，传入token
ProjectBoardFilterGroupApi apiInstance = new ProjectBoardFilterGroupApi(token);
//实例化请求参数
String propertiesId = "propertiesId_example";
String type = "type_example";
try {
ResultListProjectBoardFilterGroupPropertiesValueVo result = apiInstance.getProjectBoardFilterValueList(propertiesId, type);
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用ProjectBoardFilterGroupApi.getProjectBoardFilterValueList异常: " + e.getMessage());
e.printStackTrace();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-organization/projectBoardFilterGroup/getProjectBoardFilterValueList|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{
"type":"",
"propertiesId":""
}
```
<a id="updateProjectBoardFilterGroup"></a>
## **修改看板过滤分组**
> ResultObject updateProjectBoardFilterGroup(updateProjectBoardFilterGroupForm)
根据Form 修改过滤分组 只可修改['名称', '备注', '排序号']
### 请求参数
名称 | 类型 | 描述 | 备注
------------- | ------------- | ------------- | -------------
**updateProjectBoardFilterGroupForm** | **UpdateProjectBoardFilterGroupForm**| updateProjectBoardFilterGroupForm |
#### UpdateProjectBoardFilterGroupForm
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**id** | **String** | 过滤分组Id |
**name** | **String** | 过滤分组名称 |
**remark** | **String** | 备注 | -
**sort** | **Integer** | 排序号 | -
### 返回参数
ResultObject
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**code** | **String** | 响应码 | -
**data** | **Object** | 响应数据 | -
**msg** | **String** | 响应消息 | -
**time** | **OffsetDateTime** | 响应时间 | -
### java-sdk 调用示例
```java
//实例化api类，传入token
ProjectBoardFilterGroupApi apiInstance = new ProjectBoardFilterGroupApi(token);
//实例化请求参数
UpdateProjectBoardFilterGroupForm updateProjectBoardFilterGroupForm = new UpdateProjectBoardFilterGroupForm();
try {
ResultObject result = apiInstance.updateProjectBoardFilterGroup(updateProjectBoardFilterGroupForm);
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用ProjectBoardFilterGroupApi.updateProjectBoardFilterGroup异常: " + e.getMessage());
e.printStackTrace();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-organization/projectBoardFilterGroup/updateProjectBoardFilterGroup|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{
"name":"",
"remark":"",
"id":"",
"sort":0
}
```
<a id="updateProjectBoardFilterGroupProperties"></a>
## **保存过滤分组筛选值**
> ResultObject updateProjectBoardFilterGroupProperties(updateProjectBoardFilterPropertiesForm)
根据Form 保存对应的 过滤分组筛选值
### 请求参数
名称 | 类型 | 描述 | 备注
------------- | ------------- | ------------- | -------------
**updateProjectBoardFilterPropertiesForm** | **UpdateProjectBoardFilterPropertiesForm**| updateProjectBoardFilterPropertiesForm |
#### UpdateProjectBoardFilterPropertiesForm
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**filterGroupId** | **String** | 过滤分组Id |
**typeValues** | **List<ProjectBoardFilterPropertiesTypeValue>** | 过滤分组类型和值 |
### 返回参数
ResultObject
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**code** | **String** | 响应码 | -
**data** | **Object** | 响应数据 | -
**msg** | **String** | 响应消息 | -
**time** | **OffsetDateTime** | 响应时间 | -
### java-sdk 调用示例
```java
//实例化api类，传入token
ProjectBoardFilterGroupApi apiInstance = new ProjectBoardFilterGroupApi(token);
//实例化请求参数
UpdateProjectBoardFilterPropertiesForm updateProjectBoardFilterPropertiesForm = new UpdateProjectBoardFilterPropertiesForm();
try {
ResultObject result = apiInstance.updateProjectBoardFilterGroupProperties(updateProjectBoardFilterPropertiesForm);
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用ProjectBoardFilterGroupApi.updateProjectBoardFilterGroupProperties异常: " + e.getMessage());
e.printStackTrace();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-organization/projectBoardFilterGroup/updateProjectBoardFilterGroupProperties|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{
"filterGroupId":""
}
```