請求 Web service 模式

該 REST 服務將返回 Web service 模式。對該模式添加了完整的注釋，描述了所有 Web Service 所返回的元素和屬性。請參閱本文檔，以獲取有關 XML 的細節。

注： 這排除了每個個別報告的模式，因為這些是基于內容而動態生成的報告。

HTTPS 方法

GET

服務格式

/services/schema

返回值

XML 模式文檔

---

請求版本信息

該 REST 服務將返回有關服務器的版本信息。

HTTPS 方法

GET

服務格式

/services/version

“參數”

無

返回值

<version>element

示例：

<version>
   <build>8.00.0.0 (Build293)BETA</build>
   <dbversion>1245</dbversion>
   <rules-version>979</rules-version>
   <user-name>Miriam</user-name>
</version>

請參閱文檔記錄的模式以獲取更多詳細信息。

---

請求文件夾的集合

該 REST 服務將返回 <folder> 元素的集合。每個 <folder> 元素都包含有關該特定文件夾的信息，其中包括該文件夾的標識、名稱、描述、聯系信息和其內容的鏈接。

注： v9.0.2.1 iFix1：返回的 XML 文件現在返回用戶的列表。

HTTPS 方法

GET

服務格式

對于根文件夾：

/services/folders

對于給定文件夾的子文件夾：

/services/folders/<fid>/folders

“參數”

fid ：根文件夾的文件夾標識，用于檢索其子文件夾

返回值

<folder>element

示例：

請參閱文檔記錄的模式以獲取更多詳細信息。

---

請求單個文件夾

該 REST 服務將基于標識返回單個文件夾。返回的 <folder> 元素包含有關該特定文件夾的信息，包括該文件夾的名稱、描述、聯系信息和其內容的鏈接。

注： v9.0.2.1 iFix1：返回的 XML 文件現在返回用戶的列表。

HTTPS 方法

GET

服務格式

/services/folders/<fid>

“參數”

fid ：文件夾標識

返回值

<folder>element

示例：

請參閱文檔記錄的模式以獲取更多詳細信息。

---

請求文件夾項的集合

該 REST 服務將返回文件夾項的集合。每個文件夾項元素都包含了基本信息，如標識、名稱、描述、當前狀態和操作等。

有不同類型的文件夾項：

• < content-scan-job>
• < import-job>
• < report-pack>
• < dashboard>

報告包還包含了有關其中所包含報告的其他信息。

注： v9.0.2.1 iFix1：返回的 XML 現在返回應用程序標識。

HTTP 方法

GET

服務格式

對于根文件夾的文件夾項：

/services/folderitems

對于特定文件夾的文件夾項：

/services/folders/<fid>/folderitems

“參數”

fid -folder ID

可選的查詢字符串參數：

flatten=1

添加該參數將返回所有子文件夾（位于存在問題的文件夾中和文件夾下）中的所有文件夾項。

返回值

<folder> 元素包含所有以下內容：

• < content-scan-job>
• < import-job>
• < report-pack>
• < dashboard>

示例

/services/folderitems?flatten=1

請參閱文檔記錄的模式以獲取更多詳細信息。

---

請求單個文件夾項

該 REST 服務將基于標識返回單個文件夾項。

每個文件夾項元素都包含基本信息，例如標識、名稱、描述、創建日期以及當前狀態和操作等。

注：

1. v9.0.0.1：此 REST API 現在收集創建日期信息。如果作業是在 9.0.0.1 之前所創建，那么創建日期字段不會顯示。
2. v9.0.2.1 iFix1：返回的 XML 現在返回應用程序標識。

有不同類型的文件夾項：

• < content-scan-job>
• < import-job>
• < report-pack>
• < dashboard>

報告包還包含了有關其中所包含報告的其他信息。

HTTPS 方法

GET

服務格式

/services/folderitems/<fiid>

“參數”

fiid -folder item ID

返回值

其中一個值：

• < content-scan-job>
• < import-job>
• < report-pack>
• < dashboard>

示例

/services/folderitems?flatten=1

請參閱文檔記錄的模式以獲取更多詳細信息。

---

檢索文件夾項的選項

該 REST 服務檢索文件夾項的選項以及用于對其訪問的 URL。

HTTPS 方法

GET

服務格式

/services/folderitems/<fiid>/options/

“參數”

fiid：文件夾項標識

返回值

<available-options> 元素包含所有可能的選項和 URL 的列表

示例：

<available-options>
  <available-option href="https://localhost/ase/services/folderitems/33/options/epcsCOTListOfStartingUrls"/>
  </available-options>

請參閱文檔記錄的模式以獲取更多詳細信息。

---

更新掃描與應用程序的關聯

該 REST API 返回具有新的 appid 值的更新 XML 文件。

HTPPS 方法

POST

服務格式

/services/folderitems/<fiid>

POST 數據

Content-Type: application/x-www-form-urlencoded``appid=<appid>

返回值

包含具有 appid 值的更新 XML 文件的元素。

---

刪除文件夾項

該 REST API 從“掃描”視圖刪除文件夾項。

HTTPS 方法

DELETE

服務格式

/services/folderitems/<fiid>

/services/folderitems/<fiid>/

---