ServiceNow
ServiceNow 提高了服務水平，激發了員工的活力，並使您的企業能夠以光速工作。 創建、讀取和更新存儲在 ServiceNow 中的記錄，包括事件、問題、用戶等。
此連接器適用於以下產品和區域：
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 ： - 由 21Vianet 營運的中國雲 |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域， 但下列區域除外： - 美國國防部 （DoD） |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 ： - 由 21Vianet 營運的中國雲 |
| Power Automate（自動化服務） | 進階 | 除下列區域外的所有 Power Automate 區域 ： - 由 21Vianet 營運的中國雲 |
| 連絡人 | |
|---|---|
| 名稱 | Microsoft |
| URL | https://learn.microsoft.com/connectors/service-now/ |
| 連接器中繼資料 | |
|---|---|
| Publisher | Microsoft |
| 網站 | https://www.servicenow.com/ |
| 隱私策略 | https://www.servicenow.com/privacy-statement.html |
| 類別 | 網站 |
備註
「取得知識文章」作業只能在啟用 知識 API （sn_km_api） 外掛程式時使用。
已知問題和限制
使用「 建立記錄 」動作時，無法指定完整的記錄描述。 由於 REST API 的 Service-Now 限制，欄位值將被忽略。
取得記錄動作可能會傳回 Power Apps 中的「無效資料表」或其他錯誤。 對於 Power Apps 實作，建議的因應措施是利用 Power Automate 中的取得記錄動作，並將資料傳回 Power Apps。
連接器目前僅支援以「service-now.com」結尾的執行個體 URL。 使用替代網域（例如「servicenowservices.com」）可能會導致連線錯誤。 在這種情況下，特別是在 GCC 中使用新的 ServiceNow 網域時，建議使用基本驗證。
如果您遇到彈出錯誤，指出「無效redirect_uri」，請從彈出視窗複製完整 URL 並提取redirect_uri參數（例如，redirect_uri=https%3a%2f%2ftip1-shared.consent.azure-apim.net%2fredirect）。 解碼 URL 之後 （將 %3a 取代為 ：，將 %2f 取代為 /），更新 ServiceNow 執行個體的 OAuth 應用程式登錄中的重新導向 URL 欄位，如下圖所示。 然後，嘗試重新新增連線。
如何設定使用 Microsoft Entra ID 的 ServiceNow Power Platform 連線
有兩種連線類型：
使用憑證的 Microsoft Entra ID OAuth：這是以應用程式權杖為基礎的驗證類型，其中在 Entra ID 中註冊的應用程式可用來存取 ServiceNow，方法是取得資源設定為 ServiceNow 代表 Entra ID 應用程式的權杖。
使用使用者登入的 Microsoft Entra ID OAuth：這是以使用者權杖為基礎的驗證類型，使用者可以在其中登入 Entra ID 1P 應用程式 （ServiceNow 連接器 1p 應用程式） ，並取得具有針對 ServiceNow 代表 Entra ID 應用程式設定範圍的存取權杖。
使用憑證建立 Microsoft Entra ID OAuth 連線的步驟
步驟 1：在 Microsoft Entra ID 中註冊「應用程式 A」，以便 OIDC 與 ServiceNow 整合。 這是 ServiceNow 代表 Entra ID 應用程式。
移至 [應用程式註冊] [新增註冊] > 以建立新的應用程式註冊
名稱：任何選擇的名稱
重新導向 URI：不需要
將 和
audemail新增至upn「選擇性宣告」下的宣告
步驟 2：在 ServiceNow 中註冊與 OIDC 提供者相同的 ID
導覽至
System OAuth > Application Registry > New > Configure an OIDC provider以驗證 ID 權杖- 名稱：任何選擇的名稱
-
用戶端 ID：
client ID在步驟 1 中建立的「應用程式 A」的 - 客戶端密碼：這實際上不會被使用，可以設置任何值
在 OIDC 提供者註冊表單中，新增新的 OIDC 提供者配置。 選取 OAuth OIDC 提供者組態 欄位的搜尋圖示，以開啟 OIDC 組態的記錄，選取 [新增]。
- OIDC 提供者：Microsoft Entra ID
-
OIDC 中繼資料 URL：URL 必須採用 的形式，
https://login.microsoftonline.com/<tenantID>/.well-known/openid-configuration取代tenantID為Directory (tenant) ID - OIDC 組態快取生命週期：120
- 應用：全球
- 用戶聲明：oid
- 使用者欄位：使用者ID
- 啟用 JTI 宣告驗證：已停用
選取「提交」並更新 OAuth OIDC 實體表單
步驟 3：在 Microsoft Entra ID 中註冊「應用程式 B」以供連接器使用。 這是應用程式，在 ServiceNow 執行個體中扮演具有提升權限的使用者角色
導覽至
App registrations > New registration以建立新應用程式- 名稱：任何選擇的名稱
- 在 憑證和密碼中，上傳憑證的.cer檔案，如果是 SNI 憑證，只需在應用程式清單中新增
trustedCertificateSubjects相關authorityId和subjectName
第 4 步：在 ServiceNow 中創建系統用戶。 這是 ServiceNow 執行個體中作為使用者的「應用程式 B」
導覽至
User Administration > Users以建立新使用者- 使用者識別碼：在步驟 3 中建立的「應用程式 B」服務主體的物件識別碼
- 檢查
Web service access only
步驟 5：使用連接器連線 – Copilot Studio – 連接器設定
使用下列資訊設定連接器並連線：
- 實例名稱：ServiceNow 的實例名稱
- 租用戶識別碼：Microsoft Entra 租用戶的租用戶識別碼
- 用戶端 ID：步驟 3 中建立的「應用程式 B」的用戶端 ID
- 資源 URI：在步驟 1 中建立的「應用程式 A」的用戶端識別碼 （不是 應用程式 URI）
- 用戶端憑證密碼：在步驟 3 中建立之憑證的 .pfx 檔案
- 憑證密碼：.pfx 檔案的密碼
建立 Microsoft Entra ID OAuth 使用者登入的步驟
若要設定 Microsoft Entra ID OAuth 使用者登入連線，請完成上述憑證驗證一節所述的步驟 1 和步驟 2。
步驟 1 保持不變。 在步驟 2 中，將使用者宣告更新為 Upn 或自訂宣告屬性，從權杖 （適用於 Entra 以外的第三方身分識別提供者） 。 使用者欄位應該符合包含 upn 或使用者識別碼的 ServiceNow 系統使用者資料表欄位。
不需要上述憑證驗證區段中的步驟 3 和 4。 相反地，在本例中，「應用程式 B」是為 ServiceNow 連接器建立的 1p 應用程式。 以下應用程式需要在「應用程式A」中授予權限。
「應用程式B」ID： c26b24aa-7874-4e06-ad55-7d06b1f79b63
這很重要
在此案例中，「應用程式 B」必須使用 ID c26b24aa-7874-4e06-ad55-7d06b1f79b63 ，這是 Microsoft 所擁有的預先存在的 1p 應用程式，而不是使用者建立的應用程式 （使用憑證建立 Microsoft Entra ID OAuth 連線所需的應用程式）。
建立 ServiceNow 連接器的連線時，使用者必須選取 [Microsoft Entra ID 使用者登入] 作為驗證類型，而且只需要提供 ServiceNow 執行個體名稱和資源識別碼 （會是「應用程式 A」） 的識別碼。 此後，登入按鈕將引導使用者使用自己的帳戶完成 Entra ID 登入。
使用第三方身分識別提供者，或 Entra ID 中的使用者與 ServiceNow 使用者資料表之間存在資料不相符
- 如果 Entra ID 權杖中的使用者識別碼屬性與 ServiceNow 資料表中的使用者識別碼值不相符
- 例如，權杖包含完整的 upn （以及網域 –
abc@contoso.com），而 ServiceNow 使用者資料表僅包含使用者識別碼 （abc）。 建議您套用公式，將自訂屬性新增至權杖，其中包含符合 ServiceNow 識別碼中使用者識別碼的值，然後利用該新屬性在步驟 2 中執行宣告對應。 - 描述新增宣告屬性程式的 Microsoft Learn 檔： https://learn.microsoft.com/entra/external-id/customers/how-to-add-attributes-to-token
- 例如，權杖包含完整的 upn （以及網域 –
「如何設定使用 Microsoft Entra ID 的 ServiceNow Power Platform 連線」參考：
正在建立連線
連接器支援下列驗證類型：
| 基本驗證 | 使用基本驗證登入 | 所有區域 | 不可共享 |
| 使用憑證的 Microsoft Entra ID OAuth | 使用 PFX 憑證與 Microsoft Entra ID 的 OAuth。 | 僅限 POWERPLATFORM | 可共用 |
| Microsoft Entra ID 使用者登入 | 使用 Microsoft Entra ID 認證登入 | 所有區域 | 不可共享 |
| 使用 Oauth2 | 使用 Oauth2 登入 | 所有區域 | 不可共享 |
| 預設值 [已棄用] | 此選項僅適用於沒有明確驗證類型的舊連線，並且僅用於回溯相容性。 | 所有區域 | 不可共享 |
基本身份驗證
驗證 ID：basicAuthentication
適用：所有地區
使用基本驗證登入
這不是可共用的連線。 如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 實例 | 字串 | service-now.com 的執行個體名稱或已移轉帳戶的自訂 URL | 對 |
| 用戶名稱 | 字串 | 此實例的使用者名稱 | 對 |
| 密碼 | securestring | 此帳戶的密碼 | 對 |
使用憑證的 Microsoft Entra ID OAuth
驗證識別碼：aadOAuthCert
適用：僅限 POWERPLATFORM
使用 PFX 憑證與 Microsoft Entra ID 的 OAuth。
這是可共享的連接。 如果 Power App 與其他使用者共用，也會共用連線。 如需詳細資訊，請參閱 畫布應用程式的連接器概觀 - Power Apps |Microsoft 文件
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 實例名稱 | 字串 | 用來識別 ServiceNow 站台 URl 的執行個體名稱 | 對 |
| 租戶識別碼 | 字串 | 對 | |
| 用戶端識別碼 | 字串 | 對 | |
| 資源 URI | 字串 | 對 | |
| 用戶端憑證密碼 | 客戶憑證 | 此應用程式允許的用戶端憑證密碼 | 對 |
Microsoft Entra ID 使用者登入
驗證識別碼：entraIDUserLogin
適用：所有地區
使用 Microsoft Entra ID 認證登入
這不是可共用的連線。 如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 資源 URI | 字串 | 對 | |
| 實例名稱 | 字串 | 用來識別 ServiceNow 網站 URL 的執行個體名稱 | 對 |
使用 Oauth2
驗證 ID：oauth2ServiceNow
適用：所有地區
使用 Oauth2 登入
這不是可共用的連線。 如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 實例名稱 | 字串 | 用來識別 ServiceNow 站台 URl 的執行個體名稱 | 對 |
| 用戶端識別碼 | 字串 | 用來向服務提供者識別此應用程式的 ID | 對 |
| 客戶端密碼 | securestring | 用來向服務提供者驗證此應用程式的共用密碼 | 對 |
預設值 [已棄用]
適用：所有地區
此選項僅適用於沒有明確驗證類型的舊連線，並且僅用於回溯相容性。
這不是可共用的連線。 如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 實例 | 字串 | service-now.com 的執行個體名稱或已移轉帳戶的自訂 URL | 對 |
| 用戶名稱 | 字串 | 此實例的使用者名稱 | 對 |
| 密碼 | securestring | 此帳戶的密碼 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 600 | 60 秒 |
動作
| 上傳分段檔案附件 （預覽版） |
從分段表單上傳附件 |
| 列出記錄 |
取得特定 ServiceNow 物件類型的記錄，例如「事件」 |
| 刪除記錄 |
刪除 ServiceNow 物件類型的記錄，例如「事件」 |
| 刪除附件 （預覽版） |
刪除附件 |
| 取得目錄 |
擷取目錄清單 |
| 取得目錄項目 |
擷取特定目錄項目。 |
| 取得目錄項目 |
根據指定的參數擷取目錄項目清單，例如搜尋文字或目錄。 |
| 取得目錄類別 |
擷取特定型錄的種類清單 |
| 取得知識文章 |
傳回可搜尋和篩選的知識庫 （KB） 文章清單 |
| 取得記錄類型 |
列出可用的記錄類型 |
| 取得附件中繼資料 （預覽版） |
擷取附件的中繼資料 |
| 將二進位檔案上傳為附件 （預覽） |
將二進位檔案作為附件上傳至指定記錄 |
| 建立記錄 |
在 ServiceNow 資料表中建立記錄。 |
| 擷取附件中繼資料 （預覽版） |
擷取附件中繼資料 |
| 擷取附件內容 （預覽版） |
擷取附件內容 |
| 更新記錄 |
更新 ServiceNow 物件類型的記錄，例如「事件」 |
| 獲取記錄 |
取得 ServiceNow 物件類型的記錄，例如「事件」 |
| 訂購項目 |
訂購或購買特定目錄項目。 |
上傳分段檔案附件 （預覽版）
從分段表單上傳附件
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
附件內容
|
attachment_content | True | file |
要上傳的附件 |
|
資料表名稱
|
table_name | True | string |
您要附加檔案的資料表名稱。 |
|
資料表識別碼
|
table_sys_id | True | string |
您要附加檔案之指定表格上記錄的Sys_id |
傳回
列出記錄
取得特定 ServiceNow 物件類型的記錄，例如「事件」
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
記錄類型
|
tableType | True | string |
要列出的記錄類型 |
|
顯示系統參考
|
sysparm_display_value | boolean |
決定是否應包含系統參照 |
|
|
排除參考連結
|
sysparm_exclude_reference_link | boolean |
決定是否應排除參考連結 |
|
|
Query
|
sysparm_query | string |
用來篩選結果集的編碼查詢。 範例：active=true^ORDERBYnumber^ORDERBYDESCcategory |
|
|
限制
|
sysparm_limit | integer |
套用在分頁上的限制。 預設值為 10000。 |
|
|
Offset
|
sysparm_offset | integer |
要從查詢中排除的記錄數。 |
|
|
Fields
|
sysparm_fields | string |
要傳回的欄位以逗點分隔的清單。 範例：姓名、電子郵件、電話 |
傳回
刪除記錄
刪除 ServiceNow 物件類型的記錄，例如「事件」
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
記錄類型
|
tableType | True | string |
要列出的記錄類型 |
|
系統標識碼
|
sysid | True | string |
記錄的系統 ID。 |
刪除附件 （預覽版）
刪除附件
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
系統識別碼
|
sys_id | True | string |
要刪除的附件Sys_id |
取得目錄
擷取目錄清單
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
限制
|
sysparm_limit | integer |
要擷取的目錄數目 |
|
|
搜尋文字
|
sysparm_text | string |
搜尋文字以依名稱或描述篩選目錄 |
傳回
取得目錄項目
擷取特定目錄項目。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
項目 ID
|
sys_id | True | string |
要擷取的型錄項目sys_id |
傳回
取得目錄項目
根據指定的參數擷取目錄項目清單，例如搜尋文字或目錄。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
類別
|
sysparm_category | string |
要篩選專案的類別識別碼。 如果未指定，則會傳回所有專案。 |
|
|
限制
|
sysparm_limit | True | integer |
要擷取的目錄項目數 |
|
搜尋文字
|
sysparm_text | string |
搜尋文字以篩選項目 |
|
|
Catalog
|
sysparm_catalog | string |
要篩選專案的目錄 ID。 如果未指定，則會傳回所有目錄中的項目 |
傳回
取得目錄類別
擷取特定型錄的種類清單
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
目錄 ID
|
catalogId | True | string |
要擷取類別的目錄識別碼 |
|
限制
|
sysparm_limit | integer |
要擷取的目錄類別數目 |
|
|
Offset
|
sysparm_offset | integer |
查詢的位移量 |
傳回
取得知識文章
傳回可搜尋和篩選的知識庫 （KB） 文章清單
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Fields
|
fields | string |
以逗號分隔的欄位清單，來自 Knowledge 表格。 |
|
|
限制
|
limit | integer |
要傳回的記錄數目上限。 |
|
|
Query
|
query | True | string |
要搜尋的文字。 |
|
Filter
|
filter | string |
用來篩選結果集的編碼查詢。 |
|
|
知識庫
|
kb | string |
以逗號分隔的知識庫sys_ids清單。 |
傳回
取得記錄類型
取得附件中繼資料 （預覽版）
擷取附件的中繼資料
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
限制
|
sysparm_limit | string |
套用在分頁上的限制。 附註： 異常大的sysparm_limit值可能會影響系統效能。 預設值：1000 |
|
|
Offset
|
sysparm_offset | string |
要從查詢中排除的記錄數。 使用此參數可取得比sysparm_limit中指定的更多記錄。 例如，如果sysparm_limit設定為 500，但您有其他記錄要查詢，您可以指定sysparm_offset值 500 來取得第二組記錄。 預設值：0 |
|
|
Query
|
sysparm_query | string |
編碼查詢。 附件 API 的查詢是相對於附件 [sys_attachment] 資料表。 例如：（sysparm_query=file_name=attachment.doc） |
將二進位檔案上傳為附件 （預覽）
將二進位檔案作為附件上傳至指定記錄
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
資料表名稱
|
table_name | True | string |
您要附加檔案的資料表名稱 |
|
系統識別碼
|
table_sys_id | True | string |
您要附加檔案之指定表格上記錄的Sys_id |
|
檔案名稱
|
file_name | True | string |
提供附件的名稱 |
|
檔案
|
file | True | binary |
要附加至指定記錄的二進位檔 |
傳回
建立記錄
在 ServiceNow 資料表中建立記錄。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
記錄類型
|
tableType | True | string |
要列出的記錄類型 |
|
body
|
body | True | dynamic | |
|
顯示系統參考
|
sysparm_display_value | boolean |
決定是否應包含系統參照 |
|
|
排除參考連結
|
sysparm_exclude_reference_link | boolean |
決定是否應排除參考連結 |
|
|
Fields
|
sysparm_fields | string |
要傳回的欄位以逗點分隔的清單。 範例：姓名、電子郵件、電話 |
傳回
擷取附件中繼資料 （預覽版）
擷取附件中繼資料
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
sys_id | True | string |
要擷取中繼資料的附件Sys_id |
擷取附件內容 （預覽版）
擷取附件內容
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
系統識別碼
|
sys_id | True | string |
要擷取內容的附件Sys_id |
更新記錄
更新 ServiceNow 物件類型的記錄，例如「事件」
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
記錄類型
|
tableType | True | string |
要列出的記錄類型 |
|
系統標識碼
|
sysid | True | string |
記錄的系統 ID。 |
|
body
|
body | True | dynamic | |
|
顯示系統參考
|
sysparm_display_value | boolean |
決定是否應包含系統參照 |
|
|
排除參考連結
|
sysparm_exclude_reference_link | boolean |
決定是否應排除參考連結 |
|
|
Fields
|
sysparm_fields | string |
要傳回的欄位以逗點分隔的清單。 範例：姓名、電子郵件、電話 |
傳回
獲取記錄
取得 ServiceNow 物件類型的記錄，例如「事件」
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
記錄類型
|
tableType | True | string |
要列出的記錄類型 |
|
系統標識碼
|
sysid | True | string |
記錄的系統 ID。 |
|
顯示系統參考
|
sysparm_display_value | boolean |
決定是否應包含系統參照 |
|
|
排除參考連結
|
sysparm_exclude_reference_link | boolean |
決定是否應排除參考連結 |
|
|
Fields
|
sysparm_fields | string |
要傳回的欄位以逗點分隔的清單。 範例：姓名、電子郵件、電話 |
傳回
訂購項目
訂購或購買特定目錄項目。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
項目 ID
|
sys_id | True | string |
要訂購的目錄項目的sys_id |
|
訂單項目內文
|
body | True | dynamic |
訂單項目請求的內文。 它包含數量、使用者要求的數量，以及型錄項目所需的任何其他變數 |
傳回
定義
UploadAttachment回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
average_image_color
|
result.average_image_color | string |
如果附件是影像，則為所有色彩的總和。 |
|
壓縮
|
result.compressed | string |
指出附件檔是否已壓縮的旗標。 |
|
content_type
|
result.content_type | string |
相關聯附件檔的內容類型，例如影像或 jpeg 或 application/x-shockwave-flash。 |
|
created_by_name
|
result.created_by_name | string |
最初建立附件檔的實體全名。 |
|
download_link
|
result.download_link | string |
下載ServiceNow執行個體上附件的URL。 |
|
檔案名稱
|
result.file_name | string |
附件的檔案名稱。 |
|
image_height
|
result.image_height | string |
如果是影像檔案，則為影像的高度。 單位：像素 |
|
image_width
|
result.image_width | string |
如果是影像檔案，則為影像的寬度。 單位：像素 |
|
size_bytes
|
result.size_bytes | string |
附件的大小。 單位：位元組 |
|
size_compressed
|
result.size_compressed | string |
附件的大小。 單位：位元組 |
|
sys_created_by
|
result.sys_created_by | string |
最初建立附件檔的實體。 |
|
sys_created_on
|
result.sys_created_on | string |
附件檔最初儲存至執行個體的日期和時間。 |
|
sys_id
|
result.sys_id | string |
附件檔的Sys_id。 |
|
sys_mod_count
|
result.sys_mod_count | string |
修改附件檔案 （上傳至執行個體） 的次數。 |
|
sys_tags
|
result.sys_tags | string |
與附件檔案相關聯的任何系統標籤。 |
|
sys_updated_by
|
result.sys_updated_by | string |
與附件檔案相關聯的任何系統標籤。 |
|
sys_updated_on
|
result.sys_updated_on | string |
上次更新附件檔的日期和時間。 |
|
table_name
|
result.table_name | string |
附件所關聯之表格名稱。 |
|
table_sys_id
|
result.table_sys_id | string |
與附件相關聯之表格的Sys_id。 |
|
updated_by_name
|
result.updated_by_name | string |
上次更新附件檔的實體全名。 |
GetTypes回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
結果
|
result | array of object |
目前實例之所有記錄類型的結果集。 |
|
顯示名稱
|
result.label | string |
記錄類型的顯示名稱。 |
|
價值觀
|
result.value | string |
記錄類型的值。 |
GetCatalogs回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
結果
|
result | array of object | |
|
title
|
result.title | string | |
|
sys_id
|
result.sys_id | string | |
|
has_categories
|
result.has_categories | boolean | |
|
has_items
|
result.has_items | boolean | |
|
description
|
result.description | string | |
|
desktop_image
|
result.desktop_image | string |
GetCatalogCategories回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
結果
|
result | array of object | |
|
title
|
result.title | string | |
|
description
|
result.description | string | |
|
full_description
|
result.full_description | string | |
|
icon
|
result.icon | string | |
|
header_icon
|
result.header_icon | string | |
|
homepage_image
|
result.homepage_image | string | |
|
count
|
result.count | integer | |
|
子類別
|
result.subcategories | array of object | |
|
sys_id
|
result.subcategories.sys_id | string | |
|
title
|
result.subcategories.title | string | |
|
sys_id
|
result.sys_id | string |
GetCatalogItems回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
結果
|
result | array of object | |
|
short_description
|
result.short_description | string | |
|
kb_article
|
result.kb_article | string | |
|
icon
|
result.icon | string | |
|
description
|
result.description | string | |
|
availability
|
result.availability | string | |
|
mandatory_attachment
|
result.mandatory_attachment | boolean | |
|
request_method
|
result.request_method | string | |
|
型別
|
result.type | string | |
|
visible_standalone
|
result.visible_standalone | boolean | |
|
local_currency
|
result.local_currency | string | |
|
sys_class_name
|
result.sys_class_name | string | |
|
sys_id
|
result.sys_id | string | |
|
content_type
|
result.content_type | string | |
|
價格
|
result.price | string | |
|
recurring_frequency
|
result.recurring_frequency | string | |
|
price_currency
|
result.price_currency | string | |
|
順序
|
result.order | integer | |
|
make_item_non_conversational
|
result.make_item_non_conversational | boolean | |
|
擁有者
|
result.owner | string | |
|
show_price
|
result.show_price | boolean | |
|
recurring_price
|
result.recurring_price | string | |
|
show_quantity
|
result.show_quantity | boolean | |
|
圖片
|
result.picture | string | |
|
url
|
result.url | string | |
|
recurring_price_currency
|
result.recurring_price_currency | string | |
|
localized_price
|
result.localized_price | string | |
|
catalogs
|
result.catalogs | array of object | |
|
sys_id
|
result.catalogs.sys_id | string | |
|
活動中
|
result.catalogs.active | boolean | |
|
title
|
result.catalogs.title | string | |
|
名稱
|
result.name | string | |
|
localized_recurring_price
|
result.localized_recurring_price | string | |
|
show_wishlist
|
result.show_wishlist | boolean | |
|
sys_id
|
result.category.sys_id | string | |
|
title
|
result.category.title | string | |
|
turn_off_nowassist_conversation
|
result.turn_off_nowassist_conversation | boolean | |
|
show_delivery_time
|
result.show_delivery_time | boolean |
GetCatalogItem回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
short_description
|
result.short_description | string |
short_description |
|
kb_article
|
result.kb_article | string |
kb_article |
|
icon
|
result.icon | string |
icon |
|
description
|
result.description | string |
description |
|
availability
|
result.availability | string |
availability |
|
mandatory_attachment
|
result.mandatory_attachment | boolean |
mandatory_attachment |
|
request_method
|
result.request_method | string |
request_method |
|
型別
|
result.type | string |
型別 |
|
visible_standalone
|
result.visible_standalone | boolean |
visible_standalone |
|
sys_class_name
|
result.sys_class_name | string |
sys_class_name |
|
sys_id
|
result.sys_id | string |
sys_id |
|
content_type
|
result.content_type | string |
content_type |
|
順序
|
result.order | integer |
順序 |
|
make_item_non_conversational
|
result.make_item_non_conversational | boolean |
make_item_non_conversational |
|
擁有者
|
result.owner | string |
擁有者 |
|
show_price
|
result.show_price | boolean |
show_price |
|
show_quantity
|
result.show_quantity | boolean |
show_quantity |
|
圖片
|
result.picture | string |
圖片 |
|
url
|
result.url | string |
url |
|
catalogs
|
result.catalogs | array of object |
catalogs |
|
sys_id
|
result.catalogs.sys_id | string |
sys_id |
|
活動中
|
result.catalogs.active | boolean |
活動中 |
|
title
|
result.catalogs.title | string |
title |
|
名稱
|
result.name | string |
名稱 |
|
show_wishlist
|
result.show_wishlist | boolean |
show_wishlist |
|
sys_id
|
result.category.sys_id | string |
sys_id |
|
title
|
result.category.title | string |
title |
|
turn_off_nowassist_conversation
|
result.turn_off_nowassist_conversation | boolean |
turn_off_nowassist_conversation |
|
show_delivery_time
|
result.show_delivery_time | boolean |
show_delivery_time |
|
categories
|
result.categories | array of object |
categories |
|
sys_id
|
result.categories.sys_id | string |
sys_id |
|
活動中
|
result.categories.active | boolean |
活動中 |
|
sys_id
|
result.categories.category.sys_id | string |
sys_id |
|
活動中
|
result.categories.category.active | boolean |
活動中 |
|
title
|
result.categories.category.title | string |
title |
|
title
|
result.categories.title | string |
title |
|
variables
|
result.variables | array of object |
variables |
|
ui_policy
|
result.ui_policy | array of |
ui_policy |
|
在變更上
|
result.client_script.onChange | array of |
在變更上 |
|
提交時
|
result.client_script.onSubmit | array of |
提交時 |
|
載入
|
result.client_script.onLoad | array of |
載入 |
|
data_lookup
|
result.data_lookup | array of |
data_lookup |
|
變數結構描述
|
result.variablesSchema | object |
OrderItem回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
sys_id
|
result.sys_id | string |
sys_id |
|
數字
|
result.number | string |
數字 |
|
request_number
|
result.request_number | string |
request_number |
|
請求ID
|
result.request_id | string |
請求ID |
|
表格
|
result.table | string |
表格 |
GetArticles回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
meta.count | integer |
可用的知識庫文章數量 |
|
結束
|
meta.end | integer |
結果集的結束索引 |
|
Fields
|
meta.fields | string |
文章中的欄位 |
|
Filter
|
meta.filter | string |
用於獲取數據的過濾器 |
|
知識庫
|
meta.kb | string |
知識庫文章列表sys_ids |
|
語言
|
meta.language | string |
請求的知識庫文章的逗號分隔語言列表 |
|
Query
|
meta.query | string |
指定的要求查詢 |
|
開始
|
meta.start | string |
結果集的起始索引 |
|
地位
|
meta.status.code | string |
通話狀態 |
|
知識庫
|
meta.ts_query_id | string |
請求的知識庫文章的逗號分隔語言列表 |
|
文章
|
articles | array of object | |
|
顯示值
|
articles.fields.display_value | string |
要求欄位的顯示值 |
|
標籤
|
articles.fields.label | string |
代表所要求欄位的標籤 |
|
名稱
|
articles.fields.name | string |
所要求欄位的名稱 |
|
類型
|
articles.fields.type | string |
要求欄位的資料類型 |
|
價值觀
|
articles.fields.value | string |
所要求欄位的值 |
|
Link
|
articles.Link | string |
文章鏈接 |
|
識別碼
|
articles.id | string |
知識文章sys_id來自知識 [kb_knowledge] 表格 |
|
Number
|
articles.number | string |
知識文章sys_id來自知識 [kb_knowledge] 表格 |
|
等級
|
articles.rank | float |
特定於此搜尋的文章的搜尋排名 |
|
Score
|
articles.score | float |
相關性分數，結果按分數降序排序 |
|
程式碼片段
|
articles.snippet | string |
顯示知識文章一小部分的文字 |
|
Title
|
articles.title | string |
知識文章的簡短描述或標題 |