API 变更历史记录

跟踪跨产品版本对 REST API 做出的更改。

v9.0.3.1

表 1. 扫描管理 API 中的变更历史记录
API 组 API 名称 HTTPs 方法 参数名称 更改
扫描管理 删除文件夹项 DELETE 新增：删除“扫描”视图中的文件夹项。
扫描管理 上载记录的登录数据 POST 新增：将存储在 *.htd 文件中作为记录的登录序列的手动探索数据上载到内容扫描作业，并将内容扫描作业的“登录方法”设置为“记录的登录”。
表 2. 从应用程序安全管理 API V1.0.6 到 V1.0.7 的变更历史记录
API 组 API 名称 HTTPs 方法 参数名称 更改
应用程序安全管理 applications PUT /applications/{appId}/ 注释 已更新：将注释添加到单个应用程序，并返回新注释对象。
应用程序安全管理 issues POST /issues/{issueId}/application/{appId}/comments 新增：将注释添加到单个问题。
应用程序安全管理 issues POST issues/reports/securitydetails body/config/issueConfig/issueAttributeConfig

body/config/applicationAttributeConfig

 新增：将问题属性添加到生成的报告。

新增：将应用程序属性添加到生成的报告。
应用程序安全管理 issuetypes GET /issuetypes/{issuetype}/standards/{standard name} issueTypeId 新增：检索问题类型所属的部分的列表
应用程序安全管理 issuetypes GET /issuetypes/{issueTypeId} issueTypeId 新增：检索问题类型。

v9.0.3

表 3. 从应用程序安全管理 API V1.0.5 到 V1.0.6 的变更历史记录。
API 组 API 名称 POST/GET 参数名称 更改
应用程序安全管理 applications GET /applications 属性

issuesquery

 新增：查询计算得到的属性并定义其他查询的范围。当前限制为指定标准标识和部分标识。

新增：选择其问题符合已定义标准的应用程序。
应用程序安全管理 issues GET /issues

GET /issues/details

GET /issues/details_v2

 properties

appId

 已更新：查询计算机的属性并定义其他查询的范围。当前限制为指定标准标识和部分标识。

不推荐：使用较高的版本。

获取打包到单个 zip 文件中的 HTML 格式的问题详细信息。V2 包含了对查询执行 AND 操作的功能。

应用程序安全管理 issues GET /issues/{issueId}/application/{appId}/aboutthisissue issueId

appId

 新增：获取 HTML 格式的“关于该问题”详细信息。
应用程序安全管理 issues

POST /issues/details_v2/xml

POST /issues/reports/regulatorycompliance

POST /issues/reports/industrystandard

POST /issues/reports/securitydetails

appId

body

新增：获取应用程序的 XML 格式的问题详细信息。

新增：这是包含 IssueIds 和 Queries 的列表的 JSON 对象。
应用程序安全管理 issues GET /issues/reports/{id}/status

GET /issues/reports/{id}

 id 新增：获取报告作业的状态。

新增：获取报告。
应用程序安全管理 issuetypes GET /issuetypes/{issueTypeLookup}/fixrecommendation issueTypeLookup 新增：获取给定问题类型标识的 html 格式的修订建议。
应用程序安全管理 scanners GET /scanners/{scannerId}/icon

GET /scanners

 scannerId

includeUnregisteredScanners

 新增：获取给定扫描程序的图标。

新增：获取扫描程序的列表。
应用程序安全管理
应用程序安全管理 standards GET /standards 新增：获取关于受支持合规性标准的列表和详细信息
应用程序安全管理 标准 GET /standards/{standardId}/sections standardId 新增：获取关于特定标准的部分的列表和详细信息
应用程序安全管理 summaries GET /summaries/apps/count

GET /summaries/apps

 properties

issuesQuery

issuegroup

 新增：查询计算得到的属性并定义其他查询的范围。当前限制为指定标准标识和部分标识。

新增：仅选择包含具有指定属性名称的问题的应用程序。

新增：指定用于分组的问题属性。
应用程序安全管理 summaries GET /summaries/issues/count_v2

GET /summaries/issues/count

GET /summaries/issues_v2

GET /summaries/issues

 properties 新增：查询计算得到的属性并定义其他查询的范围。当前限制为指定标准标识和部分标识。

不推荐：使用 GET /summaries/issues/count_v2 instead。

新增：查询计算得到的属性并定义其他查询的范围。

不推荐：使用 GET /summaries/issues/issues_v2 instead。

v9.0.2.1 iFix1

