报表管理

帖子

/AppSpiderEnterprise/rest/v1/Report/ImportsStandardReport

说明在扫描历史记录中创建新扫描或更新指定扫描的报告

参数

请注意

必须使用多部分/表格数据请求来上传文件

的名字

类型

要求的

描述

斯堪尼德

guid[]

N

如果提供了扫描id,则更新扫描报告;如果没有,则创建新的扫描详细信息

报告数据

多部分/格式文件

Y

报告文件

configId

guid[]

N

配置id上传的报告附加到

响应消息

响应状态码

原因

描述

200

报告已更新,已上载

400

无效JSONSCHEMA

未提供所需参数

400

ScanNotFound

未找到scanId进行扫描

400

CantHaveReport

扫描状态应为已完成、已停止、失败或VulnLoadFailed无法更新报告

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报告

参数

的名字

类型

要求的

描述

斯堪尼德

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/Report/GetReportZip

描述获取扫描的ReportAllFiles.zip。只有处于“已完成”和“已停止”状态的扫描才能有报告

参数

的名字

类型

要求的

描述

斯堪尼德

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。只有处于“完成”和“停止”状态的扫描才能有报告

参数

的名字

类型

要求的

描述

斯堪尼德

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进行扫描。只有处于“完成”和“停止”状态的扫描才能有报告

参数

的名字

类型

要求的

描述

斯堪尼德

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
}