Skip to content
Platform API 3.0
/
/
Export project Attributio...

Export project Attribution report asynchronously (Dependencies - SCA)

Request

Generates a Dependencies Attribution report for the specified project asynchronously. Supported formats: JSON, HTML, TEXT.

Security
bearer-key
Path
projectUuidstringrequired

UUID of the project

Bodyapplication/jsonrequired
namestring
formatstring

Output file format. The Attribution report supports json, html and text.

Enum:"json""html""text"
Example:"json"
sendEmailNotificationboolean
licensesArray of strings
primaryAttributestring
librarystring
groupBystring
headerstring
titlestring
footerstring
licenseReferencestring
licenseTextPlacementstring
selectedColumnsArray of strings
customAttributestring
includeSummaryboolean
includeVersionboolean
hideEmptyFieldsboolean
groupByOrDefaultstring
licenseReferenceOrDefaultstring
licenseTextPlacementOrDefaultstring
selectedColumnsOrDefaultStringstring
POST
/api/v3.0/projects/{projectUuid}/dependencies/reports/attribution
{
  "name": "string",
  "format": "json",
  "sendEmailNotification": true,
  "licenses": [
    "string"
  ],
  "primaryAttribute": "string",
  "library": "string",
  "groupBy": "string",
  "header": "string",
  "title": "string",
  "footer": "string",
  "licenseReference": "string",
  "licenseTextPlacement": "string",
  "selectedColumns": [
    "string"
  ],
  "customAttribute": "string",
  "includeSummary": true,
  "includeVersion": true,
  "hideEmptyFields": true,
  "groupByOrDefault": "string",
  "licenseReferenceOrDefault": "string",
  "licenseTextPlacementOrDefault": "string",
  "selectedColumnsOrDefaultString": "string"
}

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example:"1171c60d"
responseobject(ReportExportProcessDTO)
Response
{
  "supportToken": "1171c60d",
  "response": {
    "uuid": "string",
    "name": "string",
    "scopeUuid": "string",
    "scopeName": "string",
    "subScopes": [ … ],
    "title": "string",
    "reportType": "attribution",
    "format": "json",
    "scopeType": "organization",
    "scopeUuidList": [ … ],
    "projectUuids": [ … ],
    "status": "PENDING",
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "sendEmailNotification": true,
    "labelsUuidList": [ … ],
    "includeVulnerabilities": true,
    "excludeInactiveProjects": true
  }
}