使用增強的 API Designer 增強您的整合！

我們很高興地宣布我們對 API Designer 模組進行了重大增強。

這些增強功能將使您能夠建立更有效率、更強大的自訂 API。他們專注於改進批量操作、擴展精選 API 功能以及增強多種現場條件的使用。

讓我們深入了解這些增強功能的詳細資訊：

增強功能1：支援UPDATE/UPSERT記錄批次操作

API Designer：批次操作支持

使用最新更新，您可以執行批次操作來更新或更新插入記錄。此增強功能可讓您在單一請求中建立或更新多個記錄，從而使您的 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 Designer：增強的 Select API

我們擴充了 Select API 的功能，以包含參考欄位模組中的欄位。此增強功能可讓您在單一請求中取得全面的資料。

主要功能：

  • 以前，Select API 只能從目前模組檢索欄位。
  • 現在，您也可以從參考欄位模組中選擇欄位。

範例用例 - 案例和聯絡人關係 (N:1)：

  • 取得案件記錄以及相關聯絡人的電話號碼。
  • 檢索案例記錄以及聯絡人的名字和姓氏。
  • 取得「分配給」用戶的手機號碼和全名的案例記錄。
 

此增強功能簡化了您的工作流程，減少了批次操作所需的 API 呼叫數量。

增強功能2：選擇API支援返回父模組字段

API Designer：增強的 Select 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 Designer：高級Where 子句

透過此更新，您可以在 Select 查詢的Where 條件中使用多個欄位。此增強功能為過濾資料提供了更大的靈活性和精確度。

主要功能：

  • 多字段條件：在where條件中新增目前模組或引用字段模組中的多個字段。
  • Glue 參數：使用glue 參數（glue="or" 或glue="and"）來組合多個條件。

範例用例 - 簡單模組：

  • 使用glue="or" 在「銷售階段」和「潛在客戶來源」上新增條件。
  • 在Where 條件中包含參考字段，例如contact_id 和 related_to。
 

此增強功能可讓您存取詳細且互連的數據，從而簡化數據檢索過程。

增強功能 3：在Where子句中新增了對多個欄位條件的支持

API Designer：高級Where 子句

透過此更新，您可以在 Select 查詢的Where 條件中使用多個欄位。此增強功能為過濾資料提供了更大的靈活性和精確度。

主要功能：

  • 多字段條件：在where條件中新增目前模組或引用字段模組中的多個字段。
  • Glue 參數：使用glue 參數（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)。
  • 綜合條件： 使用glue="or" 在 contact_id 和 related_to 上新增條件。如果一個或兩個參數值匹配，則將傳回回應。
 

複雜的例子： 您也可以新增涉及相關模組中的引用欄位的條件。例如：

  • 關係： 交易和聯絡人之間以及交易和客戶之間都存在關係 (N:1)。
  • 綜合條件： 使用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 模組的體驗，使其更加通用和強大。我們鼓勵您探索這些新功能，看看它們如何使您的開發專案受益。

敬請期待更多的更新。

編碼愉快！
 
 

註冊以接收最新更新！

 
 

版權所有2025 Vtiger。 版權所有。 各自所有者擁有的各種商標。