Docs

Get Revision Attribution Email

gethttps://app.fossa.com/api/revisions/{locator}/attribution/email

Queue a job to generate and send an email of a revision's attribution report

Path parameters

locatorstringrequired

the url-encoded locator of the revision

Query parameters

accessstring

The public ID

previewboolean

Whether to preview the report (default is false)

formatenum

The format of the report

HTMLMDPDFCSVTXTSPDXSPDX_JSONCYCLONEDX_JSONCYCLONEDX_XML
includeDeepDependenciesboolean

Whether to include deep dependencies (default is true)

includeDirectDependenciesboolean

Whether to include direct dependencies (default is true)

includeLicenseListboolean

Whether to include the license list (default is false)

includeLicenseScanboolean

Whether to include the license scan (default is false)

includeProjectLicenseboolean

Whether to include the project license (default is false)

includeCopyrightListboolean

Whether to include the copyright list (default is false)

includeFileMatchesboolean

Whether to include the file matches (default is false)

includeOpenVulnerabilitiesboolean

Whether to include the open vulnerabilities (default is false)

includeClosedVulnerabilitiesboolean

Whether to include the closed vulnerabilities (default is false)

includeDependencySummaryboolean

Whether to include the dependency summary (default is false)

includeLicenseHeadersboolean

Whether to include the license headers (default is false)

includePackageLabelsboolean

Whether to include the package labels assigned to each dependency (default is false).

excludeFieldsobject

Object controlling which dependencies are excluded from the report. The only supported nested field is `packageLabels`: a non-empty array of package-label values; dependencies carrying any of these labels are excluded from the report.

Responses

200A JSON representation of the Task in our Database
attempt_numberinteger

The number of attempts

idinteger

The ID of the task

taskstring

The task to be performed

contextobject
userIdinteger

The user's ID

reportOptionsobject

The report options

downloadboolean

Whether to download the report

createPublicReportboolean

Whether to create a public report

emailboolean

Whether to email the report

includeDeepDependenciesboolean

Whether to include deep dependencies

includeDirectDependenciesboolean

Whether to include direct dependencies

includeLicenseListboolean

Whether to include the license list

includeLicenseScanboolean

Whether to include the license scan

includeProjectLicenseboolean

Whether to include the project license

includeCopyrightListboolean

Whether to include the copyright list

includeFileMatchesboolean

Whether to include the file matches

includeOpenVulnerabilitiesboolean

Whether to include the open vulnerabilities

includeClosedVulnerabilitiesboolean

Whether to include the closed vulnerabilities

includeDependencySummaryboolean

Whether to include the dependency summary

includeLicenseHeadersboolean

Whether to include the license headers

locatorstring

The locator

maxRetriesinteger

The maximum number of retries

scheduledStartTimestring <date-time>

The scheduled start time

updatedAtstring <date-time>

The time the task was last updated

createdAtstring <date-time>

The time the task was created

startedstring <date-time>

The time the task was started

finishedstring <date-time>

The time the task was finished

podstring

The pod the task is running on

statusstring

The status of the task

jobTokenstring

The token of the job in the FOSSA Backend

401Unauthorized
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

404Not Found
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

500Server Error
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

Try this endpoint

Build a request and run it against app.fossa.com.

Bearer

Stored in this browser for 24 hours. Try It uses a docs proxy for CORS and does not store tokens server-side.

GET https://app.fossa.com/api/revisions/%7Blocator%7D/attribution/email
curl --request GET \  --url 'https://app.fossa.com/api/revisions/%7Blocator%7D/attribution/email' \  --header 'accept: application/json' \  --header 'authorization: Bearer YOUR_API_TOKEN'

Real request. Mutating methods can change data.

Click Try It to run a request and see the response here.
Enter a Bearer token before running this request.

Path params

locatorstringrequired

the url-encoded locator of the revision

Query params

accessstring

The public ID

previewboolean

Whether to preview the report (default is false)

formatenum

The format of the report

includeDeepDependenciesboolean

Whether to include deep dependencies (default is true)

includeDirectDependenciesboolean

Whether to include direct dependencies (default is true)

includeLicenseListboolean

Whether to include the license list (default is false)

includeLicenseScanboolean

Whether to include the license scan (default is false)

includeProjectLicenseboolean

Whether to include the project license (default is false)

includeCopyrightListboolean

Whether to include the copyright list (default is false)

includeFileMatchesboolean

Whether to include the file matches (default is false)

includeOpenVulnerabilitiesboolean

Whether to include the open vulnerabilities (default is false)

includeClosedVulnerabilitiesboolean

Whether to include the closed vulnerabilities (default is false)

includeDependencySummaryboolean

Whether to include the dependency summary (default is false)

includeLicenseHeadersboolean

Whether to include the license headers (default is false)

includePackageLabelsboolean

Whether to include the package labels assigned to each dependency (default is false).

excludeFieldsobject

Object controlling which dependencies are excluded from the report. The only supported nested field is `packageLabels`: a non-empty array of package-label values; dependencies carrying any of these labels are excluded from the report.

← All Revisions endpoints