Fix Plans

gethttps://app.fossa.com/api/revisions/{locator}/report/remediation-guidance

Returns the Remediation Guidance report for a given revision

Path parameters

locatorstringrequired

Query parameters

previewboolean

Whether to preview the report (default is false)

formatenum

What format to return the report in (default is PDF)

HTMLPDFJSON

bundleboolean

Whether to bundle the report with json file and return as a zip (default is false)

excludeQuickWinsboolean

Whether to exclude Quick Wins section (default is false)

excludeHighPriorityboolean

Whether to exclude High Priority section (default is false)

excludeLowPriorityboolean

Whether to exclude Low Priority section (default is false)

excludeOutdatedDependenciesboolean

Whether to exclude Outdated Dependencies section (default is false)

demoboolean

Whether to generate the report in demo mode (default is false)

includeTransitiveVulnsboolean

Whether to include transitive vulnerabilities (default is false)

deduplicateOutdatedDepsboolean

Whether to deduplicate outdated dependencies (default is false)

includeMalwareboolean

Whether to include malware findings (default is false). Only takes effect when the organization has the malware-issues feature enabled.

Responses

200OK

string <binary>

400BadRequest

uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

403Forbidden. Returned when the organization is below the Premium subscription level (a `ForbiddenError`), or when the organization does not have Security enabled (a `FeatureAccessRestrictedError`).