表 4. 扫描管理 API 中的变更历史记录
API 名称 POST/GET 参数名称 更改
请求文件夹的集合 更新：返回的 XML 文件现在返回用户的列表。添加了新的示例代码。
请求单个文件夹 更新：返回的 XML 文件现在返回用户的列表。添加了新的示例代码。
请求文件夹项的集合 更新：返回的 XML 文件现在返回用户的列表。添加了新的示例代码。
请求单个文件夹项 更新：返回的 XML 文件现在返回用户的列表。添加了新的示例代码。
更新扫描与应用程序的关联 POST 新增：该 REST API 返回具有新的 appid 值的更新 XML 文件。

V9.0.2.1

表 5. 从应用程序安全管理 API V1.0.4 到 V1.0.5 的变更历史记录。
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 的功能相同，但是使用改进的查询语法。
应用程序安全管理 issues GET /issues query 已更新 - 添加了对查询中日期范围的支持。
应用程序安全管理 issuetypes GET /issuetypes

GET /issuetypes/{issueTypeLookup}/advisory

GET /issuetypes/{issueTypeLookup}/fixrecommendation

 新建
应用程序安全管理 applications GET /applications/{appId}/activities 新建
应用程序安全管理 issueimport GET /issueimport/currentstatus 新建 - 还返回检测到的问题的数量
应用程序安全管理 issues GET /issues/details_v2/xml

GET /issues/{issueId}/application/{appId}/aboutthisissue

GET /issues/{issueId}/application/{appId}

 新建 - XML 和 HTML 格式的问题详细信息。

新建 - 获取问题时，响应包括建议和修订建议的链接。
应用程序安全管理 currentuser_v2 GET /currentuser_v2 新建 - 返回用户许可权
应用程序安全管理 login POST /login 新建 - 现在返回 isDASTScanningEnabled: true（当用户具有扫描许可证时）。

V9.0.2 iFix1

表 6. 从应用程序安全管理 API V1.0.3 到 V1.0.4 的变更历史记录。新缺陷跟踪系统集成 API V1.0.1
API 组 API 名称 POST/GET 参数名称 更改
应用程序安全管理 usertypes GET /usertypes 新增：获取用户类型的列表。
应用程序安全管理 consoleusers GET /consoleusers

GET /consoleusers/{userId}

POST /consoleusers

 已更新：返回电子邮件和用户类型标识。

新增：已添加 {userId}。

新的
缺陷跟踪系统集成 项目 GET /projects 新增：缺陷跟踪系统的项目
缺陷跟踪系统集成 defectTypes GET /defectTypes 新增：项目的缺陷类型
缺陷跟踪系统集成 字段 GET /fields 新增：缺陷类型的字段
缺陷跟踪系统集成（仅 JIRA） 用户 GET /users 新增：项目的用户
缺陷跟踪系统集成（仅 JIRA） 组 GET /groups 新增：项目中定义的组
缺陷跟踪系统集成（仅 JIRA） 组件 GET /components 新增：项目的组件
缺陷跟踪系统集成 缺陷 POST /defects

POST /defects/attachments

POST /defects/links

 新增：缺陷跟踪系统的缺陷

V9.0.2

表 7. 从应用程序安全管理 API V1.0.2 到 V1.0.3 的变更历史记录
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 有两个新字段可供调用应用程序使用：
  • complete，这是指示导入是否完成（成功或带有错误）的布尔值。
  • message，这是从服务器发出的指示导入状态的本地化消息。
version GET /version/dastclient 新增：版本信息
currentusr GET /currentuser 新增：当前用户的身份
仪表板 GET /dashboard 新增：在 Excel 格式中导出仪表板原始数据。
issues GET /issues query 已添加了新的问题状态“新问题”。先前使用“status=open”的先前查询必须更改为“status=new,status=open”以生成相同结果。
issues GET /issues/details 将多个问题以及详细信息导出到 HTML 文件（已压缩）
summaries GET /summaries/issues query 已添加了新的问题状态“新问题”。先前使用“status=open”的先前查询必须更改为“status=new,status=open”以生成相同结果。
summaries GET /summaries/issues/count query 已添加了新的问题状态“新问题”。先前使用“status=open”的先前查询必须更改为“status=new,status=open”以生成相同结果。

V9.0.1.1

表 8. 从应用程序安全管理 API V1.0.1 到 V1.0.2 的变更历史记录
API 名称 POST/GET 参数名称 更改
issueimport POST /issueimport/{appId}/{scannerId} scanName 用于作为查询字符串传递，但是现在作为表单参数传递的参数。