Skip to content
Platform API 3.0
/
/
Export Unified Findings r...

Export Unified Findings report for a project asynchronously (Platform)

Request

Security
bearer-key
Path
projectUuidstringrequired

UUID of the project

Bodyapplication/jsonrequired
namestring
formatstring
Enum:"json""html""unknown""xml""excel""yaml""pdf""tv""rdf""csv"
sendEmailNotificationboolean
labelsUuidListArray of strings

List of label UUIDs used to scope the report. Pass an empty array ([]) to apply no label filtering (the report then covers the full scope). Note: the placeholder value "string" shown in the example schema is not a valid UUID — passing it (or any non-existent label UUID) matches no labels and produces an empty report.

Example:
[]
excludeInactiveProjectsboolean
projectUuidsArray of strings
engineArray of strings

Engines to include. Omit or pass an empty array to include every engine.

Example:
[
  "SCA",
  "SAST"
]
findingCategoryArray of strings

Finding categories to include. Omit or pass an empty array to include every category.

Example:
[
  "Security"
]
POST
/api/v3.0/projects/{projectUuid}/reports/unified-findings
{
  "name": "string",
  "format": "json",
  "sendEmailNotification": true,
  "labelsUuidList": [],
  "excludeInactiveProjects": true,
  "projectUuids": [
    "string"
  ],
  "engine": [
    "SCA",
    "SAST"
  ],
  "findingCategory": [
    "Security"
  ]
}

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
  }
}