通过增强的 API 设计器增强您的集成！

我们很高兴地宣布我们对 API Designer 模块做出了重大改进。

这些增强功能将使您能够构建更高效、更强大的自定义 API。它们专注于改进批量操作、扩展选择 API 功能以及增强多个字段条件的使用。

让我们深入了解这些增强功能的细节：

增强功能1：支持UPDATE/UPSERT记录的批量操作

API 设计器：批量操作支持

使用最新更新，您可以执行批量操作来更新或插入记录。此增强功能允许您在单个请求中创建或更新多个记录，从而使您的 API 交互高效且省时。

主要特征：

  • 创建 API： 通过传递参数bulk="true"在单个请求中创建多个记录。 相关文件
  • 更新 API： 以前，每个请求只能更新一条记录。现在，您可以通过匹配 Where 条件在单个请求中更新多条记录。 相关文件

批量记录限制：50

示例用例：

联系人模块： 使用单个请求更新任意字段的多个记录。例如，您可以通过匹配特定条件来更新多个联系人记录，如果不存在则创建新的记录。

 

  
<?xml version="1.0"?>
   <api method="post" module="Contacts">
        <upsert bulk="true">
             <where>
                <field name="mobile" condition="eq" value="@mobile"></field>  
            </where>
            <update>
               <record>
                   <field name="mobile" value="@mobile"></field>
                   <field name="email" value="@email" presence="optional"></field>
                   <field name="lastname" value="@lastname" presence="optional"></field>
               </record>
            </update>
            <create module="Contacts" bulk="true">
                <record>
                   <field name="mobile" value="@mobile"></field>
                   <field name="email" value="@email" presence="optional"></field>
                   <field name="lastname" value="@lastname" presence="optional"></field>
               </record>
            </create>
            <return>
                <field name="mobile"></field>
                <field name="email"></field>
                <field name="lastname"></field>
            </return>
        </upsert>
    </api>




  
<?xml version="1.0"?>
   <api method="post" module="Contacts">
        <upsert bulk="true">
             <where>
                <field name="mobile" condition="eq" value="@mobile"></field>  
            </where>
            <update>
               <record>
                   <field name="mobile" value="@mobile"></field>
                   <field name="email" value="@email" presence="optional"></field>
                   <field name="lastname" value="@lastname" presence="optional"></field>
               </record>
            </update>
            <create module="Contacts" bulk="true">
                <record>
                   <field name="mobile" value="@mobile"></field>
                   <field name="email" value="@email" presence="optional"></field>
                   <field name="lastname" value="@lastname" presence="optional"></field>
               </record>
            </create>
            <return>
                <field name="mobile"></field>
                <field name="email"></field>
                <field name="lastname"></field>
            </return>
        </upsert>
    </api>
 

此增强功能简化了您的工作流程，减少了批量操作所需的 API 调用次数。

增强功能2：选择API支持返回父模块字段

API 设计器：增强型选择 API

我们扩展了 Select API 的功能，使其包含来自参考字段模块的字段。此增强功能可让您在单个请求中获取全面的数据。

主要特征：

  • 以前，Select API 只能从当前模块检索字段。
  • 现在，您也可以从参考字段模块中选择字段。

用例示例 - 案例和联系人关系 (N:1)：

  • 获取案件记录以及相关联系人的电话号码。
  • 检索案例记录以及联系人的名字和姓氏。
  • 获取包含‘分配给’用户的手机号码和全名的案例记录。
 

此增强功能简化了您的工作流程，减少了批量操作所需的 API 调用次数。

增强功能2：选择API支持返回父模块字段

API 设计器：增强型选择 API

我们扩展了 Select API 的功能，使其包含来自参考字段模块的字段。此增强功能可让您在单个请求中获取全面的数据。

主要特征：

  • 以前，Select API 只能从当前模块检索字段。
  • 现在，您也可以从参考字段模块中选择字段。

用例示例 - 案例和联系人关系 (N:1)：

  • 获取案件记录以及相关联系人的电话号码。
  • 检索案例记录以及联系人的名字和姓氏。
  • 获取包含‘分配给’用户的手机号码和全名的案例记录。
 

  
<?xml version="1.0"?>
<api method="get">
    <select module="Cases">
        <record>
            <field name="title"></field>
            <field name="casestatus"></field>
            <field name="assigned_user_id"></field>
            <field name="createdtime"></field>
            <field name="case_no"></field>
            <field name="assigned_user_id" module="Users">
                <select>
                    <field name="first_name"></field>
                    <field name="last_name"></field>
                    <field name="userlabel"></field>
                </select>
            </field>
            <field name="contact_id" module="Contacts">
                <select>
                    <field name="firstname"></field>
                    <field name="lastname"></field>
                    <field name="mobile"></field>
                </select>
            </field>
            <field name="group_id" module="Groups">
                <select>
                    <field name="groupname"></field>
                </select>
            </field>
        </record>
        <where>
            <field name="contact_id" module="Contacts">
                <select>
                    <where>
                        <field name="lastname" value="@name"></field>
                    </where>
                </select>
            </field>
        </where>
    </select>
</api>




  
<?xml version="1.0"?>
<api method="get">
    <select module="Cases">
        <record>
            <field name="title"></field>
            <field name="casestatus"></field>
            <field name="assigned_user_id"></field>
            <field name="createdtime"></field>
            <field name="case_no"></field>
            <field name="assigned_user_id" module="Users">
                <select>
                    <field name="first_name"></field>
                    <field name="last_name"></field>
                    <field name="userlabel"></field>
                </select>
            </field>
            <field name="contact_id" module="Contacts">
                <select>
                    <field name="firstname"></field>
                    <field name="lastname"></field>
                    <field name="mobile"></field>
                </select>
            </field>
            <field name="group_id" module="Groups">
                <select>
                    <field name="groupname"></field>
                </select>
            </field>
        </record>
        <where>
            <field name="contact_id" module="Contacts">
                <select>
                    <where>
                        <field name="lastname" value="@name"></field>
                    </where>
                </select>
            </field>
        </where>
    </select>
