Skip to main content

​
概覽

資源是在系統 API 中公開的物件，可以查詢、建立、更新和刪除。這些資源包括： 每個資源都使用以下約定在專用的應用程式端點公開：/api.rsc/resourceName。例如，如果 託管在 mydomain.com 上並監聽 8001 端口，則將使用以下端點來存取 Files 資源：

​
資源存取方法

本節介紹用於對系統 API 公開的資源執行操作的 HTTP 方法。
建議在傳送資料時使用 JSON 或 x-www-form-urlencoded 負載進行 API 呼叫，尤其是在請求正文較大的呼叫中。

​
GET

HTTP GET 請求可用於從 檢索資源或資源集。GET 請求可以傳回多項，也可以僅傳回一項，具體取決於請求中是否指定了查詢參數。

​
不帶參數的 GET 請求

不包含查詢參數的 GET 請求將傳回該資源型別的所有例項。例如，如果對 Certificates 資源發出了不帶查詢參數的 GET 請求，則回應將包括應用程式中儲存的每個憑證。對 Connectors 資源的類似請求將傳回 流程中每個已配置端口例項的配置資料。 不帶參數的 GET 請求的目標 URL 應與資源端點相同。例如：

​
帶參數的 GET 請求

GET 請求可以在目標 URL 中包含查詢參數，以將結果集限制為目標資源的單個例項。例如，對 Files 資源的 GET 請求可以包含特定的端口、Folder 和 Filename 參數，以檢索由該端口處理的單個檔案。查詢參數在目標 URL 末尾的括號中指定。例如：
應用程式 UI 中的 API 瀏覽器詳細介紹了每種資源的可用參數。

​
POST

HTTP POST 請求可用於在 中建立指定資源的新例項。例如，向 Files 資源發出 POST 請求會將檔案插入到 流程中，向 Connectors 資源發出 POST 請求會在流程中建立新的已配置端口。 新資源的參數以 JSON 格式作為 POST 正文提供。該請求必須包含適當的 content-type 標頭（例如 application/json），以便正確解釋 POST 正文。應用程式 UI 中的 API 瀏覽器詳細介紹了每種資源的可用屬性。以下是 Connectors 資源的範例 POST 正文：
Connectors 資源還根據指定的 ConnectorType 支援其他屬性。透過在 JSON 正文中包含欄位名稱和值，可以在 POST 呼叫期間設定任何可配置的端口欄位。例如，建立新的 Zip 端口時，可以將該端口的 Operation 欄位設定為 Decompress：
POST 請求的目標 URL 應與資源端點相同：

​
PUT

HTTP PUT 請求可用於更新 中指定資源的例項。例如，向 Connectors 資源發出 PUT 請求將更新 流程中單個已配置端口的設定。 PUT 請求需要組合以下專案：
  • 目標 URL 中的查詢參數。這些參數指定要更新資源的哪個例項，例如要更新哪個端口。
  • PUT 請求 JSON 正文中的屬性。這些屬性決定該資源中要更新哪些欄位，例如應將哪些端口配置欄位設定為新值。
查詢參數在目標 URL 末尾的括號中指定，例如：
請求的 JSON 正文包括要為目標資源例項更新的資源特定欄位。該請求必須包含適當的 content-type 標頭（例如 application/json），才能正確解釋 PUT 正文。 以下是用於更新 Zip 端口例項的 Operation 欄位的 PUT 請求 JSON 正文範例：

​
DELETE

HTTP DELETE 請求可用於從 中刪除指定資源的例項。例如，對 Files 資源發出 DELETE 請求將從 工作流程中刪除一個檔案。 DELETE 請求在目標 URL 中包含查詢參數，以標識要刪除的資源例項。查詢參數在目標 URL 末尾的括號中指定。例如：
應用程式 UI 中的 API 瀏覽器詳細介紹了每種資源的可用參數。