CobbleStone - 合約深入解析 （預覽版）

此連接器適用於以下產品和區域：

服務	Class	Regions
副駕駛工作室	進階	除下列區域外的所有 Power Automate 區域 ：      - 美國政府 （GCC）      - 美國政府（海灣合作委員會高中）      - 由 21Vianet 營運的中國雲      - 美國國防部 （DoD）
邏輯應用程式	標準	所有 Logic Apps 區域， 但下列區域除外：      - Azure Government 區域      - Azure 中國區域      - 美國國防部 （DoD）
Power Apps	進階	除下列區域外的所有 Power Apps 區域 ：      - 美國政府 （GCC）      - 美國政府（海灣合作委員會高中）      - 由 21Vianet 營運的中國雲      - 美國國防部 （DoD）
Power Automate（自動化服務）	進階	除下列區域外的所有 Power Automate 區域 ：      - 美國政府 （GCC）      - 美國政府（海灣合作委員會高中）      - 由 21Vianet 營運的中國雲      - 美國國防部 （DoD）

連絡人​​
名稱	CobbleStone 軟體
URL	https://www.cobblestonesoftware.com
Email	AppDev@cobblestonesystems.com

連接器中繼資料
Publisher	鵝卵石軟體
網站	https://www.cobblestonesoftware.com
隱私權原則	https://www.cobblestonesoftware.com/company/privacy-policy
類別	商業管理;銷售和客戶關係管理

鵝卵石

允許對我們的合約洞察軟體（新增、插入、更新）和實體的結構描述資訊進行基本操作。

發行商： CobbleStone Software

先決條件

需要 CobbleStone Software （Contact Insight） 的現有授權。

支援的作業

Get

提取具有特定條件的給定實體的記錄清單、按標籤排序、按標籤分組和記錄數。 注意：要提取的記錄數量沒有限制，但用戶必須考慮較大的結果處理速度會更慢。

加

將記錄 （每次呼叫限制為一筆記錄） 新增至指定的實體。 回應將是系統產生的 ID。

Update

使用特定準則更新指定實體/區域的記錄，並將 TriggerWorkflow 作為旗標，以便在更新要求成功或未成功後執行工作流程。 每次通話可更新的記錄數目上限為 500 筆。

Schema

列出資料表中的資料行、資料類型，以及任何限制或旗標 （NULL、長度、主索引鍵等）。

實體清單

傳回名稱清單和三個已標記的屬性，指出是否可以透過此介面編輯、更新或檢視/查詢它。

取得憑證

授權 （OAUTH 2.0）

• CobbleStone 軟體提供兩種存取授權方法：
  • 授權碼： https://oauth.net/2/grant-types/authorization-code/
  • 隱含授予： https://oauth.net/2/grant-types/implicit/

可以通過您的 CobbleStone 軟件系統設置/生成憑據。

使用者入門

若要透過 CobbleStone 軟體系統建立 API 用戶端認證，請使用下列步驟：

在您的 CobbleStone 軟體系統中，系統管理員可以導覽至下列頁面來設定/設定認證：

• 對於 SaaS 客戶： https://yourCompanyName.cobblestone.software/core/MyAPI.aspx
• 針對已部署的用戶端 （通常）： https://yourCompanyName/core/MyAPI.aspx

（注意：這是在“我的”頂部菜單項下，然後選擇“我的 API 客戶端”）

這可讓系統管理員建立 OAuth 2.0 認證 （用戶端 ID 和用戶端密碼） 以與連接器搭配使用。

從登錄您的 CobbleStone 軟件系統：

首先，您將打開 CobbleStone 軟件並進入“我的 > API 客戶端......

按一下 新增 API 用戶端 來建立新的 API 用戶端項目，並為其提供唯一名稱。 名稱只是內部的，可以是對其目的有意義的任何內容。 建議使用不同的 API 金鑰，將專案組織成小型、可管理且有目的的工作。

這將生成一個密鑰，並且只有管理員人員可以訪問該頁面。 它與生成密鑰的人綁定，他們是唯一可以看到它的人。 您可以共享他們的密鑰，但只有登錄用戶才能看到它。

此時，我們已完成 API 用戶端專案的設定。 此用戶端 ID 和用戶端安全用於連接器與您的 CobbleStone 軟體系統通訊。

已知問題和限制

目前連接器不支援傳送或接收二進位檔。

「更新」端點限制為每次點擊最多 500 個受影響的資料列。 如果需要更新超過 500 筆記錄，則需要在多個點擊中處理這些記錄。

正在建立連線

連接器支援下列驗證類型：

預設值	建立連線的參數。	所有區域	不可共享

預設

適用：所有地區

建立連線的參數。

這不是可共用的連線。 如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。

名稱	類型	Description	為必填項目
用戶端 ID - 您的 CobbleStone ClientId	字串	請輸入客戶端 ID。	對
客戶端密碼 - 您的 CobbleStone ClientSecret	securestring	請輸入客戶端密碼。	對

節流限制

名稱	呼叫	續約期間
每個連線的 API 呼叫	100	60 秒

動作

執行特定資料庫檢視	執行特定的資料庫檢視（每次呼叫僅限一筆記錄）。 回應將是狀態。
提取允許 API 使用的實體清單	傳回名稱清單和三個已標記的屬性，指出是否可以編輯、更新或檢視/查詢。
提取指定實體的記錄清單	提取具有特定條件的給定實體的記錄清單、按標籤排序、按標籤分組和記錄數。 注意：要提取的記錄數量沒有限制，但用戶必須考慮較大的結果處理速度會更慢。
提取特定實體中所有資料行的中繼資料	列出資料表中的資料行、資料類型，以及任何限制或旗標 （NULL、長度、主索引鍵等）。
提取特定資料庫檢視中所有資料行的中繼資料	列出資料庫檢視中的資料行、資料類型，以及任何限制或旗標 （NULL、長度、主索引鍵等）。
擷取可用實體清單以供選取用途	擷取可用清單這些用戶端的實體具有查詢資料的權限，內部用於動態自動填入清單方塊
擷取可用實體清單以用於插入目的	擷取可用清單這些用戶端的實體具有新增資料的權限，內部用於動態自動填入清單方塊
擷取可用實體清單以進行更新	擷取可用清單這些用戶端的實體具有更新資料的權限，內部用於動態自動填入清單方塊
擷取可用資料庫檢視的清單	擷取這些用戶端的可用資料庫檢視清單具有查詢資料的權限，內部用於動態自動填入資料庫檢視方塊
更新指定實體的記錄 （）	使用特定準則更新指定實體/區域的記錄，並將 TriggerWorkflow 作為旗標，以便在更新要求成功或未成功後執行工作流程。 每次通話可更新的記錄數目上限為 500 筆。
為指定實體建立新的記錄	將記錄 （每次呼叫限制為一筆記錄） 新增至指定的實體。 回應將是系統產生的 ID。

執行特定資料庫檢視

提取允許 API 使用的實體清單

提取指定實體的記錄清單

提取特定實體中所有資料行的中繼資料

提取特定資料庫檢視中所有資料行的中繼資料

擷取可用實體清單以供選取用途

擷取可用實體清單以用於插入目的

擷取可用實體清單以進行更新

擷取可用資料庫檢視的清單

更新指定實體的記錄 （）

為指定實體建立新的記錄

定義

APIEntityList回應

APIEntity

APISchema回應

原料藥

APIAddRequest元組

APIUpdate回應

APIAdd請求

APIQuery回應

APIViewList回應