GET 获取视图可用数据范围
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 后台接口 |
| 请求方式 | GET |
| 接口地址 | /DIR_ADMIN/v1/view/data_range |
| 所属业务 | 公共接口 |
| 来源模块/系统 | 公共接口 |
| 认证方式 | Bearer Token(管理员令牌) |
完整请求
请求
正在加载示例…失败请求
正在加载示例…接口说明
获取视图可用数据范围
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| view | query | string | 是 | 页面标识 client用户管理 order订单管理 host产品管理 transaction交易流水 |
成功响应
正在加载示例…失败响应 400:请求参数或业务校验失败
正在加载示例…失败响应 401:未认证或登录已失效
正在加载示例…失败响应 403:无权执行当前操作
正在加载示例…失败响应 404:接口或业务资源不存在
正在加载示例…失败响应 500:服务器内部错误
正在加载示例…响应状态
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功响应 | 内联对象 |
| 400 | Bad Request | 请求参数或业务校验失败 | 内联对象 |
| 401 | Unauthorized | 未认证或登录已失效 | 内联对象 |
| 403 | Forbidden | 无权执行当前操作 | 内联对象 |
| 404 | Not Found | 接口或业务资源不存在 | 内联对象 |
| 500 | Internal Server Error | 服务器内部错误 | 内联对象 |
响应参数
状态码 200
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 否 | — | 状态码 |
msg | string | 否 | — | 提示信息 |
data | object | 否 | — | — |
data.data_range | [object] | 否 | — | — |
data.data_range[].name | string | 否 | — | 数据范围分组名称 |
data.data_range[].field | [object] | 否 | — | — |
data.data_range[].field[].key | string | 否 | — | 数据范围字段标识 |
data.data_range[].field[].name | string | 否 | — | 数据范围字段名称 |
data.data_range[].field[].type | string | 否 | — | 数据范围字段类型 input输入 multi_select下拉多选 select下拉单选 date日期 |
data.data_range[].field[].option | [object] | 否 | — | 选项 类型为multi_select或select时返回 |
data.data_range[].field[].option[].id | integer(int32) | 否 | — | ID 标识为server_name client_level sale country时返回 |
data.data_range[].field[].option[].name | string | 否 | — | 名称 标识为product_name server_name client_level sale country时返回 |
data.data_range[].field[].option[].child | [object] | 否 | — | 商品二级分组 标识为product_name时返回 |
data.data_range[].field[].option[].child[].name | string | 否 | — | 商品二级分组名称 标识为product_name时返回 |
data.data_range[].field[].option[].child[].product | [object] | 否 | — | 商品 标识为product_name时返回 |
data.data_range[].field[].option[].child[].product[].id | integer(int32) | 否 | — | 商品ID 标识为product_name时返回 |
data.data_range[].field[].option[].child[].product[].name | string | 否 | — | 商品名称 标识为product_name时返回 |
data.data_range[].field[].rule | [string] | 否 | — | 数据范围规则 equal等于 not_equal不等于 include包含 not_include不包含 empty为空 not_empty不为空 interval区间 dynamic动态 |
失败状态码 400、401、403、404、500 共用以下结构:
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 是 | — | 错误状态码 |
msg | string | 是 | — | 错误提示 |