物料简单查询接口
更新时间：2024-11-13
物料简单查询接口
接口说明
百度提供的更加自由的方式查询。
请求示例
HTTP方法：POST
请求URL：https://airec.baidu.com/airec/api/omni/ms/general/search
Header如下：
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| Content-Type | - | 是 | application/json;charset=UTF-8 |
| X-Gw-Ak | string | 是 | 数据表鉴权信息 |
| Alias-Name | string | 是 | 数据表名称 |
| code | string | 是 | 数据表类型 |
| id | string | 是 | 数据表id |
请求格式
POST 方式调用
注意：要求使用 JSON 格式的结构体来描述一个请求的具体内容。
请求参数
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| pageNo | int | 否 | 当前页码，默认1，最小1 |
| pageSize | int | 否 | 每页条数，默认20,最大100 |
| retype | boolean | 否 | 是否做retype操作,默认false,为true需开启etl（将所有返回字段值转string类型） |
| totalCount | boolean | 否 | 为空则返回总数和数据，true仅返回总数，false仅返回数据 |
| conditions | array | 否 | 所查询的自定义查询条件 |
| field | string | 是 | 查询的字段名 |
| fieldType | string | 否 | 字段类型，string，number，list_s，list_n，boolean |
| matchType | string | 是 | 匹配类型，is精准查询、in包含查询、gte/lte范围查询（大于等于/小于等于）、match匹配查询、not match非匹配查询、like模糊查询、null为空、not null不为空 |
| value | object | 是 | 要匹配的值，注意传输时是字符类型还是数值类型，in、match、not match为数组 |
| resultFields | array | 否 | 返回字段列表,为空时返回所有 |
| pageSort | object | 否 | 分页排序参数,为空时采用cms默认配置 |
| direction | string | 是 | 分页查询排序：ASC、DESC |
| fields | array | 是 | 排序字段列表 |
请求示例
Plain Text
1{
2 "pageNo":1,
3 "pageSize":20,
4 "conditions":[{
5 "field":"online",
6 "fieldType": "number",
7 "matchType":"is",
8 "value": 1
9 },{
10 "field":"publish_time",
11 "matchType":"gte",
12 "value": 1609813338000
13 },{
14 "field":"nid",
15 "fieldType":"list_s",
16 "matchType":"in",
17 "value": "vLEStZZ5jMvAInUy2R2eBfrX2AeB28RI,vLEStZZ5jMvAInUy2R2eBfrX2AeB28R2"
18 }],
19 "resultFields":["nid","title","publish_time"],
20 "pageSort":{
21 "direction": "DESC",
22 "fields":["publish_time"]
23 }
24}返回格式
JSON格式
返回参数
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| success | boolean | 是 | 成功标识 |
| code | string | 是 | 响应码：0正常，其他异常 |
| message | string | 否 | 响应描述 |
| page | object | 是 | 响应分页结果 |
| pageNo | int | 是 | 当前页码 |
| pageSize | int | 是 | 每页条数 |
| totalPages | int | 是 | 总页码 |
| totalCount | int | 是 | 总条数 |
| result | array | 否 | 分页数据 |
| 其他 | object | 是 | resultFields参数所指定的字段，该字段为空时返回所有字段 |
返回示例
Plain Text
1{
2 "success": true,
3 "code": "0",
4 "message": "success",
5 "page": {
6 "pageNo": 1,
7 "pageSize": 20,
8 "totalPages": 1,
9 "totalCount": 2,
10 "result": [
11 {
12 "nid": "vLEStZZ5jMvAInUy2R2eBfrX2AeB28RI",
13 "title": "还有比韩庚版关羽更辣眼睛的关羽吗？",
14 "publish_time": 1609768813182
15 },
16 {
17 "nid": "vLEStZZ5jMvAInUy2R2eBfrX2AeB28R2",
18 "title": "还有比韩庚版关羽更辣眼睛的关羽吗？",
19 "publish_time": 1609768813182
20 }
21 ]
22 }
23}