Loading
Omnistudio 資料對應器 REST API

Omnistudio 資料對應器 REST API

您可以使用「資料對應器 REST API」叫用任何類型的「資料對應器」。若要使用「資料對應器載入」更新 Salesforce 物件,請發出包含 JSON 裝載的 POST 要求,其格式化以符合「資料對應器載入」預期的輸入。若要從 Salesforce 提取資料,請發出 GET 呼叫至「資料對應器提取」,指定識別所要提取資料的識別碼或參數。資料會以 JSON 格式傳回回應。

範例

POST 資料

{
   "bundleName" : "AccountUpload",
   "objectList" : {
      "Agency Information": {
         "Agency Name": "Vlocity",
         "Agency Address": "50 Fremont",
         "Agency City": "San Francisco",
         "Agency State": "CA",
         "Agency Zip": "94110",
      }
   },
   "bulkUpload" : false
}

結果

{
   "createdObjectsByOrder": {
        "Open Account": {
             "1": [
                  "a10o00000022xVEAAY"               ]
        }
   },
   "createdObjectsByType": {
        "Open Account": {
             "Account": [
                  "a10o00000022xVEAAY"             ]
        }
   },
   "errors": {},
   "returnResultsData": []
}

資料對應器使用 GET 解壓縮

若要使用 REST 呼叫,從 Salesforce 提取資料,請核發 GET 陳述式,此陳述式會叫用「資料對應器」的「提取」。若要識別要取用的資料,您可以指定要比對的物件識別碼或一或多個參數。資料會以「資料對應器解壓」建立的輸出 JSON 格式傳回回應中。

使用識別碼取得資料

若要透過指定識別碼,以使用下列格式格式的 URL 來檢取 Salesforce 資料,請發出 GET 要求以叫用 Data Mapper Extract:

/services/apexrest/{myOrgNamespace}/v2/DataRaptor/{DataMapperName}/Id

要求範例

下列要求會使用「連絡人識別碼」來針對「連絡人」。

GET /services/apexrest/vlocity_cmt/v2/DataRaptor/OpenCases/a10o00000022xVE

範例結果

{
  "Contact": {
     "Contact Name" : "Dennis Reynolds",
     "Case Information": [
       {
          "Title": "Wrong widget shipped..."},
       {
          "Title": "Overcharged for gizmo..."},
       {
          "Title": "Damaged item..."}
    ]
 }
}

使用參數來取得資料

若要透過將參數傳送至「資料對應器」匯出,以使用下列格式發出 GET 要求的 URL:

GET /services/apexrest/{myOrgNamespace}/v2/DataRaptor/{DataMapperName}/?${Param1}=${Val1}&${Param2}=${Val2}...

要求範例

下列要求會將連絡人的名字和姓氏作為輸入參數傳遞至「資料對應器」提取,其會使用這些資料來查詢連絡人開啟的個案。

GET /services/apexrest/vlocity_cmt/v2/DataRaptor/Open_Cases/?FirstName=Dennis&LastName=Reynolds

使用 POST 的資料對應器載入叫用

若要更新 Salesforce 資料,請發出具有 URL 格式如下的 POST 要求:

/services/apexrest/{myOrgNamespace}/v2/DataRaptor/

在 POST 資料中,指定下列參數:

  • bundleName — 要叫用的資料對應器載入名稱

  • objectList — 要載入的 JSON 資料。必須符合資料對應器載入所需的格式。

  • filesList — (選擇性) 金鑰對應至基本 64 編碼檔案。

  • bulkUpload — TRUE 以使用批次 Apex。

 
正在載入
Salesforce Help | Article