报告管理
/ appidententerprise / rest / v1 / eport / importstandardreport
说明在扫描历史记录中创建新扫描，或更新指定扫描的报告
参数
请注意
必须使用多部分/表格数据请求来上传文件
的名字 |
类型 |
必需的 |
描述 |
|---|---|---|---|
scanid. |
GUID [] |
N |
如果提供了扫描id，则更新扫描报告;如果没有，则创建新的扫描详细信息 |
exportData. |
多部分/格式文件 |
Y |
报告文件 |
configId |
GUID [] |
N |
配置id上传的报告附加到 |
响应消息
响应状态码 |
原因 |
描述 |
|---|---|---|
200. |
报告更新，上传 |
|
400 |
无效jsonschema. |
未提供所需参数 |
400 |
ScanNotFound |
未找到scanId进行扫描 |
400 |
CantHaveReport |
扫描状态应完成，停止，失败或淡入更新报告 |
400 |
ConfigNotFound |
使用'configid'配置 |
反应的例子:
JSON模式:
1
｛
2
“类型”：“对象”，
3.
“特性”：｛
4
“IsSuccess”：｛
5
“类型”：“布尔”，
6
“必需的”：真的
7
｝，
8
“ErrorMessage”：｛
9
“类型”：［“字符串”，“零”］，
10
“必需的”：真的
11
｝，
12
“原因”：｛
13
“类型”：［“字符串”，“零”］，
14
“必需的”：真的
15
｝，
16
“ScanId”：｛
17
“类型”：［“字符串”，“零”］，
18
“必需的”：真的
19
｝
20.
｝，
21
“additionalProperties”：假
22
｝
/ AppSpiderEnterprise /休息/ v1 /报告/ ImportCheckmarxReport
上传checkmarx报告
参数
的名字 |
类型 |
必需的 |
描述 |
|---|---|---|---|
scanid. |
GUID [] |
Y |
扫描身份证 |
文件 |
文件 |
Y |
Checkmarx报告XML文件 |
响应消息
响应状态码 |
原因 |
描述 |
|---|---|---|
200. |
报告更新 |
|
400 |
InvalidStructure |
无效的checkmarx报告结构 |
反应的例子:
JSON模式:
1
｛
2
“类型”：“对象”，
3.
“特性”：｛
4
“IsSuccess”：｛
5
“类型”：“布尔”，
6
“必需的”：真的
7
｝，
8
“ErrorMessage”：｛
9
“类型”：［“字符串”，“零”］，
10
“必需的”：真的
11
｝，
12
“原因”：｛
13
“类型”：［“字符串”，“零”］，
14
“必需的”：真的
15
｝，
16
“ScanId”：｛
17
“类型”：［“字符串”，“零”］，
18
“必需的”：真的
19
｝
20.
｝，
21
“additionalProperties”：假
22
｝
/ appspiderenterprise / rest / v1 / eport / getReportzip
说明获取扫描的resideAllfiles.zip。只扫描“已完成”和“已停止”状态可能会有报告
参数
的名字 |
类型 |
必需的 |
描述 |
|---|---|---|---|
scanid. |
GUID [] |
Y |
扫描身份证 |
响应消息
响应状态码 |
原因 |
描述 |
|---|---|---|
200. |
响应包含到文件的链接 |
|
400 |
无效jsonschema. |
未提供所需参数 |
400 |
ScanNotFound |
未找到scanId进行扫描 |
400 |
NoReport |
扫描报告不可用。扫描状态不是“完成”或“停止” |
400 |
FileNotFound |
报告文件不存在 |
响应示例:成功请求的文件结果。如果错误发生
JSON模式:
1
｛
2
“类型”：“对象”，
3.
“特性”：｛
4
“IsSuccess”：｛
5
“类型”：“布尔”，
6
“必需的”：真的
7
｝，
8
“ErrorMessage”：｛
9
“类型”：［“字符串”，“零”］，
10
“必需的”：真的
11
｝，
12
“原因”：｛
13
“类型”：［“字符串”，“零”］，
14
“必需的”：真的
15
｝
16
｝，
17
“additionalProperties”：假
18
｝
/ AppSpiderEnterprise /休息/ v1 /报告/ GetVulnerabilitiesSummaryXml
获取用于扫描的vulnerability summary .xml。只有处于“完成”和“停止”状态的扫描才能有报告
参数
的名字 |
类型 |
必需的 |
描述 |
|---|---|---|---|
scanid. |
GUID [] |
Y |
扫描身份证 |
响应消息
响应状态码 |
原因 |
描述 |
|---|---|---|
200. |
响应包含到文件的链接 |
|
400 |
无效jsonschema. |
未提供所需参数 |
400 |
ScanNotFound |
未找到scanId进行扫描 |
400 |
NoReport |
扫描报告不可用。扫描状态不是“完成”或“停止” |
400 |
FileNotFound |
报告文件不存在 |
响应示例:成功请求的文件结果。如果错误发生
JSON模式:
1
｛
2
“类型”：“对象”，
3.
“特性”：｛
4
“IsSuccess”：｛
5
“类型”：“布尔”，
6
“必需的”：真的
7
｝，
8
“ErrorMessage”：｛
9
“类型”：［“字符串”，“零”］，
10
“必需的”：真的
11
｝，
12
“原因”：｛
13
“类型”：［“字符串”，“零”］，
14
“必需的”：真的
15
｝
16
｝，
17
“additionalProperties”：假
18
｝
/ AppSpiderEnterprise /休息/ v1 /报告/ GetCrawledLinksXml
获取CrawledLinks.xml进行扫描。只有处于“完成”和“停止”状态的扫描才能有报告
参数
的名字 |
类型 |
必需的 |
描述 |
|---|---|---|---|
scanid. |
GUID [] |
Y |
扫描身份证 |
响应消息
响应状态码 |
原因 |
描述 |
|---|---|---|
200. |
响应包含到文件的链接 |
|
400 |
无效jsonschema. |
未提供所需参数 |
400 |
ScanNotFound |
未找到scanId进行扫描 |
400 |
NoReport |
扫描报告不可用。扫描状态不是“完成”或“停止” |
400 |
FileNotFound |
报告文件不存在 |
响应示例:成功请求的文件结果。如果错误发生
JSON模式:
1
｛
2
“类型”：“对象”，
3.
“特性”：｛
4
“IsSuccess”：｛
5
“类型”：“布尔”，
6
“必需的”：真的
7
｝，
8
“ErrorMessage”：｛
9
“类型”：［“字符串”，“零”］，
10
“必需的”：真的
11
｝，
12
“原因”：｛
13
“类型”：［“字符串”，“零”］，
14
“必需的”：真的
15
｝
16
｝，
17
“additionalProperties”：假
18
｝