請求報告的集合

該 REST 服務請求特定報告包內報告的集合。

每個 元素都包含以下信息：該報告的名稱、問題數或項，以及訪問其數據的鏈接。

HTTPS 方法

GET

服務格式

/services/folderitems/<fiid>/reports

“參數”

fiid -folder item ID

注： fiid 必須與報告包相對應。

返回值

<reports>element

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

---

請求單個報告

此 REST 服務請求單個報告。

每個 元素都包含以下信息：該報告的名稱、問題數或項，以及訪問其數據的鏈接。

HTTPS 方法

GET

服務格式

/services/reports/<rid>

“參數”

rid - report ID

返回值

<report>element

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

---

請求報告數據

該 REST 服務請求報告的數據。

缺省情況下，未對返回的數據進行分組，以便在報告中返回項的完整列表。一次會返回一頁（缺省值為 1000 行）數據。返回的 XML 包含頁碼和總頁數，以及下一頁數據的鏈接。

服務格式

要檢索首個頁面，請使用以下格式：

/services/reports/<rid>/data

要檢索后續頁面，請使用以下格式：

/services/reports/<rid>/data/pages/<page>

“參數”

rid - report ID

可選的查詢字符串參數：

mode=all

請在一個請求中返回所有報告數據，而不是一次返回一個頁面。

返回值

可以通過添加可選的查詢字符串參數 'metadata=schema' 來請求此模式。

---

請求報告的模式

此 REST 服務返回給定報告的模式。由于每個報告包含的列不同，所以模式也不同。由于報告是動態的，并且可以定制，所以報告的模式未包含在主要的 Web 服務模式中。

HTTPS 方法

GET

服務格式

/services/reports/<rid>/data?metadata=schema

“參數”

rid - report ID

返回值

XML 模式文檔

---

請求問題的集合

僅可用于問題受管報告。該 REST 服務返回表示通過 web UI 可訪問的“關于此問題”數據的元素的集合。

缺省情況下，一次會返回一頁（100 行）數據。返回的 XML 包含頁碼和總頁數，以及下一頁數據的鏈接。

HTTPS 方法

GET

服務格式

要檢索首個頁面，請使用以下格式：

/services/reports/<rid>/issues

要檢索后續頁面，請使用以下格式：

/services/reports/<rid>/issues/pages/<page>

“參數”

rid – report ID

可選的查詢字符串參數：

mode=all

一次在一個請求（而不是一頁）中返回所有問題數據。

返回值

<issues> 元素包含以下內容：

• <security-issue> （對于安全問題）
• <basic-issue> （對于所有其他問題）

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

---

請求收集限制流量數據的問題

此 API 提供了一個選項，可用于從較大的 XML 報告截斷 HTTP 流量數據或限制其字符。根據參數，可以將原始 HTTP 流量截斷為大型報告，這些流量有時會影響開銷資源并阻止生成報告。

HTTPS 方法

GET

服務格式

要檢索首個頁面，請使用以下格式：

/services/reports/<rid>/issue/size?testhttptraffic=<size>&originalhttptraffic=<size>

“參數”

rid - report ID

size - Traffic data character size

注： 流量數據中的最大字符數被限制為 500，可根據要求進行修改。流量數據字符大小將根據在此最大限制內定義的字符數進行限制。

返回值

<issues> 元素包含以下內容：

• <security-issue> （對于安全問題）
• <basic-issue> （對于所有其他問題）

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

---

請求單個問題

該 REST 服務返回單個“關于此問題”元素。

注： 該服務僅可用于問題受管報告。

HTTPS 方法

GET

服務格式

/services/reports/<rid>/issues/<issueid>

“參數”

issueid – issue ID

返回值

其中一個值：

• <security-issue> （對于安全問題）
• <basic-issue> （對于所有其他問題）

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

---

使用 POST 定制檢索報告數據

與在 Web UI 中一樣，可以根據分組、排序和過濾器的選擇來檢索數據。

要執行定制報告數據檢索，必須將 元素 POST 到通常用于檢索報告數據的同一 REST 服務

HTTPS 方法

POST

服務格式

要檢索首個頁面，請使用以下格式：

/services/reports/<rid>/data

要檢索后續頁面，請使用以下格式：

/services/reports/<rid>/data/pages/<page>

參數

rid - report ID

POST 數據：

<report-view> 包含定制組/排序/過濾器的元素。請參閱文檔記錄的模式以獲取更多詳細信息。

可選的查詢字符串參數：

mode=all

請在一個請求中返回所有報告數據，而不是一次返回一個頁面。

返回值

報告數據符合為此報告所指定的模式。

---

使用 POST 定制問題集合的檢索

與在 Web UI 中一樣，可以根據分組、排序和過濾器的選擇來檢索數據。

要執行定制報告數據檢索，必須將 元素 POST 到通常用于檢索報告數據的同一 REST 服務

服務格式

要檢索首個頁面，請使用以下格式：

/services/reports/<rid>/issues

要檢索后續頁面，請使用以下格式：

/services/reports/<rid>/issues/pages/<page>

參數

rid - report ID

POST 數據：

<report-view> 包含定制組/排序/過濾器的元素。請參閱文檔記錄的模式以獲取更多詳細信息。

可選的查詢字符串參數：

mode=all

請在一個請求中返回所有報告數據，而不是一次返回一個頁面。

返回值

<issues> 元素包含以下內容：

• <security-issue> （對于安全問題）
• <basic-issue> （對于所有其他問題）

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