Struct CreateReport 

pub struct CreateReport {
    pub program: String,
    pub title: String,
    pub vulnerability_information: Option<String>,
    pub impact: Option<String>,
    pub severity_rating: Option<SeverityRating>,
    pub weakness_id: Option<String>,
    pub structured_scope_id: Option<String>,
    pub custom_fields: BTreeMap<String, Value>,
}

A report to create. Build it with the chainable methods, then Client::create_report.

Fields

program: String

Program handle or numeric id (required).

title: String

Report title (required).

vulnerability_information: Option<String>

The finding write-up.

impact: Option<String>

Business impact.

severity_rating: Option<SeverityRating>

Suggested severity.

weakness_id: Option<String>

Weakness id (CWE mapping) — GET /v1/weaknesses resolves these.

structured_scope_id: Option<String>

Structured scope id this report targets.

custom_fields: BTreeMap<String, Value>

Program-specific custom fields.

Implementations

impl CreateReport

pub fn new(program: impl Into<String>, title: impl Into<String>) -> Self

A report for program with title.

pub fn vulnerability_information(self, text: impl Into<String>) -> Self

Set the vulnerability write-up.

pub fn impact(self, text: impl Into<String>) -> Self

Set the impact statement.

pub fn severity(self, rating: SeverityRating) -> Self

Suggest a severity.

pub fn weakness(self, id: impl Into<String>) -> Self

Attach a weakness id.

pub fn structured_scope(self, id: impl Into<String>) -> Self

Pin the structured scope.

pub fn custom_field(self, key: impl Into<String>, value: Value) -> Self

Set a program-specific custom field.

pub fn to_json(&self) -> Result<Value, Error>

Render the JSON:API request body.

Trait Implementations

impl Clone for CreateReport

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateReport

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CreateReport

fn default() -> Self

Returns the “default value” for a type.