[B056] 字典查询的接口地址是什么？

[B056] 字典查询的接口为 POST https://connect.zhihuiya.com/synapse/dictionary/search。

[B056] 字典查询可以返回哪些数据？

[B056] 字典查询：通过输入关键字或选择字典类型，获取字典ID。完整响应结构请参见本页的响应结构与成功响应示例。

在哪里可以找到 [B056] 字典查询的 OpenAPI schema？

OpenAPI schema 位于 /openapi.json#/paths/~1synapse~1dictionary~1search/post，也可在 /openapi.json 浏览完整规范。

[B056] 字典查询

Q: [B056] 字典查询 的接口地址是什么？

[B056] 字典查询 的接口为 POST https://connect.zhihuiya.com/synapse/dictionary/search。

post

https://connect.zhihuiya.com/synapse/dictionary/search

在体验中心中试用

通过输入关键字或选择字典类型，获取字典ID

请求参数

此 API 接口支持的参数列表

名称	类型	示例	描述
`dict_type`	`string`	`PATENT_TECHNOLOGY`	字典类型，字段支持PATENT_TECHNOLOGY：专利技术类型；AUTHORITY_COUNTRY：受理局；HOT_CONFERENCE：临床结果大会；
`id`	`string`	`acb92aec02da415d9b5b593529add328`	字典ID
`keyword`	`string`	`CAR-X细胞疗法`	关键字
`limit`	`integer<int64>`	`10`	返回条数
`offset`	`integer<int64>`	-	偏移量
`parent_id`	`string`	`57fb4219e73247fcb69dec21b582a716`	父字典ID
`search_tree`	`boolean`	-	是否是层级搜索
`sort`	`array`	`[ { "sort_field": "NAME_EN_SORT", "sort_order": "desc" } ]`	排序
`sort_field`	`string`	`NAME_EN_SORT`	排序字段
`sort_order`	`string`	`desc`	升序、降序

请求示例

该 API 接口的请求体示例

JSON

{
  "id": "acb92aec02da415d9b5b593529add328",
  "sort": [
    {
      "sort_field": "NAME_EN_SORT",
      "sort_order": "desc"
    }
  ],
  "limit": 10,
  "offset": 0,
  "keyword": "CAR-X细胞疗法",
  "dict_type": "PATENT_TECHNOLOGY",
  "parent_id": "57fb4219e73247fcb69dec21b582a716",
  "search_tree": false
}

响应结构

API 响应数据的结构说明

字段名	类型	示例	描述
`data`	`object`	-	响应数据
`items`	`array`	`[ { "id": "8666aad5477e4272b56b94ca1183781d", "name": "药物发现" } ]`	字典List
`dict_id`	`string`	`9a847883d786485489d0ee1d75ae90ba`	字典ID
`display_name`	`array`	`双特异性抗体`	字典名称
`lang`	`string`	`EN`	语言
`name`	`string`	`Ranibizumab (Genentech)`	药物、靶点、机构、适应症、国家/地区、字典、作用机制名称
`limit`	`integer<int64>`	`10`	返回条数
`total`	`integer<int64>`	`100`	字典总数
`offset`	`integer<int64>`	-	偏移量
`status` 必填	`boolean`	`false`	状态
`error_msg`	`string`	`The request parameter format is incorrect！`	错误信息
`error_code` 必填	`integer`	`0`	错误代码

成功响应示例

成功调用 API 的响应示例

JSON

{
  "data": {
    "items": [
      {
        "dict_id": "9a847883d786485489d0ee1d75ae90ba",
        "display_name": [
          {
            "lang": "EN",
            "name": "Ranibizumab (Genentech)"
          }
        ]
      }
    ],
    "limit": 10,
    "total": 100,
    "offset": 0
  },
  "status": true,
  "error_code": 0
}

错误码

此接口可能返回的错误码列表

业务错误码

错误码	描述
`68300004`	请求参数异常!
`68300005`	查询Api失败!
`68300006`	解析基本存取错误!
`68300007`	存在错误的请求!
`68300008`	服务中断异常，请稍后再试!
`68300010`	文件不符合上传规范!

平台错误码

错误码	描述
`67200000`	API整体限流错误!
`67200001`	API整体限流错误！
`67200002`	当前调用速率过快,超过当前配置限制QPS！
`67200003`	申请token的key和secret传参不正确或者客户端已被禁用！
`67200004`	请求的接口无权限请联系我们的支持人员！
`67200005`	账户余额/调用次数不足！
`67200006`	客户端超过开通有效期！
`67200007`	当前调用超过当天配置使用额度！
`67200008`	请检查query参数中必填的apikey是否传输！
`67200009`	apikey与所传的bearerToken不匹配,请检查是否使用在有效期内的token！
`67200012`	请求不合法！
`67200100`	当前服务器状态正忙,请求响应超时！
`67200101`	当前请求的Api不存在请检查请求Path！

HTTP 状态码

状态码	描述
`0`	请求成功
`201`	Created
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found

性能指标

此接口的预期性能特征

正常响应时间

5000 ms

最大响应时间

10000 ms