[B064-1]创建药物监控可以返回哪些数据？

[B064-1]创建药物监控：药物监控。完整响应结构请参见本页的响应结构与成功响应示例。

在哪里可以找到 [B064-1]创建药物监控的 OpenAPI schema？

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

[B064-1]创建药物监控

Q: [B064-1]创建药物监控 的接口地址是什么？

[B064-1]创建药物监控 的接口为 POST https://connect.zhihuiya.com/synapse/alert/drug_search/create。

post

https://connect.zhihuiya.com/synapse/alert/drug_search/create

在体验中心中试用

药物监控

请求参数

此 API 接口支持的参数列表

名称	类型	示例	描述
`events` 必填	`array`	`[ { "name": "query_result", "subEvent": [ "QUERY_RESULT" ] }, { "name": "drug_dev_status", "subEvent": [ "DISCOVERY", "PRECLINICAL", "PHASE_1", "APPROVED" ] }, { "name": "clinical_trial", "subEvent": [ "CLINICAL_TRIAL_FIRST_POSTED", "CLINICAL_TRIAL_RESULT_PUBLISHED" ] }, { "name": "patent", "subEvent": [ "PATENT_PUBLISHED", "PATENT_GRANTED" ] } ]`	事件订阅列表
`name` 必填	`string`	`drug_dev_status`	事件名称，支持： query_result（查询结果）- 监控搜索结果的变化 drug_dev_status（药物研发状态）- 监控药物研发阶段的变化 special_approval（特殊审批）- 监控特殊审批事件 clinical_trial（临床试验）- 监控临床试验相关事件 drug_deal（药物交易）- 监控药物交易事件 patent（专利）- 监控专利相关事件 paper（论文）- 监控论文发布事件 translational_medicine（转化医学）- 监控转化医学事件 news（新闻）- 监控新闻事件
`sub_event` 必填	`array`	`[ "DISCOVERY", "PRECLINICAL", "PHASE_1" ]`	子事件列表，根据事件类型不同有不同的选项： query_result（查询结果）: [QUERY_RESULT（查询结果变化）] drug_dev_status（药物研发状态）: [DISCOVERY（药物发现）, PRECLINICAL（临床前）, IND（临床试验申请）, IND_APPROVAL（临床试验批准）, EARLY_PHASE_1（早期一期）, PHASE_1（一期）, PHASE_1_2（一/二期）, PHASE_2（二期）, PHASE_2_3（二/三期）, PHASE_3（三期）, NDA_BLA（新药申请/生物制品许可申请）, APPROVED（已批准）, DISCONTINUED（已终止）, WITHDRAWN（已撤回）, SUSPENDED（已暂停）] special_approval（特殊审批）: [SPECIAL_APPROVAL（特殊审批事件）] clinical_trial（临床试验）: [CLINICAL_TRIAL_FIRST_POSTED（临床试验首次发布）, CLINICAL_TRIAL_CLINICAL_PROGRESS（临床试验进展）, CLINICAL_TRIAL_RESULT_PUBLISHED（临床试验结果发布）] drug_deal（药物交易）: [ACTIVE（激活）, TERMINATED（终止）, COMPLETED（完成）] patent（专利）: [PATENT_PUBLISHED（专利发布）, PATENT_GRANTED（专利授权）, PATENT_EXPIRE_WITHIN_FIVE_YEARS（五年内专利到期）, PATENT_EXPIRE_WITHIN_THREE_YEARS（三年内专利到期）, PATENT_EXTENSION（专利延期）] paper（论文）: [PAPER（论文发布）] translational_medicine（转化医学）: [TRANSLATIONAL_MEDICINE（转化医学事件）] news（新闻）: [NEWS（新闻事件）]
`frequency` 必填	`object`	`{ "date": 1, "type": "WEEKLY" }`	预警频率设置
`date`	`integer<int32>`	`1`	日期设置，当type为WEEKLY时：1-7（周一到周日）；当type为MONTHLY时：1-29（每月的第几天）；当type为DAILY时：此字段无效
`type` 必填	`string`	`WEEKLY`	频率类型，支持：DAILY（每日）、WEEKLY（每周）、MONTHLY（每月）
`lang` 必填	`string`	`CN`	语言设置，支持：CN（中文）、EN（英文）
`query` 必填	`object`	`{ "drug": { "value": [ "81364d1ace044fdc8af8f60026eb2c7b" ], "condition": "OR" }, "limit": 10, "offset": 0, "target": { "value": [ "928facc8122849baa0dc00759cff0380" ], "condition": "OR" }, "disease": { "value": [ "3beea980d93a4cc0abc864e27514601c" ], "condition": "OR" }, "existDeal": false, "globalHighestDevStatus": [ "Discovery", "Preclinical" ] }`	药物搜索查询条件
`offset`	`integer<int64>`	-	偏移量，默认0
`limit`	`integer<int64>`	`10`	返回条数，默认10。 offset + limit <= 10000， limit最大设置1000
`drug`	`object`	`{ "value": [ "945fa31ebe9e41ae912e493aa3324576" ], "condition": "OR" }`	药物，condition默认为OR，不支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "945fa31ebe9e41ae912e493aa3324576" ]`	值列表
`target`	`object`	`{ "value": [ "9786d32e3d244a688ec6a60d2fe1b10b" ], "condition": "OR" }`	靶点，condition默认为OR，支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "9786d32e3d244a688ec6a60d2fe1b10b" ]`	值列表
`disease`	`object`	`{ "value": [ "3beea980d93a4cc0abc864e27514601c" ], "condition": "OR" }`	适应症，condition默认为OR，不支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "3beea980d93a4cc0abc864e27514601c" ]`	值列表
`organization`	`object`	`{ "value": [ "6a8c172f1efc649035845f94c31a9c1e" ], "condition": "OR" }`	机构，condition默认为OR，不支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "6a8c172f1efc649035845f94c31a9c1e" ]`	值列表
`mechanism_action`	`object`	`{ "value": [ "4dd338b149b3ecd0ee860e1fb379b44f" ], "condition": "OR" }`	作用机制，condition默认为OR，不支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "4dd338b149b3ecd0ee860e1fb379b44f" ]`	值列表
`drug_type`	`object`	`{ "value": [ "c38eb408d6b842f487d6a27484156633" ], "condition": "OR" }`	药物类型，condition默认为OR，不支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "c38eb408d6b842f487d6a27484156633" ]`	值列表
`global_highest_dev_status`	`array`	`[ "Approved" ]`	最高研发状态。枚举值：Discovery、Preclinical、IND、IND_Approval、Early_Phase_1、Phase_1、Phase_1_2、Phase_2、Phase_2_3、Phase_3、NDA_BLA、Approved、Clinical、Pending、Discontinued、Withdraw、Suspended、Unknown。
`exist_deal`	`boolean`	`true`	是否存在交易
`dev_status`	`array`	`[ "Approved" ]`	研发状态。枚举值：Discovery、Preclinical、IND、IND_Approval、Early_Phase_1、Phase_1、Phase_1_2、Phase_2、Phase_2_3、Phase_3、NDA_BLA、Approved、Clinical、Pending、Discontinued、Withdraw、Suspended、Unknown。
`country`	`array`	`[ "US", "EU" ]`	国家地区。枚举值：US、EU、JP、CN、Other
`organization_type`	`array`	`[ "Company" ]`	机构类型。枚举值：Company、University_Institution、Other
`employee_number`	`array`	`[ "GREATER_THAN_500" ]`	雇员数量。枚举值：LESS_THAN_10、BETWEEN_10_AND_100、BETWEEN_100_AND_500、GREATER_THAN_500
`start_up`	`boolean`	-	是否初创公司
`sort`	`array`	`[ { "sort_field": "DRUG_TYPE_SORT", "sort_order": "desc" }, { "sort_field": "GLOBAL_HIGHEST_DEV_STATUS_RANK", "sort_order": "desc" }, { "sort_field": "FIRST_APPROVED_DATE", "sort_order": "desc" } ]`	字段排序，field支持：DRUG_TYPE_SORT, GLOBAL_HIGHEST_DEV_STATUS_RANK, FIRST_APPROVED_DATE；order支持desc, asc（默认desc）
`sort_field`	`string`	`DRUG_TYPE_SORT`	排序字段，枚举值：DRUG_TYPE_SORT, GLOBAL_HIGHEST_DEV_STATUS_RANK, FIRST_APPROVED_DATE
`sort_order`	`string`	`desc`	排序方式，支持：desc,asc
`title` 必填	`string`	`我的药物预警`	预警标题

