API 變更歷程
追蹤在各產品版本間對 REST API 所做的變更。
9.0.3.1 版
API 群組 | API 名稱 | HTTPs 方法 | 參數名稱 | 變更 |
---|---|---|---|---|
掃描管理 | 刪除資料夾項目 | DELETE | 新增:在「掃描」視圖中刪除資料夾項目。 | |
掃描管理 | 上傳已錄製的登入資料 | POST | 新增:上傳儲存在 *.htd 檔中的手動探索資料作為內容掃描工作的已記錄登入序列,並將內容掃描工作的「登入方法」設為「已記錄的登入」。 |
API 群組 | API 名稱 | HTTPs 方法 | 參數名稱 | 變更 |
---|---|---|---|---|
應用程式安全管理 | 應用程式 | PUT /applications/{appId}/ | 註解 | 更新:新增註解至單一應用程式,並傳回新的註解物件。 |
應用程式安全管理 | 問題 | POST /issues/{issueId}/application/{appId}/comments | 新增:新增註解至單一問題。 | |
應用程式安全管理 | 問題 | POST issues/reports/securitydetails | body/config/issueConfig/issueAttributeConfig body/config/applicationAttributeConfig |
新增:新增問題屬性至產生的報告。 新增:新增應用程式屬性至產生的報告。 |
應用程式安全管理 | issuetypes | GET /issuetypes/{issuetype}/standards/{standard name} | issueTypeId | 新增:擷取問題類型所屬區段的清單 |
應用程式安全管理 | issuetypes | GET /issuetypes/{issueTypeId} | issueTypeId | 新增:擷取問題類型。 |
9.0.3 版
API 群組 | API 名稱 | POST/GET | 參數名稱 | 變更 |
---|---|---|---|---|
應用程式安全管理 | 應用程式 | GET /applications | 內容 issuesquery |
新增:查詢計算內容及定義其他查詢的範圍。目前限制為指定標準 ID 及區段 ID。 新增:選取有問題的應用程式,這些問題在已定義的標準之內。 |
應用程式安全管理 | 問題 | GET /issues GET /issues/details GET /issues/details_v2 |
properties appId |
更新:查詢電腦內容及定義其他查詢的範圍。目前限制為指定標準 ID 及區段 ID。 已淘汰:改用新版本。 取得 HTML 格式的問題詳細資料,其包裝成單一 zip 檔。第 2 版包含對查詢執行 AND 運算的能力。 |
應用程式安全管理 | 問題 | GET /issues/{issueId}/application/{appId}/aboutthisissue | issueId appId |
新增:取得 HTML 格式的關於此問題詳細資料。 |
應用程式安全管理 | 問題 |
POST /issues/details_v2/xml POST /issues/reports/regulatorycompliance POST /issues/reports/industrystandard POST /issues/reports/securitydetails |
appId 內文 |
新增:取得應用程式的問題詳細資料(XML 格式)。 新增:這是含有 IssueId 與 Query 清單的 JSON 物件。 |
應用程式安全管理 | 問題 | GET /issues/reports/{id}/status GET /issues/reports/{id} |
id | 新增:取得報告工作的狀態。 新增:取得報告。 |
應用程式安全管理 | issuetypes | GET /issuetypes/{issueTypeLookup}/fixrecommendation | issueTypeLookup | 新增:針對給定的問題類型 ID,取得 HTML 格式的修正建議。 |
應用程式安全管理 | 掃描器 | GET /scanners/{scannerId}/icon GET /scanners |
scannerId includeUnregisteredScanners |
新增:取得給定的掃描器的圖示。 新增:取得掃描器清單。 |
應用程式安全管理 | ||||
應用程式安全管理 | standards | GET /standards | 新增:取得受支援相符性標準相關的清單與詳細資料 | |
應用程式安全管理 | standards | GET /standards/{standardId}/sections | standardId | 新增:取得特定標準區段相關的清單與詳細資料 |
應用程式安全管理 | 摘要 | GET /summaries/apps/count GET /summaries/apps |
properties issuesQuery issuegroup |
新增:查詢計算內容及定義其他查詢的範圍。目前限制為指定標準 ID 及區段 ID。 新增:只選取包含具有所指定屬性名稱之問題的應用程式。 新增:指定分組依據的問題屬性。 |
應用程式安全管理 | 摘要 | GET /summaries/issues/count_v2 GET /summaries/issues/count GET /summaries/issues_v2 GET /summaries/issues |
properties | 新增:查詢計算內容及定義其他查詢的範圍。目前限制為指定標準 ID 及區段 ID。 已淘汰:改為使用 GET /summaries/issues/count_v2。 新增:查詢計算內容及定義其他查詢的範圍。已淘汰:改為使用 GET /summaries/issues/issues_v2。 |
9.0.2.1 版 iFix1
API 名稱 | POST/GET | 參數名稱 | 變更 |
---|---|---|---|
要求資料夾集合 | 更新:傳回的 XML 檔現在會傳回使用者清單。增加了新的程式碼範例。 | ||
要求單一資料夾 | 更新:傳回的 XML 檔現在會傳回使用者清單。增加了新的程式碼範例。 | ||
要求資料夾項目集合 | 更新:傳回的 XML 檔現在會傳回使用者清單。增加了新的程式碼範例。 | ||
要求單一資料夾項目 | 更新:傳回的 XML 檔現在會傳回使用者清單。增加了新的程式碼範例。 | ||
更新掃描至應用程式的關聯 | POST | 新增:這個 REST API 會傳回含有新的 appid 值的更新 XML 檔。 |
9.0.2.1 版
API 群組 | API 名稱 | POST/GET | 參數名稱 | 變更 |
---|---|---|---|---|
應用程式安全管理 | issueimport | POST /issueimport/{appID}/{scannerId} | uploadedfile | 更新:「使用者沒有權限匯入」的錯誤碼,已從 401「未獲授權」變更為 403「禁止」訊息。 |
應用程式安全管理 | summaries/issues | GET /summaries/issues | query | 已更新 - 在查詢中新增日期範圍的支援。 已淘汰 - 改用 /summaries/issues_v2,其功能相同但使用改良的語法。 |
應用程式安全管理 | summaries/issues | GET /summaries/issues | appquery | 已更新 - 對查詢新增使用應用程式屬性的支援。 已淘汰 - 改用 /summaries/issues_v2,其功能相同但使用改良的語法。 |
應用程式安全管理 | summaries/issues_v2 | GET /summaries/issues_v2 | query、appquery | 新增 - 與舊版 API 的功能相同,但使用改良的查詢語法。 |
應用程式安全管理 | summaries/issues/count | GET /summaries/issues/count | query | 已更新 - 在查詢中新增日期範圍的支援。 已淘汰 - 改用 /summaries/issues/count_v2 ,其功能相同但使用改良的語法。 |
應用程式安全管理 | summaries/issues/count_v2 | GET /summaries/issues/count_v2 | query | 新增 - 與舊版 API 的功能相同,但使用改良的查詢語法。 |
應用程式安全管理 | 問題 | GET /issues | query | 已更新 - 在查詢中新增日期範圍的支援。 |
應用程式安全管理 | issuetypes | GET /issuetypes GET /issuetypes/{issueTypeLookup}/advisory GET /issuetypes/{issueTypeLookup}/fixrecommendation |
新建 | |
應用程式安全管理 | 應用程式 | GET /applications/{appId}/activities | 新建 | |
應用程式安全管理 | issueimport | GET /issueimport/currentstatus | 新增 - 現在也會傳回已刪除的問題數 | |
應用程式安全管理 | 問題 | GET /issues/details_v2/xml GET /issues/{issueId}/application/{appId}/aboutthisissue GET /issues/{issueId}/application/{appId} |
新增 - XML 和 HTML 格式的問題詳細資料。 新增 - 取得問題時,回應會包括諮詢與修正建議的鏈結。 |
|
應用程式安全管理 | currentuser_v2 | GET /currentuser_v2 | 新增 - 傳回使用者許可權 | |
應用程式安全管理 | 登入 | POST /login | 新增 - 當使用者有掃描授權時,現在會傳回 isDASTScanningEnabled: true。 |
9.0.2 版 iFix1
API 群組 | API 名稱 | POST/GET | 參數名稱 | 變更 |
---|---|---|---|---|
應用程式安全管理 | usertypes | GET /usertypes | 新建:取得使用者類型的清單。 | |
應用程式安全管理 | consoleusers | GET /consoleusers GET /consoleusers/{userId} POST /consoleusers |
已更新:傳回電子郵件和使用者類型 ID。 新建:已新增 {userId}。 新的 |
|
問題報告追蹤系統整合 | 專案 | GET /projects | 新建:問題報告追蹤系統的專案 | |
問題報告追蹤系統整合 | defectTypes | GET /defectTypes | 新建:專案的問題報告類型 | |
問題報告追蹤系統整合 | fields | GET /fields | 新建:問題報告類型的欄位 | |
問題報告追蹤系統整合(僅限 JIRA) | 使用者 | GET /users | 新建:專案的使用者 | |
問題報告追蹤系統整合(僅限 JIRA) | 群組 | GET /groups | 新建:專案中定義的群組 | |
問題報告追蹤系統整合(僅限 JIRA) | 元件 | GET /components | 新建:專案的元件 | |
問題報告追蹤系統整合 | 問題報告 | POST /defects POST /defects/attachments POST /defects/links |
新建:問題報告追蹤系統的問題報告 |
9.0.2 版
API 名稱 | POST/GET | 參數名稱 | 變更 |
---|---|---|---|
appimport issueimport |
POST /appimport POST /issueimport/{appId}/{scannerId} |
對 /appimport 和 /issueimport/{appId}/{scannerId} 的 POST REST API 呼叫不再等待匯入作業完成才傳回狀態。這些呼叫會在伺服器讀取上傳的檔案之後即傳回。 成功的回應會以 202 'Accepted' 回應以及一個位置標頭來表示。位置標頭包含一個用於 /appimport/currentstatus 及 /issueimport/currentstatus 的 URL 值。呼叫端應用程式可以輪詢這些 URL 值來判斷問題匯入程序的狀態。 |
|
issueimport | GET /issueimport/currentstatus | 有兩個新欄位可供呼叫端應用程式使用:
|
|
版本 | GET /version/dastclient | 新建:版本資訊 | |
currentusr | GET /currentuser | 新建:現行使用者的身分 | |
儀表板 (dashboard) | GET /dashboard | 新建:以 Excel 格式匯出儀表板原始資料。 | |
問題 | GET /issues | 查詢 | 已新增一種新的問題狀態:新的。使用 'status=open' 的先前查詢必須變更為 'status=new,status=open',才能產生相同結果。 |
問題 | GET /issues/details | 將含有詳細資料的多個問題匯出到 HTML 檔(已壓縮) | |
摘要 | GET /summaries/issues | query | 已新增一種新的問題狀態:新的。使用 'status=open' 的先前查詢必須變更為 'status=new,status=open',才能產生相同結果。 |
摘要 | GET /summaries/issues/count | query | 已新增一種新的問題狀態:新的。使用 'status=open' 的先前查詢必須變更為 'status=new,status=open',才能產生相同結果。 |
9.0.1.1 版
API 名稱 | POST/GET | 參數名稱 | 變更 |
---|---|---|---|
issueimport | POST /issueimport/{appId}/{scannerId} | scanName | 這個參數原本以查詢字串形式傳遞,但現在是以表單參數形式傳遞。 |