/revisions/{locator}/report/remediation-guidance

get

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

Returns the Remediation Guidance report for a given revision

Path Params

locator

string

required

Query Params

preview

boolean

Whether to preview the report (default is false)

format

string

enum

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

Allowed:

bundle

boolean

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

excludeQuickWins

boolean

Whether to exclude Quick Wins section (default is false)

excludeHighPriority

boolean

Whether to exclude High Priority section (default is false)

excludedLowPriority

boolean

Whether to exclude Low Priority section (default is false)

excludeOutdatedDependencies

boolean

Whether to exclude Outdated Dependencies section (default is false)

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/pdf

application/zip

text/html

application/json

200OK