</api>
 

此增强功能使您能够访问详细且相互关联的数据，从而简化数据检索过程。

增强功能 3：在 Where 子句中增加了对多个字段条件的支持

API 设计器：高级 Where 子句

通过此更新，您可以在 Select 查询的 Where 条件中使用多个字段。此增强功能为筛选数据提供了更大的灵活性和精确度。

主要特征：

  • 多字段条件：从当前模块添加多个字段或者在 where 条件中引用字段模块。
  • 粘合参数：使用粘合参数（glue="or" 或 glue="and"）来组合多个条件。

示例用例 - 简单模块：

  • 使用 glue="or" 在“销售阶段”和“潜在客户来源”上添加条件。
  • 在 Where 条件中包含参考字段，例如 contact_id 和 related_to。
 

此增强功能使您能够访问详细且相互关联的数据，从而简化数据检索过程。

增强功能 3：在 Where 子句中增加了对多个字段条件的支持

API 设计器：高级 Where 子句

通过此更新，您可以在 Select 查询的 Where 条件中使用多个字段。此增强功能为筛选数据提供了更大的灵活性和精确度。

主要特征：

  • 多字段条件：从当前模块添加多个字段或者在 where 条件中引用字段模块。
  • 粘合参数：使用粘合参数（glue="or" 或 glue="and"）来组合多个条件。

示例用例 - 简单模块：

  • 使用 glue="or" 在“销售阶段”和“潜在客户来源”上添加条件。
  • 在 Where 条件中包含参考字段，例如 contact_id 和 related_to。
 

  
<?xml version="1.0"?>
<api method="get">
    <select module="Potentials">
        <record>
            <field name="potentialname"></field>
            <field name="amount"></field>
            <field name="assigned_user_id"></field>
            <field name="createdtime"></field>
        </record>
        <where glue="or">
            <field name="sales_stage" value="@sales_stage" presence="optional"></field>
            <field name="leadsource" value="@leadsource" presence="optional"></field>
        </where>
    </select>
</api>




  
<?xml version="1.0"?>
<api method="get">
    <select module="Potentials">
        <record>
            <field name="potentialname"></field>
            <field name="amount"></field>
            <field name="assigned_user_id"></field>
            <field name="createdtime"></field>
        </record>
        <where glue="or">
            <field name="sales_stage" value="@sales_stage" presence="optional"></field>
            <field name="leadsource" value="@leadsource" presence="optional"></field>
        </where>
    </select>
</api>
 

复杂示例： 您还可以添加涉及相关模块的参考字段的条件。例如：

  • 关系： 交易和联系人之间存在关系 (N:1)，交易和账户之间也存在关系 (N:XNUMX)。
  • 合并条件： 使用 glue="or" 在 contact_id 和 related_to 上添加条件。如果其中一个或两个参数值匹配，则返回响应。
 

复杂示例： 您还可以添加涉及相关模块的参考字段的条件。例如：

  • 关系： 交易和联系人之间存在关系 (N:1)，交易和账户之间也存在关系 (N:XNUMX)。
  • 合并条件： 使用 glue="or" 在 contact_id 和 related_to 上添加条件。如果其中一个或两个参数值匹配，则返回响应。

 

  
<?xml version="1.0"?>
<api method="get">
    <select module="Potentials">
        <record>
            <field name="potentialname"></field>
            <field name="amount"></field>
            <field name="assigned_user_id"></field>
            <field name="createdtime"></field>
        </record>
        <where glue="OR">
               <field name="contact_id" module="Contacts">
                   <select>
                       <where>
                           <field name="mobile" condition="eq" value="@mobile" presence="optional"></field>
                       </where>
                    </select>
               </field>
               <field name="related_to" module="Accounts">
                    <select>
                         <where>
                             <field name="phone" condition="eq" value="@phone" presence="optional"></field>
                         </where>
                    </select>
                </field>
            </where>
    </select>
</api>




  
<?xml version="1.0"?>
<api method="get">
    <select module="Potentials">
        <record>
            <field name="potentialname"></field>
            <field name="amount"></field>
            <field name="assigned_user_id"></field>
            <field name="createdtime"></field>
        </record>
        <where glue="OR">
               <field name="contact_id" module="Contacts">
                   <select>
                       <where>
                           <field name="mobile" condition="eq" value="@mobile" presence="optional"></field>
                       </where>
                    </select>
               </field>
               <field name="related_to" module="Accounts">
                    <select>
                         <where>
                             <field name="phone" condition="eq" value="@phone" presence="optional"></field>
                         </where>
                    </select>
                </field>
            </where>
    </select>
</api>
 

此增强功能使您能够创建更复杂、更精细的查询，确保您准确检索所需的数据。

我们相信这些增强功能将显著改善您使用 API Designer 模块的体验，使其更加通用和强大。我们鼓励您探索这些新功能，看看它们如何使您的开发项目受益。

敬请期待更多的更新。

编码愉快！
 

此增强功能使您能够创建更复杂、更精细的查询，确保您准确检索所需的数据。

我们相信这些增强功能将显著改善您使用 API Designer 模块的体验，使其更加通用和强大。我们鼓励您探索这些新功能，看看它们如何使您的开发项目受益。

敬请期待更多的更新。

编码愉快！
 
 

注册以接收最新更新！

 
 

版权所有2026 Vtiger。 版权所有。 各自所有者拥有的各种商标。