请求示例

该 API 接口的请求体示例

JSON

{
  "lang": "CN",
  "query": {
    "drug": {
      "value": [
        "945fa31ebe9e41ae912e493aa3324576"
      ],
      "condition": "OR"
    },
    "sort": [
      {
        "sort_field": "DRUG_TYPE_SORT",
        "sort_order": "desc"
      }
    ],
    "limit": 10,
    "offset": 0,
    "target": {
      "value": [
        "9786d32e3d244a688ec6a60d2fe1b10b"
      ],
      "condition": "OR"
    },
    "country": [
      "US",
      "EU"
    ],
    "disease": {
      "value": [
        "3beea980d93a4cc0abc864e27514601c"
      ],
      "condition": "OR"
    },
    "start_up": false,
    "drug_type": {
      "value": [
        "c38eb408d6b842f487d6a27484156633"
      ],
      "condition": "OR"
    },
    "dev_status": [
      "Approved"
    ],
    "exist_deal": true,
    "organization": {
      "value": [
        "6a8c172f1efc649035845f94c31a9c1e"
      ],
      "condition": "OR"
    },
    "employee_number": [
      "GREATER_THAN_500"
    ],
    "mechanism_action": {
      "value": [
        "4dd338b149b3ecd0ee860e1fb379b44f"
      ],
      "condition": "OR"
    },
    "organization_type": [
      "Company"
    ],
    "global_highest_dev_status": [
      "Approved"
    ]
  },
  "title": "我的药物预警",
  "events": [
    {
      "name": "drug_dev_status",
      "sub_event": [
        "DISCOVERY",
        "PRECLINICAL",
        "PHASE_1"
      ]
    }
  ],
  "frequency": {
    "date": 1,
    "type": "WEEKLY"
  }
}

响应结构

API 响应数据的结构说明

字段名	类型	示例	描述
`data`	`object`	-	响应数据
`alert_id`	`string`	`561a206a-25c5-4883-be9a-b48eb55edba2`	邮件提醒ID
`status` 必填	`boolean`	`false`	状态
`error_msg`	`string`	`The request parameter format is incorrect！`	错误信息
`error_code` 必填	`integer`	`0`	错误代码

成功响应示例

成功调用 API 的响应示例

JSON

{
  "data": {
    "alert_id": "561a206a-25c5-4883-be9a-b48eb55edba2"
  },
  "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