# 查找选区数据




**标签**：`【电子表格】` 


## 请求说明
| 字段          | 值                  |
|--------------|---------------------|
| **<div style="white-space: nowrap;">请求地址</div>**  | https://openapi.wps.cn/v7/sheets/{file_id}/worksheets/{worksheet_id}/range_data/find          |
| **<div style="white-space: nowrap;">HTTP 方法</div>** | `POST`    |
| **<div style="white-space: nowrap;">接口描述</div>**  | 无 |
| **<div style="white-space: nowrap;">签名方式</div>**  | [KSO-1](https://open.wps.cn/documents/app-integration-dev/wps365/server/api-description/signature-description) |
| **<div style="white-space: nowrap;">限频策略</div>** | 无 |
| **<div style="white-space: nowrap;">权限要求</div>** | <div><div>管理传统表格(应用授权) `kso.sheets.readwrite`</div><div style="margin-top: 5px;"></div><div>查询传统表格(应用授权) `kso.sheets.read`</div><div style="margin-top: 5px;"></div><div>管理传统表格(用户授权) `kso.sheets.readwrite`</div><div style="margin-top: 5px;"></div><div>查询传统表格(用户授权) `kso.sheets.read`</div></div> |




## 路径参数 (Path)
| 属性名 | 类型 | 是否必填 | 描述 | 可选值 |
|-------|------|------|-------|-------|
| <div style="white-space: nowrap;">file_id</div> | `string` | 是 | 文件ID | - 
| <div style="white-space: nowrap;">worksheet_id</div> | `integer` | 是 | 工作表ID | - 





## 请求体(Body)
**请求体格式:** `application/json`
<OpenapiRenderTable  dataSource='[{"key":"filter","name":"filter","deprecated":false,"type":"object","required":"是","enum":[],"xEnum":[],"description":"<p>筛选条件，必填</p>\n","children":[{"key":"filter.condition","name":"condition","deprecated":false,"type":"array[object]","required":"是","enum":[],"xEnum":[],"description":"<p>筛选条件数组，填写空数组则不进行筛选输出全部</p>\n","children":[{"key":"filter.condition.items.col","name":"col","deprecated":false,"type":"integer","required":"是","enum":[],"xEnum":[],"description":"<p>某一列的条件，相对于range</p>\n","children":[]},{"key":"filter.condition.items.info","name":"info","deprecated":false,"type":"array[object]","required":"是","enum":[],"xEnum":[],"description":"<p>筛选信息数组</p>\n","children":[{"key":"filter.condition.items.info.items.value","name":"value","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>筛选值，如&quot;&gt;=5&quot;, “&lt;=10”, “&lt;&gt;9”</p>\n<p>筛选条件判断说明：</p>\n<p>数字形式：</p>\n<p>等于         =1</p>\n<p>不等于       &lt;&gt;1</p>\n<p>大于         &gt;1</p>\n<p>大于或等于    &gt;=1</p>\n<p>小于         &lt;1</p>\n<p>小于或等于    &lt;=1注：没有介于，weboffice上的介于只是一个页面选项</p>\n<p>文本形式：</p>\n<p>等于    =你好</p>\n<p>不等于   &lt;&gt;你好</p>\n<p>开头是  =你好*</p>\n<p>结尾是  =*你好</p>\n<p>包含     =<em>你好</em></p>\n<p>不包含 &lt;&gt;<em>你好</em></p>\n","children":[]}]},{"key":"filter.condition.items.mode","name":"mode","deprecated":false,"type":"string","required":"是","enum":["filter_mode_and","filter_mode_or"],"xEnum":["filter_mode_and","filter_mode_or"],"description":"<p>筛选的模式，默认AND</p>\n","children":[]}]},{"key":"filter.duplicates","name":"duplicates","deprecated":false,"type":"object","required":"是","enum":[],"xEnum":[],"description":"<p>去除重复项</p>\n","children":[{"key":"filter.duplicates.col","name":"col","deprecated":false,"type":"array[integer]","required":"是","enum":[],"xEnum":[],"description":"<p>去重的列数组，相对坐标</p>\n","children":[]}]},{"key":"filter.search","name":"search","deprecated":false,"type":"array[object]","required":"是","enum":[],"xEnum":[],"description":"<p>搜索条件，不包含单元格图片</p>\n","children":[{"key":"filter.search.items.col","name":"col","deprecated":false,"type":"integer","required":"是","enum":[],"xEnum":[],"description":"<p>绝对坐标</p>\n","children":[]},{"key":"filter.search.items.value","name":"value","deprecated":false,"type":"array[string]","required":"是","enum":[],"xEnum":[],"description":"<p>搜索值数组，忽略大小写</p>\n","children":[]}]}]},{"key":"ignore_hidden_cell","name":"ignore_hidden_cell","deprecated":false,"type":"boolean","required":"否","enum":[],"xEnum":[],"description":"<p>为true时忽略隐藏的单元格，默认为false</p>\n","children":[]},{"key":"option_cols","name":"option_cols","deprecated":false,"type":"array[integer]","required":"否","enum":[],"xEnum":[],"description":"<p>想获取的选项坐标，相对于range</p>\n","children":[]},{"key":"page","name":"page","deprecated":false,"type":"object","required":"否","enum":[],"xEnum":[],"description":"<p>分页 可选</p>\n","children":[{"key":"page.page","name":"page","deprecated":false,"type":"integer","required":"是","enum":[],"xEnum":[],"description":"<p>页码，默认1，最小值1</p>\n","children":[]},{"key":"page.page_size","name":"page_size","deprecated":false,"type":"integer","required":"是","enum":[],"xEnum":[],"description":"<p>页大小，默认100</p>\n","children":[]}]},{"key":"range","name":"range","deprecated":false,"type":"object","required":"是","enum":[],"xEnum":[],"description":"<p>必填 筛选的区域</p>\n","children":[{"key":"range.col_from","name":"col_from","deprecated":false,"type":"integer","required":"是","enum":[],"xEnum":[],"description":"<p>列起始索引位置</p>\n","children":[]},{"key":"range.col_to","name":"col_to","deprecated":false,"type":"integer","required":"是","enum":[],"xEnum":[],"description":"<p>列最后索引位置</p>\n","children":[]},{"key":"range.row_from","name":"row_from","deprecated":false,"type":"integer","required":"是","enum":[],"xEnum":[],"description":"<p>行起始索引位置</p>\n","children":[]},{"key":"range.row_to","name":"row_to","deprecated":false,"type":"integer","required":"是","enum":[],"xEnum":[],"description":"<p>行最后索引位置</p>\n","children":[]}]},{"key":"show_total","name":"show_total","deprecated":false,"type":"boolean","required":"否","enum":[],"xEnum":[],"description":"<p>是否显示总数 默认为false</p>\n","children":[]}]' />

## 请求体示例
```json
{
  "filter": {
    "condition": [
      {
        "col": 0,
        "info": [
          {
            "value": "string"
          }
        ],
        "mode": "filter_mode_and"
      }
    ],
    "duplicates": {
      "col": [
        0
      ]
    },
    "search": [
      {
        "col": 0,
        "value": [
          "string"
        ]
      }
    ]
  },
  "ignore_hidden_cell": true,
  "option_cols": [
    0
  ],
  "page": {
    "page": 0,
    "page_size": 0
  },
  "range": {
    "col_from": 0,
    "col_to": 0,
    "row_from": 0,
    "row_to": 0
  },
  "show_total": true
}
```

## 响应体(Response)
**HTTP状态码:** `200`<br/>
**响应体格式:** `application/json`
<OpenapiRenderTable hideHeaderKeys='required' dataSource='[{"key":"data","name":"data","deprecated":false,"type":"object","required":"是","enum":[],"xEnum":[],"description":"-","children":[{"key":"data.merge_range_data","name":"merge_range_data","deprecated":false,"type":"array[object]","required":"是","enum":[],"xEnum":[],"description":"<p>当前区域包含的合并单元格数据</p>\n","children":[{"key":"data.merge_range_data.items.cell_text","name":"cell_text","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>单元格显示的内容</p>\n","children":[]},{"key":"data.merge_range_data.items.col_from","name":"col_from","deprecated":false,"type":"integer","required":"是","enum":[],"xEnum":[],"description":"<p>单元格起始列索引</p>\n","children":[]},{"key":"data.merge_range_data.items.col_to","name":"col_to","deprecated":false,"type":"integer","required":"是","enum":[],"xEnum":[],"description":"<p>单元格最终列索引</p>\n","children":[]},{"key":"data.merge_range_data.items.is_cell_pic","name":"is_cell_pic","deprecated":false,"type":"boolean","required":"是","enum":[],"xEnum":[],"description":"<p>单元格是否为单元格图片</p>\n","children":[]},{"key":"data.merge_range_data.items.num_format","name":"num_format","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>单元格的数字格式</p>\n","children":[]},{"key":"data.merge_range_data.items.original_cell_value","name":"original_cell_value","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>单元格公式栏上的值, 只有图片传回来的值类似于公式, 其它都是返回计算结果的值</p>\n","children":[]},{"key":"data.merge_range_data.items.pic_content","name":"pic_content","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>图片内容 使用一个字段返回</p>\n","children":[]},{"key":"data.merge_range_data.items.pic_data","name":"pic_data","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>图片id，当图片是在线文件时返回</p>\n","children":[]},{"key":"data.merge_range_data.items.row_from","name":"row_from","deprecated":false,"type":"integer","required":"是","enum":[],"xEnum":[],"description":"<p>单元格起始行索引</p>\n","children":[]},{"key":"data.merge_range_data.items.row_to","name":"row_to","deprecated":false,"type":"integer","required":"是","enum":[],"xEnum":[],"description":"<p>单元格最终行索引</p>\n","children":[]},{"key":"data.merge_range_data.items.sha1","name":"sha1","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>图片标识，当图片是本地图片时返回</p>\n","children":[]},{"key":"data.merge_range_data.items.tag","name":"tag","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>单元格数据标志</p>\n","children":[]}]},{"key":"data.option_col","name":"option_col","deprecated":false,"type":"array[object]","required":"是","enum":[],"xEnum":[],"description":"<p>选项的结果</p>\n","children":[{"key":"data.option_col.items.col","name":"col","deprecated":false,"type":"integer","required":"是","enum":[],"xEnum":[],"description":"<p>列索引，与传入的col一致</p>\n","children":[]},{"key":"data.option_col.items.texts","name":"texts","deprecated":false,"type":"array[object]","required":"是","enum":[],"xEnum":[],"description":"<p>选项文本数组</p>\n","children":[{"key":"data.option_col.items.texts.items.count","name":"count","deprecated":false,"type":"integer","required":"是","enum":[],"xEnum":[],"description":"<p>出现的次数</p>\n","children":[]},{"key":"data.option_col.items.texts.items.origin","name":"origin","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>原始文本</p>\n","children":[]},{"key":"data.option_col.items.texts.items.text","name":"text","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>显示文本</p>\n","children":[]}]}]},{"key":"data.range_data","name":"range_data","deprecated":false,"type":"array[object]","required":"是","enum":[],"xEnum":[],"description":"<p>此块内容与GetRangeData格式一致 没有设置筛选条件时，输出全部数据</p>\n","children":[{"key":"data.range_data.items.cell_text","name":"cell_text","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>单元格显示的内容</p>\n","children":[]},{"key":"data.range_data.items.col_from","name":"col_from","deprecated":false,"type":"integer","required":"是","enum":[],"xEnum":[],"description":"<p>单元格起始列索引</p>\n","children":[]},{"key":"data.range_data.items.col_to","name":"col_to","deprecated":false,"type":"integer","required":"是","enum":[],"xEnum":[],"description":"<p>单元格最终列索引</p>\n","children":[]},{"key":"data.range_data.items.is_cell_pic","name":"is_cell_pic","deprecated":false,"type":"boolean","required":"是","enum":[],"xEnum":[],"description":"<p>单元格是否为单元格图片</p>\n","children":[]},{"key":"data.range_data.items.num_format","name":"num_format","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>单元格的数字格式</p>\n","children":[]},{"key":"data.range_data.items.original_cell_value","name":"original_cell_value","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>单元格公式栏上的值, 只有图片传回来的值类似于公式, 其它都是返回计算结果的值</p>\n","children":[]},{"key":"data.range_data.items.pic_content","name":"pic_content","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>图片内容 使用一个字段返回</p>\n","children":[]},{"key":"data.range_data.items.pic_data","name":"pic_data","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>图片id，当图片是在线文件时返回</p>\n","children":[]},{"key":"data.range_data.items.row_from","name":"row_from","deprecated":false,"type":"integer","required":"是","enum":[],"xEnum":[],"description":"<p>单元格起始行索引</p>\n","children":[]},{"key":"data.range_data.items.row_to","name":"row_to","deprecated":false,"type":"integer","required":"是","enum":[],"xEnum":[],"description":"<p>单元格最终行索引</p>\n","children":[]},{"key":"data.range_data.items.sha1","name":"sha1","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>图片标识，当图片是本地图片时返回</p>\n","children":[]},{"key":"data.range_data.items.tag","name":"tag","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>单元格数据标志</p>\n","children":[]}]},{"key":"data.result_type","name":"result_type","deprecated":false,"type":"integer","required":"是","enum":[],"xEnum":[],"description":"<p>本次是否成功 0不成功 1成功</p>\n","children":[]},{"key":"data.total","name":"total","deprecated":false,"type":"integer","required":"是","enum":[],"xEnum":[],"description":"<p>结果的总数</p>\n","children":[]}]},{"key":"code","name":"code","deprecated":false,"type":"integer","required":"是","enum":[],"xEnum":[],"description":"-","children":[]},{"key":"msg","name":"msg","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>人可阅读的文本信息，可能会按不同的语言或地区返回不同的文本信息。</p>\n","children":[]}]' />

## 响应体示例
```json
{
  "data": {
    "merge_range_data": [
      {
        "cell_text": "string",
        "col_from": 0,
        "col_to": 0,
        "is_cell_pic": true,
        "num_format": "string",
        "original_cell_value": "string",
        "pic_content": "string",
        "pic_data": "string",
        "row_from": 0,
        "row_to": 0,
        "sha1": "string",
        "tag": "string"
      }
    ],
    "option_col": [
      {
        "col": 0,
        "texts": [
          {
            "count": 0,
            "origin": "string",
            "text": "string"
          }
        ]
      }
    ],
    "range_data": [
      {
        "cell_text": "string",
        "col_from": 0,
        "col_to": 0,
        "is_cell_pic": true,
        "num_format": "string",
        "original_cell_value": "string",
        "pic_content": "string",
        "pic_data": "string",
        "row_from": 0,
        "row_to": 0,
        "sha1": "string",
        "tag": "string"
      }
    ],
    "result_type": 0,
    "total": 0
  },
  "code": 0,
  "msg": "string"
}
```