Queue Release Group Attribution Report
https://app.fossa.com/api/project_group/{groupId}/release/{releaseId}/attribution/{format}Submit a Release Group attribution report for processing.
Path parameters
groupIdintegerrequiredThe ID of the release group
releaseIdintegerrequiredformatenumrequiredHTMLMDPDFCSVTXTSPDXSPDX_JSONCYCLONEDX_JSONCYCLONEDX_XMLQuery parameters
includeDeepDependenciesbooleanincludeDirectDependenciesbooleanincludeFOSSADependenciesbooleanincludeLicenseListbooleanincludeLicenseScanbooleanincludeProjectLicensebooleanincludeCopyrightListbooleanincludeFileMatchesbooleanincludeOpenVulnerabilitiesbooleanincludeClosedVulnerabilitiesbooleanincludeDependencySummarybooleanincludeLicenseHeadersbooleandependencyInfoOptions[]enum[]isPublishingbooleanWhether to publish the report to the portal
deliveryenumHow a queued report reaches the user. `email` sends it to the requesting user (or `emails`). `download` skips the email; once the task finishes, fetch the report from `https://<host>/attribution/{reportId}?download=true` (not under `/api`), which responds with a redirect to a short-lived signed URL. Only applies to queued reports; ignored when `preview` or `download=true` is set. Cannot be combined with `isPublishing`.
emaildownloadResponses
200OKtaskIdintegerreportIdstring <uuid>The report's ID. Once the task finishes, fetch the report from `https://<host>/attribution/{reportId}?download=true` (not under `/api`), which responds with a redirect to a short-lived signed URL.
400BadRequestuuidstringUnique identifier associated with the error
codeintegerfossa specific error code
messagestringmessage associated with this error
namestringname of the error
httpStatusCodeintegerhttp status code number
403ForbiddenuuidstringUnique identifier associated with the error
codeintegerfossa specific error code
messagestringmessage associated with this error
namestringname of the error
httpStatusCodeintegerhttp status code number
404NotFounduuidstringUnique identifier associated with the error
codeintegerfossa specific error code
messagestringmessage associated with this error
namestringname of the error
httpStatusCodeintegerhttp status code number
Try this endpoint
Build a request and run it against app.fossa.com.
Stored in this browser for 24 hours. Try It uses a docs proxy for CORS and does not store tokens server-side.
POST https://app.fossa.com/api/project_group/1/release/1/attribution/HTMLcurl --request POST \ --url 'https://app.fossa.com/api/project_group/1/release/1/attribution/HTML' \ --header 'accept: application/json' \ --header 'authorization: Bearer YOUR_API_TOKEN'Real request. Mutating methods can change data.
Path params
groupIdintegerrequiredThe ID of the release group
releaseIdintegerrequiredformatenumrequiredQuery params
includeDeepDependenciesbooleanincludeDirectDependenciesbooleanincludeFOSSADependenciesbooleanincludeLicenseListbooleanincludeLicenseScanbooleanincludeProjectLicensebooleanincludeCopyrightListbooleanincludeFileMatchesbooleanincludeOpenVulnerabilitiesbooleanincludeClosedVulnerabilitiesbooleanincludeDependencySummarybooleanincludeLicenseHeadersbooleandependencyInfoOptions[]arrayisPublishingbooleanWhether to publish the report to the portal
deliveryenumHow a queued report reaches the user. `email` sends it to the requesting user (or `emails`). `download` skips the email; once the task finishes, fetch the report from `https://<host>/attribution/{reportId}?download=true` (not under `/api`), which responds with a redirect to a short-lived signed URL. Only applies to queued reports; ignored when `preview` or `download=true` is set. Cannot be combined with `isPublishing`.