Rapid Models DataHub Module API Definition
This API definition facilitates auditing static analysis alerts using classifiers, optional adaptive heuristics, and alert prioritization. The API enables jump-starting labeled datasets using test suites. It is intended to enable a wide range of users (with widely varying datasets, static analysis tools, machine learning expertise, and amount of labeled data) to benefit from using classifiers and sophisticated prioritization to automatically triage static analysis alerts.
Version: 0.0.4
BasePath:
Software Engineering Institute - Copyright (c) 2007-2019 Carnegie Mellon University. All Rights Reserved.
http://apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
Up
get /projects/{project_id}/alerts
Retrieve only the alerts and meta-alerts for a specific project. (getAlertsForProject)
Path parameters
project_id (required)
Path Parameter — The ID of the project
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"alerts" : [ {
"code_language_id" : "code_language_id",
"alert_id" : "alert_id",
"primary_message" : {
"filepath" : "filepath",
"line_start" : 0,
"line_end" : 6
},
"tool_id" : "tool_id",
"checker_id" : "checker_id",
"secondary_messages" : ""
}, {
"code_language_id" : "code_language_id",
"alert_id" : "alert_id",
"primary_message" : {
"filepath" : "filepath",
"line_start" : 0,
"line_end" : 6
},
"tool_id" : "tool_id",
"checker_id" : "checker_id",
"secondary_messages" : ""
} ],
"meta_alerts" : [ {
"filepath" : "filepath",
"line_number" : 0,
"determination" : {
"flag_list" : [ {
"flag" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"flag" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"inapplicable_environment_list" : [ {
"inapplicable_environment" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"inapplicable_environment" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"ignored_list" : [ {
"ignored" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"ignored" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"verdict_list" : [ {
"verdict" : "verdict",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"verdict" : "verdict",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"dead_list" : [ {
"dead" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"dead" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"dangerous_construct_list" : [ {
"dangerous_construct" : "dangerous_construct",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"dangerous_construct" : "dangerous_construct",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"notes_list" : [ {
"notes" : "notes",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"notes" : "notes",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ]
},
"meta_alert_id" : "meta_alert_id",
"condition_id" : "condition_id",
"alert_ids" : [ "alert_ids", "alert_ids" ],
"auto_verdict" : {
"key" : "auto_verdict"
}
}, {
"filepath" : "filepath",
"line_number" : 0,
"determination" : {
"flag_list" : [ {
"flag" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"flag" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"inapplicable_environment_list" : [ {
"inapplicable_environment" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"inapplicable_environment" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"ignored_list" : [ {
"ignored" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"ignored" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"verdict_list" : [ {
"verdict" : "verdict",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"verdict" : "verdict",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"dead_list" : [ {
"dead" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"dead" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"dangerous_construct_list" : [ {
"dangerous_construct" : "dangerous_construct",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"dangerous_construct" : "dangerous_construct",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"notes_list" : [ {
"notes" : "notes",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"notes" : "notes",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ]
},
"meta_alert_id" : "meta_alert_id",
"condition_id" : "condition_id",
"alert_ids" : [ "alert_ids", "alert_ids" ],
"auto_verdict" : {
"key" : "auto_verdict"
}
} ],
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Return the Alerts and Meta-Alerts Associated with the Project
get_alerts_response
400
Invalid Request
404
Alerts and Meta-Alerts Unavailable
default
Unexpected Error
error
Up
get /packages/{package_id}
Retrieve an existing package in the DataHub Module. (getPackage)
Path parameters
package_id (required)
Path Parameter — ID of the package to retrieve
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"package" : {
"uploader_id" : "uploader_id",
"code_metrics" : [ {
"filepath_depth" : "filepath_depth",
"filename" : "filename",
"filepath" : "filepath",
"functions" : [ {
"code_metrics_data" : [ null, null ],
"name" : "name",
"line_start" : 0,
"line_end" : 6
}, {
"code_metrics_data" : [ null, null ],
"name" : "name",
"line_start" : 0,
"line_end" : 6
} ],
"sourcefile_id" : "sourcefile_id",
"code_metrics_data" : [ { }, { } ],
"defect_info" : {
"key" : ""
}
}, {
"filepath_depth" : "filepath_depth",
"filename" : "filename",
"filepath" : "filepath",
"functions" : [ {
"code_metrics_data" : [ null, null ],
"name" : "name",
"line_start" : 0,
"line_end" : 6
}, {
"code_metrics_data" : [ null, null ],
"name" : "name",
"line_start" : 0,
"line_end" : 6
} ],
"sourcefile_id" : "sourcefile_id",
"code_metrics_data" : [ { }, { } ],
"defect_info" : {
"key" : ""
}
} ],
"created_at" : "2000-01-23T04:56:07.000+00:00",
"package_id" : "package_id",
"package_description" : "package_description",
"alerts" : "",
"author_source" : "author_source",
"test_suite_id" : "test_suite_id",
"updated_at" : "2000-01-23T04:56:07.000+00:00",
"tool_ids" : [ "tool_ids", "tool_ids" ],
"package_name" : "package_name",
"code_languages" : "",
"uploader_organization_id" : "uploader_organization_id"
},
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Return an Existing Package
get_package_response
400
Invalid Request
404
Package Unavailable
default
Unexpected Error
error
Provides Server Status (getStatus)
Request headers
Return type
Example data
Content-Type: application/json
{
"message" : "message",
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Server Is Running
request_token
400
Database Connection Lost
default
Unexpected Error
error
Up
get /taxonomies/{taxonomy_id}
Retrieve an existing taxonomy based on the name and version. (getTaxonomy)
Path parameters
taxonomy_id (required)
Path Parameter — ID of the taxonomy to retrieve
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"taxonomy" : {
"taxonomy_id" : "taxonomy_id",
"taxonomy_version" : "taxonomy_version",
"description" : "description",
"conditions" : [ {
"code_language_ids" : [ "code_language_ids", "code_language_ids" ],
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
}, {
"code_language_ids" : [ "code_language_ids", "code_language_ids" ],
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
} ],
"taxonomy_name" : "taxonomy_name"
},
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Returns data for a specific taxonomy
get_taxonomy_response
400
Invalid Request
404
Taxonomy Unavailable
default
Unexpected Error
error
Retrieve a list of available Taxonomies. (getTaxonomyList)
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"taxonomies" : [ {
"author_source" : "author_source",
"taxonomy_id" : "taxonomy_id",
"uploader_id" : "uploader_id",
"taxonomy_version" : "taxonomy_version",
"taxonomy_name" : "taxonomy_name",
"uploader_organization_id" : "uploader_organization_id"
}, {
"author_source" : "author_source",
"taxonomy_id" : "taxonomy_id",
"uploader_id" : "uploader_id",
"taxonomy_version" : "taxonomy_version",
"taxonomy_name" : "taxonomy_name",
"uploader_organization_id" : "uploader_organization_id"
} ],
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Returns a list of taxonomy ids, names and versions.
taxonomy_list_response
400
Invalid Request
404
Taxonomies Unavailable
default
Unexpected Error
error
Retrieve a list of Test Suite ids, names and versions that are available. (getTestSuiteList)
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"test_suites" : [ {
"author_source" : "author_source",
"test_suite_version" : "test_suite_version",
"test_suite_id" : "test_suite_id",
"uploader_id" : "uploader_id",
"manifest_urls" : [ "http://example.com/aeiou", "http://example.com/aeiou" ],
"uploader_organization_id" : "uploader_organization_id",
"code_languages" : "",
"test_suite_name" : "test_suite_name"
}, {
"author_source" : "author_source",
"test_suite_version" : "test_suite_version",
"test_suite_id" : "test_suite_id",
"uploader_id" : "uploader_id",
"manifest_urls" : [ "http://example.com/aeiou", "http://example.com/aeiou" ],
"uploader_organization_id" : "uploader_organization_id",
"code_languages" : "",
"test_suite_name" : "test_suite_name"
} ],
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Returns a list of test suites
test_suite_list_response
400
Invalid Request
404
Test Suites Unavailable
default
Unexpected Error
error
Retrieve an existing tool in the DataHub Module. (getToolData)
Path parameters
tool_id (required)
Path Parameter — Tool ID to retrieve data
Request headers
Return type
Example data
Content-Type: application/json
{
"request_id" : "request_id",
"tool" : {
"tool_name" : "tool_name",
"author_source" : "author_source",
"uploader_id" : "uploader_id",
"tool_version" : "tool_version",
"tool_id" : "tool_id",
"metrics_data_headers" : "{}",
"category" : "category",
"checker_mappings" : [ {
"checker_name" : "checker_name",
"checker_id" : "checker_id",
"conditions" : [ {
"taxonomy_id" : "taxonomy_id",
"code_language_ids" : [ "code_language_ids", "code_language_ids" ],
"condition_id" : "condition_id"
}, {
"taxonomy_id" : "taxonomy_id",
"code_language_ids" : [ "code_language_ids", "code_language_ids" ],
"condition_id" : "condition_id"
} ]
}, {
"checker_name" : "checker_name",
"checker_id" : "checker_id",
"conditions" : [ {
"taxonomy_id" : "taxonomy_id",
"code_language_ids" : [ "code_language_ids", "code_language_ids" ],
"condition_id" : "condition_id"
}, {
"taxonomy_id" : "taxonomy_id",
"code_language_ids" : [ "code_language_ids", "code_language_ids" ],
"condition_id" : "condition_id"
} ]
} ],
"uploader_organization_id" : "uploader_organization_id"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Returns data for a particular tool
get_tool_response
400
Invalid Request
404
Tool Information Unavailable
default
Unexpected Error
error
Retrieve a list of tool ids, versions and names available in the Module. (getToolList)
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"request_id" : "request_id",
"tools" : [ {
"tool_name" : "tool_name",
"author_source" : "author_source",
"uploader_id" : "uploader_id",
"tool_version" : "tool_version",
"code_language_ids" : [ "code_language_ids", "code_language_ids" ],
"tool_id" : "tool_id",
"uploader_organization_id" : "uploader_organization_id"
}, {
"tool_name" : "tool_name",
"author_source" : "author_source",
"uploader_id" : "uploader_id",
"tool_version" : "tool_version",
"code_language_ids" : [ "code_language_ids", "code_language_ids" ],
"tool_id" : "tool_id",
"uploader_organization_id" : "uploader_organization_id"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Returns a list of tool id, version and name
tool_list_response
400
Invalid Request
404
Tools Unavailable
default
Unexpected Error
error
Retrieve a list of all the available languages. (listLanguages)
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"languages" : "",
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Return a list of languages
list_languages_response
400
Invalid Request
404
No Languages Available
default
Unexpected Error
error
Retrieve a list of all available packages. (listPackages)
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"packages" : "",
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Return a List of Available Packages
list_packages_response
400
Invalid Request
404
No Packages Available
default
Unexpected Error
error
Retrieve a list of all available projects. (listProjects)
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"projects" : "",
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Return a List of Available Projects
list_projects_response
400
Invalid Request
404
No Projects Available
default
Unexpected Error
error
Up
post /projects/adaptive_heuristics/close
Send a list of project_ids to stop forwarding the project's alerts to the Stats Module. (closeAdaptiveHeuristics)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Multiple project_ids to close adaptive heuristic alert forwarding request
Request headers
Return type
Example data
Content-Type: application/json
{
"project_status" : [ {
"status_message" : "status_message",
"project_id" : "project_id",
"project_updated" : true
}, {
"status_message" : "status_message",
"project_id" : "project_id",
"project_updated" : true
} ],
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Adaptive Heuristic Forwarding Successfully Closed
adaptive_heuristic_close_response
206
Some Error Occurred
adaptive_heuristic_close_response
400
Invalid Request
default
Unexpected Error
error
Up
post /projects/classifiers/retrieve
Retrieve projects from the DataHub for Classification at the Stats Module (getProjectsForClassifier)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Tool and taxonomy information the requesting module already has, along with projects it is requesting.
Request headers
Return type
Example data
Content-Type: application/json
{
"projects" : [ {
"uploader_id" : "uploader_id",
"project_description" : "project_description",
"package" : {
"alerts" : "",
"test_suite_id" : "test_suite_id",
"uploader_id" : "uploader_id",
"updated_at" : "2000-01-23T04:56:07.000+00:00",
"package_name" : "package_name",
"created_at" : "2000-01-23T04:56:07.000+00:00",
"package_id" : "package_id",
"code_languages" : "",
"tools" : [ {
"tool_name" : "tool_name",
"author_source" : "author_source",
"uploader_id" : "uploader_id",
"tool_version" : "tool_version",
"source_mappings" : [ {
"mapping_source" : "mapping_source",
"checker_mappings" : [ {
"checker_name" : "checker_name",
"tool_id" : "tool_id",
"checker_id" : "checker_id",
"conditions" : [ {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
}, {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
} ]
}, {
"checker_name" : "checker_name",
"tool_id" : "tool_id",
"checker_id" : "checker_id",
"conditions" : [ {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
}, {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
} ]
} ]
}, {
"mapping_source" : "mapping_source",
"checker_mappings" : [ {
"checker_name" : "checker_name",
"tool_id" : "tool_id",
"checker_id" : "checker_id",
"conditions" : [ {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
}, {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
} ]
}, {
"checker_name" : "checker_name",
"tool_id" : "tool_id",
"checker_id" : "checker_id",
"conditions" : [ {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
}, {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
} ]
} ]
} ],
"tool_id" : "tool_id",
"metrics_data_headers" : "{}",
"category" : "category",
"uploader_organization_id" : "uploader_organization_id"
}, {
"tool_name" : "tool_name",
"author_source" : "author_source",
"uploader_id" : "uploader_id",
"tool_version" : "tool_version",
"source_mappings" : [ {
"mapping_source" : "mapping_source",
"checker_mappings" : [ {
"checker_name" : "checker_name",
"tool_id" : "tool_id",
"checker_id" : "checker_id",
"conditions" : [ {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
}, {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
} ]
}, {
"checker_name" : "checker_name",
"tool_id" : "tool_id",
"checker_id" : "checker_id",
"conditions" : [ {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
}, {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
} ]
} ]
}, {
"mapping_source" : "mapping_source",
"checker_mappings" : [ {
"checker_name" : "checker_name",
"tool_id" : "tool_id",
"checker_id" : "checker_id",
"conditions" : [ {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
}, {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
} ]
}, {
"checker_name" : "checker_name",
"tool_id" : "tool_id",
"checker_id" : "checker_id",
"conditions" : [ {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
}, {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
} ]
} ]
} ],
"tool_id" : "tool_id",
"metrics_data_headers" : "{}",
"category" : "category",
"uploader_organization_id" : "uploader_organization_id"
} ],
"uploader_organization_id" : "uploader_organization_id",
"sourcefiles" : [ {
"filepath_depth" : "filepath_depth",
"filename" : "filename",
"filepath" : "filepath",
"functions" : [ {
"code_metrics_data" : [ null, null ],
"name" : "name",
"line_start" : 0,
"line_end" : 6
}, {
"code_metrics_data" : [ null, null ],
"name" : "name",
"line_start" : 0,
"line_end" : 6
} ],
"sourcefile_id" : "sourcefile_id",
"code_metrics_data" : [ { }, { } ],
"defect_info" : {
"key" : ""
}
}, {
"filepath_depth" : "filepath_depth",
"filename" : "filename",
"filepath" : "filepath",
"functions" : [ {
"code_metrics_data" : [ null, null ],
"name" : "name",
"line_start" : 0,
"line_end" : 6
}, {
"code_metrics_data" : [ null, null ],
"name" : "name",
"line_start" : 0,
"line_end" : 6
} ],
"sourcefile_id" : "sourcefile_id",
"code_metrics_data" : [ { }, { } ],
"defect_info" : {
"key" : ""
}
} ],
"package_description" : "package_description"
},
"meta_alerts" : [ {
"filepath" : "filepath",
"line_number" : 0,
"determination" : {
"flag_list" : [ {
"flag" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"flag" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"inapplicable_environment_list" : [ {
"inapplicable_environment" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"inapplicable_environment" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"ignored_list" : [ {
"ignored" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"ignored" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"verdict_list" : [ {
"verdict" : "verdict",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"verdict" : "verdict",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"dead_list" : [ {
"dead" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"dead" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"dangerous_construct_list" : [ {
"dangerous_construct" : "dangerous_construct",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"dangerous_construct" : "dangerous_construct",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"notes_list" : [ {
"notes" : "notes",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"notes" : "notes",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ]
},
"meta_alert_id" : "meta_alert_id",
"condition_id" : "condition_id",
"alert_ids" : [ "alert_ids", "alert_ids" ],
"auto_verdict" : {
"key" : "auto_verdict"
}
}, {
"filepath" : "filepath",
"line_number" : 0,
"determination" : {
"flag_list" : [ {
"flag" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"flag" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"inapplicable_environment_list" : [ {
"inapplicable_environment" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"inapplicable_environment" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"ignored_list" : [ {
"ignored" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"ignored" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"verdict_list" : [ {
"verdict" : "verdict",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"verdict" : "verdict",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"dead_list" : [ {
"dead" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"dead" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"dangerous_construct_list" : [ {
"dangerous_construct" : "dangerous_construct",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"dangerous_construct" : "dangerous_construct",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"notes_list" : [ {
"notes" : "notes",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"notes" : "notes",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ]
},
"meta_alert_id" : "meta_alert_id",
"condition_id" : "condition_id",
"alert_ids" : [ "alert_ids", "alert_ids" ],
"auto_verdict" : {
"key" : "auto_verdict"
}
} ],
"updated_at" : "2000-01-23T04:56:07.000+00:00",
"project_id" : "project_id",
"taxonomies" : [ {
"taxonomy_id" : "taxonomy_id",
"taxonomy_version" : "taxonomy_version",
"description" : "description",
"conditions" : [ {
"code_language_ids" : [ "code_language_ids", "code_language_ids" ],
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
}, {
"code_language_ids" : [ "code_language_ids", "code_language_ids" ],
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
} ],
"taxonomy_name" : "taxonomy_name"
}, {
"taxonomy_id" : "taxonomy_id",
"taxonomy_version" : "taxonomy_version",
"description" : "description",
"conditions" : [ {
"code_language_ids" : [ "code_language_ids", "code_language_ids" ],
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
}, {
"code_language_ids" : [ "code_language_ids", "code_language_ids" ],
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
} ],
"taxonomy_name" : "taxonomy_name"
} ],
"created_at" : "2000-01-23T04:56:07.000+00:00",
"project_name" : "project_name",
"uploader_organization_id" : "uploader_organization_id"
}, {
"uploader_id" : "uploader_id",
"project_description" : "project_description",
"package" : {
"alerts" : "",
"test_suite_id" : "test_suite_id",
"uploader_id" : "uploader_id",
"updated_at" : "2000-01-23T04:56:07.000+00:00",
"package_name" : "package_name",
"created_at" : "2000-01-23T04:56:07.000+00:00",
"package_id" : "package_id",
"code_languages" : "",
"tools" : [ {
"tool_name" : "tool_name",
"author_source" : "author_source",
"uploader_id" : "uploader_id",
"tool_version" : "tool_version",
"source_mappings" : [ {
"mapping_source" : "mapping_source",
"checker_mappings" : [ {
"checker_name" : "checker_name",
"tool_id" : "tool_id",
"checker_id" : "checker_id",
"conditions" : [ {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
}, {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
} ]
}, {
"checker_name" : "checker_name",
"tool_id" : "tool_id",
"checker_id" : "checker_id",
"conditions" : [ {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
}, {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
} ]
} ]
}, {
"mapping_source" : "mapping_source",
"checker_mappings" : [ {
"checker_name" : "checker_name",
"tool_id" : "tool_id",
"checker_id" : "checker_id",
"conditions" : [ {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
}, {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
} ]
}, {
"checker_name" : "checker_name",
"tool_id" : "tool_id",
"checker_id" : "checker_id",
"conditions" : [ {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
}, {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
} ]
} ]
} ],
"tool_id" : "tool_id",
"metrics_data_headers" : "{}",
"category" : "category",
"uploader_organization_id" : "uploader_organization_id"
}, {
"tool_name" : "tool_name",
"author_source" : "author_source",
"uploader_id" : "uploader_id",
"tool_version" : "tool_version",
"source_mappings" : [ {
"mapping_source" : "mapping_source",
"checker_mappings" : [ {
"checker_name" : "checker_name",
"tool_id" : "tool_id",
"checker_id" : "checker_id",
"conditions" : [ {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
}, {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
} ]
}, {
"checker_name" : "checker_name",
"tool_id" : "tool_id",
"checker_id" : "checker_id",
"conditions" : [ {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
}, {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
} ]
} ]
}, {
"mapping_source" : "mapping_source",
"checker_mappings" : [ {
"checker_name" : "checker_name",
"tool_id" : "tool_id",
"checker_id" : "checker_id",
"conditions" : [ {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
}, {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
} ]
}, {
"checker_name" : "checker_name",
"tool_id" : "tool_id",
"checker_id" : "checker_id",
"conditions" : [ {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
}, {
"condition" : {
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
},
"language_ids" : [ "language_ids", "language_ids" ]
} ]
} ]
} ],
"tool_id" : "tool_id",
"metrics_data_headers" : "{}",
"category" : "category",
"uploader_organization_id" : "uploader_organization_id"
} ],
"uploader_organization_id" : "uploader_organization_id",
"sourcefiles" : [ {
"filepath_depth" : "filepath_depth",
"filename" : "filename",
"filepath" : "filepath",
"functions" : [ {
"code_metrics_data" : [ null, null ],
"name" : "name",
"line_start" : 0,
"line_end" : 6
}, {
"code_metrics_data" : [ null, null ],
"name" : "name",
"line_start" : 0,
"line_end" : 6
} ],
"sourcefile_id" : "sourcefile_id",
"code_metrics_data" : [ { }, { } ],
"defect_info" : {
"key" : ""
}
}, {
"filepath_depth" : "filepath_depth",
"filename" : "filename",
"filepath" : "filepath",
"functions" : [ {
"code_metrics_data" : [ null, null ],
"name" : "name",
"line_start" : 0,
"line_end" : 6
}, {
"code_metrics_data" : [ null, null ],
"name" : "name",
"line_start" : 0,
"line_end" : 6
} ],
"sourcefile_id" : "sourcefile_id",
"code_metrics_data" : [ { }, { } ],
"defect_info" : {
"key" : ""
}
} ],
"package_description" : "package_description"
},
"meta_alerts" : [ {
"filepath" : "filepath",
"line_number" : 0,
"determination" : {
"flag_list" : [ {
"flag" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"flag" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"inapplicable_environment_list" : [ {
"inapplicable_environment" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"inapplicable_environment" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"ignored_list" : [ {
"ignored" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"ignored" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"verdict_list" : [ {
"verdict" : "verdict",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"verdict" : "verdict",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"dead_list" : [ {
"dead" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"dead" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"dangerous_construct_list" : [ {
"dangerous_construct" : "dangerous_construct",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"dangerous_construct" : "dangerous_construct",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"notes_list" : [ {
"notes" : "notes",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"notes" : "notes",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ]
},
"meta_alert_id" : "meta_alert_id",
"condition_id" : "condition_id",
"alert_ids" : [ "alert_ids", "alert_ids" ],
"auto_verdict" : {
"key" : "auto_verdict"
}
}, {
"filepath" : "filepath",
"line_number" : 0,
"determination" : {
"flag_list" : [ {
"flag" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"flag" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"inapplicable_environment_list" : [ {
"inapplicable_environment" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"inapplicable_environment" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"ignored_list" : [ {
"ignored" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"ignored" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"verdict_list" : [ {
"verdict" : "verdict",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"verdict" : "verdict",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"dead_list" : [ {
"dead" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"dead" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"dangerous_construct_list" : [ {
"dangerous_construct" : "dangerous_construct",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"dangerous_construct" : "dangerous_construct",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"notes_list" : [ {
"notes" : "notes",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"notes" : "notes",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ]
},
"meta_alert_id" : "meta_alert_id",
"condition_id" : "condition_id",
"alert_ids" : [ "alert_ids", "alert_ids" ],
"auto_verdict" : {
"key" : "auto_verdict"
}
} ],
"updated_at" : "2000-01-23T04:56:07.000+00:00",
"project_id" : "project_id",
"taxonomies" : [ {
"taxonomy_id" : "taxonomy_id",
"taxonomy_version" : "taxonomy_version",
"description" : "description",
"conditions" : [ {
"code_language_ids" : [ "code_language_ids", "code_language_ids" ],
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
}, {
"code_language_ids" : [ "code_language_ids", "code_language_ids" ],
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
} ],
"taxonomy_name" : "taxonomy_name"
}, {
"taxonomy_id" : "taxonomy_id",
"taxonomy_version" : "taxonomy_version",
"description" : "description",
"conditions" : [ {
"code_language_ids" : [ "code_language_ids", "code_language_ids" ],
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
}, {
"code_language_ids" : [ "code_language_ids", "code_language_ids" ],
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
} ],
"taxonomy_name" : "taxonomy_name"
} ],
"created_at" : "2000-01-23T04:56:07.000+00:00",
"project_name" : "project_name",
"uploader_organization_id" : "uploader_organization_id"
} ],
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Return Existing Projects
get_projects_classifier_response
400
Invalid Request
404
Projects Unavailable
default
Unexpected Error
error
Up
post /projects/{project_id}/classifiers/hold
Place a temporary hold on the data forwarding request from the DataHub (holdDataForClassifier)
Path parameters
project_id (required)
Path Parameter — The ID of the project
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"message" : "message",
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK, Data Forwarding Temporarily Stopped
request_token
400
Invalid Request
404
Project Unavailable
default
Unexpected Error
error
Up
put /projects/{project_id}/classifiers/hold
Remove the temporary hold on the data forwarding request from the DataHub (releaseDataHoldForClassifier)
Path parameters
project_id (required)
Path Parameter — The ID of the project
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"message" : "message",
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK, Data Forwarding Resumed
request_token
400
Invalid Request
404
Project Unavailable
default
Unexpected Error
error
Create a new language definition. (createLanguage)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Language information
Request headers
Return type
Example data
Content-Type: application/json
{
"language" : {
"code_language_id" : "code_language_id",
"language" : "language",
"version" : "version"
},
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Language Successfully Uploaded
create_language_response
400
Invalid Request
default
Unexpected Error
error
Create a new package. This request will return the package_id used to reference the package within the DataHub. Note, for metrics data uploads use PUT /tools/{tool_id}. (createPackage)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Data to the create package
Request headers
Return type
Example data
Content-Type: application/json
{
"status_message" : [ "status_message", "status_message" ],
"package" : {
"package_name" : "package_name",
"alert_mappings" : {
"key" : {
"primary_message" : {
"filepath" : "filepath",
"line_start" : 0,
"line_end" : 6
},
"tool_id" : "tool_id",
"checker_id" : "checker_id"
}
},
"package_id" : "package_id"
},
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Package Successfully Created
create_package_response
400
Unable to Create Package
default
Unexpected Error
error
Create a new project. The package and taxonomies should be uploaded to the DataHub prior to creating a project. This request will return the project_id to reference the project within the DataHub. (createProject)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Data to a create project
Request headers
Return type
Example data
Content-Type: application/json
{
"status_message" : [ "status_message", "status_message" ],
"project" : {
"project_id" : "project_id",
"meta_alert_mappings" : {
"key" : {
"filepath" : "filepath",
"line_number" : 0,
"condition_id" : "condition_id"
}
},
"project_name" : "project_name"
},
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Project Successfully Created
create_project_response
400
Unable to Create Project
default
Unexpected Error
error
Upload a new taxonomy to the DataHub Module. Returns the taxonomy_id and condition_ids to reference this Taxonomy and its Conditions. (createTaxonomy)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Taxonomy information to upload
Request headers
Return type
Example data
Content-Type: application/json
{
"taxonomy" : {
"taxonomy_id" : "taxonomy_id",
"conditions" : [ {
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id"
}, {
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id"
} ]
},
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK, Taxonomy Successfully Created
create_taxonomy_response
400
Unable to Create Taxonomy
default
Unexpected Error
error
Create a Test Suite in the DataHub Module. (createTestSuite)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Test Suite information to upload
Request headers
Return type
Example data
Content-Type: application/json
{
"status_message" : "status_message",
"test_suite" : {
"author_source" : "author_source",
"test_suite_version" : "test_suite_version",
"test_suite_id" : "test_suite_id",
"uploader_id" : "uploader_id",
"manifest_urls" : [ "http://example.com/aeiou", "http://example.com/aeiou" ],
"uploader_organization_id" : "uploader_organization_id",
"code_languages" : "",
"test_suite_name" : "test_suite_name"
},
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
test_suite_upload_response
400
Unable to Upload Test Suite
default
Unexpected Error
error
Up
delete /packages/{package_id}
Delete an existing package. (deletePackage)
Path parameters
package_id (required)
Path Parameter — ID of the package to delete
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"message" : "message",
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Package Successfully Deleted
request_token
400
Invalid Request
404
Unable to Delete Package
default
Unexpected Error
error
Up
delete /projects/{project_id}
Delete an existing project. (deleteProject)
Path parameters
project_id (required)
Path Parameter — The ID of the project to delete
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"message" : "message",
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Project Successfully Deleted
request_token
400
Invalid Request
404
Project Unavailable
default
Unexpected Error
error
Up
put /packages/{package_id}
Update an existing package. Use this method to add new alerts for the package. Note, for metrics data uploads use PUT /tools/{tool_id}. (editPackage)
Path parameters
package_id (required)
Path Parameter — ID of the package to update
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Package data to modify the existing package with
Request headers
Return type
Example data
Content-Type: application/json
{
"status_message" : "status_message",
"alert_mappings" : {
"key" : {
"primary_message" : {
"filepath" : "filepath",
"line_start" : 0,
"line_end" : 6
},
"tool_id" : "tool_id",
"checker_id" : "checker_id"
}
},
"package_id" : "package_id",
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Package Successfully Updated
edit_package_response
400
Invalid Request
404
Unable to Update Package
default
Unexpected Error
error
Up
put /projects/{project_id}
Update an existing project. This method can also be used to send only meta-alert determinations of an existing meta-alert to the DataHub, which is most useful when a project has an open adaptive heuristic set. (editProject)
Path parameters
project_id (required)
Path Parameter — The ID of the project to update
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Project data to modify the existing project with
Request headers
Return type
Example data
Content-Type: application/json
{
"status_message" : "status_message",
"project_id" : "project_id",
"meta_alert_mappings" : {
"key" : {
"filepath" : "filepath",
"line_number" : 0,
"condition_id" : "condition_id"
}
},
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Package was Successfully Updated
edit_project_response
400
Invalid Request
404
Unable to Update Project
default
Unexpected Error
error
Update a tool with Checker-Mapping or Metrics CSVs (editTool)
Path parameters
tool_id (required)
Path Parameter — Tool ID to update data
Consumes
This API call consumes the following media types via the request header:
application/jsonmultipart/form-data
Request headers
Form parameters
checker_mapping_csv (optional)
Form Parameter — CSV with checker mappings, the filename should match the mapping_filename in tool_metadata
metrics_tool_csv (optional)
Form Parameter — 'Metrics Tool CSV to Upload, the filename should contain one of the following values: 'lizard', 'understand', or 'ccsm''
Return type
Example data
Content-Type: application/json
{
"message" : "message",
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK, Tool Successfully Updated
request_token
400
Unable to Upload Checker or Metrics Information
default
Unexpected Error
error
Up
post /projects/retrieve
Retrieve projects from the DataHub. Send taxonomy information the requestor already has, along with projects it is requesting. This way, a response from the DataHub can efficiently leave out taxonomies that the requestor already has information for. (getProjects)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Taxonomy information the requesting module already has, along with projects it is requesting.
Request headers
Return type
Example data
Content-Type: application/json
{
"projects" : [ {
"author_source" : "author_source",
"uploader_id" : "uploader_id",
"project_description" : "project_description",
"meta_alerts" : [ {
"filepath" : "filepath",
"line_number" : 0,
"determination" : {
"flag_list" : [ {
"flag" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"flag" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"inapplicable_environment_list" : [ {
"inapplicable_environment" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"inapplicable_environment" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"ignored_list" : [ {
"ignored" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"ignored" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"verdict_list" : [ {
"verdict" : "verdict",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"verdict" : "verdict",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"dead_list" : [ {
"dead" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"dead" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"dangerous_construct_list" : [ {
"dangerous_construct" : "dangerous_construct",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"dangerous_construct" : "dangerous_construct",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"notes_list" : [ {
"notes" : "notes",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"notes" : "notes",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ]
},
"meta_alert_id" : "meta_alert_id",
"condition_id" : "condition_id",
"alert_ids" : [ "alert_ids", "alert_ids" ],
"auto_verdict" : {
"key" : "auto_verdict"
}
}, {
"filepath" : "filepath",
"line_number" : 0,
"determination" : {
"flag_list" : [ {
"flag" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"flag" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"inapplicable_environment_list" : [ {
"inapplicable_environment" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"inapplicable_environment" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"ignored_list" : [ {
"ignored" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"ignored" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"verdict_list" : [ {
"verdict" : "verdict",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"verdict" : "verdict",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"dead_list" : [ {
"dead" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"dead" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"dangerous_construct_list" : [ {
"dangerous_construct" : "dangerous_construct",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"dangerous_construct" : "dangerous_construct",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"notes_list" : [ {
"notes" : "notes",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"notes" : "notes",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ]
},
"meta_alert_id" : "meta_alert_id",
"condition_id" : "condition_id",
"alert_ids" : [ "alert_ids", "alert_ids" ],
"auto_verdict" : {
"key" : "auto_verdict"
}
} ],
"updated_at" : "2000-01-23T04:56:07.000+00:00",
"project_id" : "project_id",
"taxonomies" : [ {
"taxonomy_id" : "taxonomy_id",
"taxonomy_version" : "taxonomy_version",
"description" : "description",
"conditions" : [ {
"code_language_ids" : [ "code_language_ids", "code_language_ids" ],
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
}, {
"code_language_ids" : [ "code_language_ids", "code_language_ids" ],
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
} ],
"taxonomy_name" : "taxonomy_name"
}, {
"taxonomy_id" : "taxonomy_id",
"taxonomy_version" : "taxonomy_version",
"description" : "description",
"conditions" : [ {
"code_language_ids" : [ "code_language_ids", "code_language_ids" ],
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
}, {
"code_language_ids" : [ "code_language_ids", "code_language_ids" ],
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
} ],
"taxonomy_name" : "taxonomy_name"
} ],
"created_at" : "2000-01-23T04:56:07.000+00:00",
"package_id" : "package_id",
"project_name" : "project_name",
"uploader_organization_id" : "uploader_organization_id"
}, {
"author_source" : "author_source",
"uploader_id" : "uploader_id",
"project_description" : "project_description",
"meta_alerts" : [ {
"filepath" : "filepath",
"line_number" : 0,
"determination" : {
"flag_list" : [ {
"flag" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"flag" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"inapplicable_environment_list" : [ {
"inapplicable_environment" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"inapplicable_environment" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"ignored_list" : [ {
"ignored" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"ignored" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"verdict_list" : [ {
"verdict" : "verdict",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"verdict" : "verdict",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"dead_list" : [ {
"dead" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"dead" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"dangerous_construct_list" : [ {
"dangerous_construct" : "dangerous_construct",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"dangerous_construct" : "dangerous_construct",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"notes_list" : [ {
"notes" : "notes",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"notes" : "notes",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ]
},
"meta_alert_id" : "meta_alert_id",
"condition_id" : "condition_id",
"alert_ids" : [ "alert_ids", "alert_ids" ],
"auto_verdict" : {
"key" : "auto_verdict"
}
}, {
"filepath" : "filepath",
"line_number" : 0,
"determination" : {
"flag_list" : [ {
"flag" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"flag" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"inapplicable_environment_list" : [ {
"inapplicable_environment" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"inapplicable_environment" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"ignored_list" : [ {
"ignored" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"ignored" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"verdict_list" : [ {
"verdict" : "verdict",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"verdict" : "verdict",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"dead_list" : [ {
"dead" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"dead" : true,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"dangerous_construct_list" : [ {
"dangerous_construct" : "dangerous_construct",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"dangerous_construct" : "dangerous_construct",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"notes_list" : [ {
"notes" : "notes",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"notes" : "notes",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ]
},
"meta_alert_id" : "meta_alert_id",
"condition_id" : "condition_id",
"alert_ids" : [ "alert_ids", "alert_ids" ],
"auto_verdict" : {
"key" : "auto_verdict"
}
} ],
"updated_at" : "2000-01-23T04:56:07.000+00:00",
"project_id" : "project_id",
"taxonomies" : [ {
"taxonomy_id" : "taxonomy_id",
"taxonomy_version" : "taxonomy_version",
"description" : "description",
"conditions" : [ {
"code_language_ids" : [ "code_language_ids", "code_language_ids" ],
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
}, {
"code_language_ids" : [ "code_language_ids", "code_language_ids" ],
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
} ],
"taxonomy_name" : "taxonomy_name"
}, {
"taxonomy_id" : "taxonomy_id",
"taxonomy_version" : "taxonomy_version",
"description" : "description",
"conditions" : [ {
"code_language_ids" : [ "code_language_ids", "code_language_ids" ],
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
}, {
"code_language_ids" : [ "code_language_ids", "code_language_ids" ],
"condition_fields" : "{}",
"condition_name" : "condition_name",
"title" : "title",
"condition_id" : "condition_id",
"platforms" : [ "platforms", "platforms" ]
} ],
"taxonomy_name" : "taxonomy_name"
} ],
"created_at" : "2000-01-23T04:56:07.000+00:00",
"package_id" : "package_id",
"project_name" : "project_name",
"uploader_organization_id" : "uploader_organization_id"
} ],
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Return Existing Projects
get_projects_response
400
Invalid Request
404
Projects Unavailable
default
Unexpected Error
error
Up
post /packages/{package_id}
Upload a Source Code Archive and MetaData Files for the Package. (uploadCodebaseForPackage)
Path parameters
package_id (required)
Path Parameter — ID of the package to update
Consumes
This API call consumes the following media types via the request header:
application/jsonmultipart/form-data
Request headers
Form parameters
sourcecode_archive (required)
Form Parameter — Source Code Archive for this package
source_file_csv (optional)
Form Parameter — Source File CSV
source_function_csv (optional)
Form Parameter — Source Function CSV
Return type
Example data
Content-Type: application/json
{
"message" : "message",
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Code Source Successfully Uploaded
request_token
400
Invalid Request
404
Unable to Upload Code Source Archive
default
Unexpected Error
error
Up
post /test_suites/{test_suite_id}/packages/{package_id}
Upload Test Suite MetaData Files (uploadTestSuite)
Path parameters
test_suite_id (required)
Path Parameter — Test Suite ID to upload data files
package_id (required)
Path Parameter — Package ID to upload data files
Consumes
This API call consumes the following media types via the request header:
multipart/form-dataapplication/json
Request headers
Form parameters
manifest_file (required)
Form Parameter —
use_license_file (optional)
Form Parameter —
source_file_csv (optional)
Form Parameter — Source File CSV
source_function_csv (optional)
Form Parameter — Source Function CSV
Return type
Example data
Content-Type: application/json
{
"message" : "message",
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Data Successfully Uploaded
request_token
400
Invalid Request
404
Unable to Upload MetaData Files
default
Unexpected Error
error
Upload a new Tool to the DataHub Module. Returns a tool_id to reference the tool in the DataHub Module. For code metrics tools, upload a list of ordered field names. (uploadTool)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Tool information to upload
Request headers
Return type
Example data
Content-Type: application/json
{
"status_message" : "status_message",
"request_id" : "request_id",
"tool" : {
"tool_name" : "tool_name",
"tool_version" : "tool_version",
"code_language_ids" : [ "code_language_ids", "code_language_ids" ],
"tool_id" : "tool_id",
"category" : "category"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK, Tool Successfully Uploaded
tool_upload_response
400
Unable to Upload Tool Information
default
Unexpected Error
error
Up
post /tools/{tool_id}/packages/{package_id}
Upload Raw Tool Output (uploadToolOutput)
Path parameters
tool_id (required)
Path Parameter — Tool ID to upload data
package_id (required)
Path Parameter — Package ID to upload data
Consumes
This API call consumes the following media types via the request header:
application/jsonmultipart/form-data
Request headers
Form parameters
raw_tool_output (required)
Form Parameter — Raw Tool Output to Upload to the DataHub
Return type
Example data
Content-Type: application/json
{
"message" : "message",
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK, Tool Output Successfully Uploaded
request_token
400
Unable to Upload Tool Output
default
Unexpected Error
error
[ Jump to Methods ]
Table of Contents
adaptive_heuristic_close_response - alert_mappings - alert_no_id - alert_w_id - checker_conditions - checker_mappings - checker_mappings_metadata - classifier_package - classifier_project - classifier_projects_requested - condition - condition_heading - condition_languages - condition_map - condition_metadata - condition_response - create_language_response - create_package_response - create_project_response - create_taxonomy - create_taxonomy_response - created_package - created_project - determination - determination_dangerous_construct_list - determination_dead_list - determination_flag_list - determination_ignored_list - determination_inapplicable_environment_list - determination_notes_list - determination_verdict_list - edit_package - edit_package_response - edit_project - edit_project_response - error - get_alerts_response - get_classifier_tool - get_package_response - get_projects_classifier_response - get_projects_response - get_taxonomy - get_taxonomy_response - get_tool - get_tool_response - language_version - language_version_w_id - list_languages - list_languages_response - list_packages - list_packages_response - list_projects - list_projects_response - message - meta_alert_mappings - meta_alert_no_id - meta_alert_w_id - metrics - package - package_alerts - package_alerts_w_id - package_heading - package_metadata - project - project_heading - project_heuristic_message - project_ids - project_meta_alerts - project_metadata - project_status - projects_requested - request_token - secondary_messages - secondary_messages_inner - source_mappings - sourcefile - sourcefunction - taxonomies_present - taxonomy_heading - taxonomy_list_response - taxonomy_metadata - test_suite_heading - test_suite_list_response - test_suite_metadata - test_suite_upload_response - tool_heading - tool_list_response - tool_metadata - tool_response - tool_taxonomies_present - tool_upload_response -
request_id
project_status
tool_id
checker_id
primary_message
tool_id
checker_id
code_language
primary_message
secondary_messages (optional)
alert_id
tool_id
checker_id
code_language_id (optional)
primary_message
secondary_messages (optional)
checker_id (optional)
checker_name (optional)
conditions (optional)
checker_id (optional)
checker_name (optional)
tool_id (optional)
conditions (optional)
mapping_source (optional)
String Source of the mapping, e.g., CERT wiki, scale.app, etc.
mapper_identity (optional)
mapping_version (optional)
publishable_public_or_not (optional)
dod_publication (optional)
deprecated_or_not (optional)
license_information (optional)
additional_notes (optional)
description (optional)
mapping_date (optional)
mapping_filename (optional)
String Filename of the mappings CSV that this data describes and will be uploaded in a subsequent call
mappings (optional)
package_id
package_name
package_description (optional)
code_languages (optional)
alerts (optional)
test_suite_id (optional)
tools (optional)
sourcefiles (optional)
uploader_id (optional)
uploader_organization_id (optional)
created_at
updated_at (optional)
project_id (optional)
project_name (optional)
project_description (optional)
package (optional)
meta_alerts (optional)
taxonomies (optional)
uploader_id (optional)
uploader_organization_id (optional)
created_at (optional)
updated_at (optional)
tool_taxonomies_present (optional)
project_status
code_language_ids (optional)
condition_name
title
platforms (optional)
condition_fields (optional)
Object Fields associated with this condition, i.e., likelihood
condition_id (optional)
condition_name (optional)
title (optional)
condition (optional)
language_ids (optional)
taxonomy_id (optional)
condition_id
code_language_ids (optional)
condition_id (optional)
condition_name (optional)
title (optional)
platforms (optional)
condition_fields (optional)
Object Fields associated with this condition, i.e., likelihood
condition_id
code_language_ids (optional)
condition_name
title
platforms (optional)
condition_fields (optional)
Object Fields associated with this condition, i.e., likelihood
request_id (optional)
language (optional)
request_id
package
status_message (optional)
array[String] Messages indicating the status of the package upload.
request_id
project
status_message (optional)
array[String] Messages indicating the status of the package upload.
request_id (optional)
taxonomy (optional)
package_id
package_name
alert_mappings (optional)
project_id
project_name
meta_alert_mappings (optional)
flag_list (optional)
verdict_list (optional)
ignored_list (optional)
dead_list (optional)
inapplicable_environment_list (optional)
dangerous_construct_list (optional)
notes_list (optional)
dangerous_construct (optional)
timestamp (optional)
dead (optional)
timestamp (optional)
flag (optional)
timestamp (optional)
ignored (optional)
timestamp (optional)
inapplicable_environment (optional)
timestamp (optional)
notes (optional)
timestamp (optional)
verdict (optional)
timestamp (optional)
package_name (optional)
package_description (optional)
tool_ids (optional)
String List of new tools for this package
alerts (optional)
request_id
package_id
alert_mappings (optional)
status_message
project_name (optional)
project_description (optional)
taxonomy_ids (optional)
meta_alerts (optional)
request_id
project_id
meta_alert_mappings (optional)
status_message
request_id (optional)
meta_alerts (optional)
alerts (optional)
tool_id
tool_name
tool_version
category
source_mappings (optional)
metrics_data_headers (optional)
Object Header fields expected for the metrics data
uploader_id (optional)
uploader_organization_id (optional)
author_source (optional)
taxonomy_id
taxonomy_name
String Name of the taxonomy, i.e., CERT or CWE
taxonomy_version
description (optional)
conditions (optional)
tool_id
tool_name
tool_version
category
checker_mappings (optional)
metrics_data_headers (optional)
Object Header fields expected for the metrics data
uploader_id (optional)
uploader_organization_id (optional)
author_source (optional)
request_id (optional)
tool (optional)
language
version (optional)
code_language_id
language
version (optional)
line_start
line_end (optional)
filepath
condition_id
filepath
line_number
condition_id
filepath
line_number
alert_ids (optional)
determination (optional)
auto_verdict (optional)
meta_alert_id
condition_id
filepath
line_number
alert_ids (optional)
determination (optional)
auto_verdict (optional)
package_id
package_name
package_description (optional)
code_languages (optional)
alerts (optional)
code_metrics (optional)
test_suite_id (optional)
uploader_id (optional)
uploader_organization_id (optional)
author_source (optional)
tool_ids (optional)
created_at
updated_at (optional)
package_id
package_name
package_description
uploader_id (optional)
uploader_organization_id (optional)
author_source (optional)
code__languages (optional)
package_name
package_description
author_source (optional)
code_language_ids
codesource_url (optional)
String URL to Source Code Archive format: uri
sourcefile_url (optional)
sourcefunction_url (optional)
test_suite_id (optional)
String Test Suite Associated with this Package
alerts (optional)
tool_ids (optional)
project_id (optional)
project_name (optional)
project_description (optional)
package_id (optional)
uploader_id (optional)
uploader_organization_id (optional)
author_source (optional)
meta_alerts (optional)
taxonomies (optional)
created_at (optional)
updated_at (optional)
project_id
project_name
project_description (optional)
package_id
uploader_id (optional)
uploader_organization_id (optional)
author_source (optional)
project_id (optional)
project_updated (optional)
status_message (optional)
project_name
project_description
author_source (optional)
package_id
meta_alerts (optional)
taxonomy_ids (optional)
project_id
set_adaptive_heuristic_open
taxonomies_present (optional)
project_ids
request_id
String ID used to correlate messages with each other
message (optional)
line_start
line_end (optional)
filepath
message_text
mapping_source (optional)
checker_mappings (optional)
sourcefile_id (optional)
filename (optional)
filepath (optional)
filepath_depth (optional)
defect_info (optional)
code_metrics_data (optional)
functions (optional)
name (optional)
line_start (optional)
line_end (optional)
code_metrics_data (optional)
taxonomy_ids (optional)
array[String] List of taxonomies already present at the source module (Stats). The destination module (DataHub) will use this list to avoid sending duplicate taxonomy information.
taxonomy_id
taxonomy_name
taxonomy_version
uploader_id (optional)
uploader_organization_id (optional)
author_source (optional)
taxonomy_name
taxonomy_version
description
author_source (optional)
String Author/Agency source of the taxonomy information
conditions
test_suite_id
test_suite_name
test_suite_version
manifest_urls (optional)
uploader_id (optional)
uploader_organization_id (optional)
author_source (optional)
String Author/Agency source of the test suite information
code_languages (optional)
test_suite_name
test_suite_version
manifest_urls (optional)
use_license_file_url (optional)
author_source (optional)
String Author/Agency source of the test suite information
code_languages (optional)
request_id
test_suite
status_message (optional)
tool_id
tool_name
tool_version
code_language_ids (optional)
uploader_id (optional)
uploader_organization_id (optional)
author_source (optional)
tool_name
tool_version
category
String The type of tool, e.g., FFSA or Metrics
code_language_ids (optional)
checker_mappings (optional)
code_metrics_headers (optional)
Object Header fields expected for the metrics data
tool_id
tool_name
tool_version
category (optional)
code_language_ids (optional)
tool_ids (optional)
array[String] List of tools already present at the source module (Stats). The destination module (DataHub) will use this list to avoid sending duplicate tool information.
taxonomy_ids (optional)
array[String] List of taxonomies already present at the source module (Stats). The destination module (DataHub) will use this list to avoid sending duplicate taxonomy information.
request_id
tool
status_message (optional)