You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

能否在OpenAPI规范中为Salesforce query接口的q参数定义Id查询子参数?

可行,两种常见实现方式

方式1:直接在q参数中嵌入动态Id

OpenAPI规范里可以将q参数定义为字符串类型,在描述中明确说明该参数接受完整的SOQL语句,允许传入包含动态Id的WHERE子句,同时用example字段展示具体用法:

paths:
  /query:
    get:
      parameters:
        - name: q
          in: query
          required: true
          schema:
            type: string
          description: Salesforce SOQL查询语句,支持通过WHERE子句指定联系人Id,格式如`SELECT Email FROM Contacts WHERE Id='{contactId}'`
          example: "SELECT Email FROM Contacts WHERE Id='ABCD1234'"

方式2:拆分参数(需后端配合)

如果想让Id成为独立的查询参数,可以额外定义contactId参数,在OpenAPI中说明服务端会自动将该参数拼接进SOQL的q参数中(这种方式需要你的后端做中转处理,因为Salesforce原生API只接受完整的q参数):

paths:
  /query:
    get:
      parameters:
        - name: contactId
          in: query
          required: true
          schema:
            type: string
          description: 联系人的Salesforce内部Id,服务端会自动将其拼接为合法的SOQL查询语句
        - name: q
          in: query
          required: false
          schema:
            type: string
          description: 可选的基础SOQL模板,默认使用`SELECT Email FROM Contacts WHERE Id='{contactId}'`

第二种方式需要后端逻辑完成参数拼接,确保最终传给Salesforce的是完整可执行的SOQL语句。

内容的提问来源于stack exchange,提问作者Brian

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.06.13 01:57:07