cbecker-edr (Community Member) asked a question.
How to create link to scan from detailedreport.xml attributes?
The <detailedreport> xml has the following attributes, and I would like to create a link to the report, hopefully by using some formula on how to combine those attributes. Can someone point me to documentation:
account_id
app_name
app_id
analysis_id
static_analysis_unit_id
sandbox_id
build_id
.png){kind=logo}
Hi @cbecker-edr (Community Member) ,
You can find more information about the meaning of these fields in the associated XSD: https://analysiscenter.veracode.com/resource/detailedreport.xsd .
* account_id: The account id.
* app_name: The application name.
* app_id: The numeric identifier for the application.
* analysis_id: The analysis id for the scan.
* static_analysis_unit_id: The analysis unit id for the static scan.
* sandbox_id: The sandbox id.
* build_id: The numeric identifier for the build of the application.
You can create a link to the Veracode Platform like so:
https://analysiscenter.veracode.com/auth/index.jsp#ViewReportsDetailedReport:<account_id>:<app_id>:<build_id>:<analysis_id>:<static_analysis_unit_id>:<dynamic_analysis_unit_id>:<manual_analysis_unit_id>:::<sandbox_id>
Though please note, while this currently works, this is not an official API and as such it is subject to change without notice. We don't have an official API with API documentation to link into the Veracode Platform. Please create a Veracode Community Idea at https://community.veracode.com/s/ideas .
Thank you,
Boy Baukema
Thanks @Boy, Security Consultant (Veracode) for the insights!
Hi @cbecker-edr (Community Member), @Brian B., Veracode Support (Veracode, Inc.) also looked into your question, here is his feedback;
We have investigated your inquiry and found the following that the information supplied in the detailed xml report can be used to compile a URL to link to the specific application. An example of this for a policy level static scan would be:
https://analysiscenter.veracode.com/auth/index.jsp#StaticOverview:(account_id):(app_id):(build_id):(analysis_id):(static_analysis_unit_id)::::
Thank you. This is helpful information. Maybe a little concerning that it is not official (or officially documented) since that seemingly means it could change at any time.
Or better yet, just put the link into the detailedreport.xml data and you don't have to document and I don't have to create it myself.
Hi @cbecker-edr (Community Member) ,
We would love to hear your thoughts on this over at Veracode Community Idea at https://community.veracode.com/s/ideas .
This helps Veracode Product Management gauge interest in potential product features.
Thank you,
Boy Baukema
Hi everyone! I wanted to share an update from the product team about this feedback:
This is great feedback and something we are taking into account with our new REST APIs! You can see this in the Applications API now: the application and scan records contain elements that provide the URL fragment that can be used to navigate to details in the platform, including application profile, scan definition, and results. Just add "https://analysiscenter.veracode.com/auth/index.jsp#" before the URL fragments in the profile (which include scan_url, results_url, and app_profile_url).
We think you might be able to reference this as delivered with the Applications API.
Here's an example:
{
"guid": "f72bd227-3f21-4521-9542-e52489eb7752",
"id": 239510,
"oid": null,
"last_completed_scan_date": "2019-01-25T02:29:05.000Z",
"created": "2016-08-05T18:34:59.000Z",
"modified": "2020-06-11T20:14:20.000Z",
"app_profile_url": "HomeAppProfile:14212:239510",
"scans": [
{
"scan_type": "DYNAMIC",
"status": "INCOMPLETE",
"modified_date": null,
"scan_url": "DynamicParamsView:14212:239510:3464117:1238986::1254736",
"internal_status": "incomplete"
},
{
"scan_type": "STATIC",
"status": "PUBLISHED",
"modified_date": "2019-01-25T02:29:05.000Z",
"scan_url": "StaticOverview:14212:239510:3464117:3448795:3464534",
"internal_status": "resultsready"
}
],
"profile": {
"name": "VeraDemo",
"tags": "demo",
"business_unit": {
"id": 70405,
"name": "Data and Advisory Solutions - Transnational Data Solutions"
},
"business_owners": [],
"archer_app_name": null,
"policies": [
{
"guid": "9ab6dc63-29cf-4457-a1d1-e2125277df0e",
"name": "Veracode Recommended High",
"is_default": true,
"policy_compliance_status": "DETERMINING"
}
],
"teams": [],
"custom_fields": null,
"description": "A collaboration application.",
"settings": {
"nextday_consultation_allowed": false,
"static_scan_dependencies_allowed": true,
"dynamic_scan_approval_not_required": false,
"sca_enabled": false
},
"business_criticality": "HIGH"
},
"results_url": "ViewReportsResultSummary:14212:239510:3464117",
"_links": {
"self": {
"href": "https://api.veracode.com/appsec/v1/applications/f72bd227-3f21-4521-9542-e52489eb7752"
},
"sandboxes": {
"href": "https://api.veracode.com/appsec/v1/applications/f72bd227-3f21-4521-9542-e52489eb7752/sandboxes{?page,size}",
"templated": true
},
"policy": {
"href": "https://api.veracode.com/appsec/v1/policies/9ab6dc63-29cf-4457-a1d1-e2125277df0e"
}
}
}