Skip to content
Platform API 3.0
/
/
Export account inventory...

Export account inventory report asynchronously (Dependencies - SCA)

Request

Security
bearer-key
Path
accountUuidstringrequired

Account UUID

Bodyapplication/jsonrequired
namestring
sendEmailNotificationboolean
formatstring
Value:"excel"
searchstring(Search Query)

Filter your search to return items whose property has a specific value. Use the syntax: [property][operator][value]

  • Property: the name of the property of the item
  • Operator:
    • equals (==) - Returns true if the value exactly matches this one. If the value contains a * character, it behaves like a wildcard (similar to the LIKE operator). Example: entity==abc* — will return true for entities like "abcd" and "abc_123".
  • Value: the value of the property.

Logical operators AND (;) and OR (,) are supported in filters — param1=in=(val1,val2) and (param2==val3 or param3==val4), can also be written as — param1=in=(val1,val2);(param2==val3,param3==val4)

This endpoint supports filtering on the following properties and its supported operators:

  • libraryName: equals
Example:"libraryName==*log4j*"
POST
/api/v3.0/accounts/{accountUuid}/dependencies/reports/inventory
{
  "name": "string",
  "sendEmailNotification": true,
  "format": "excel",
  "search": "libraryName==*log4j*"
}

Responses

OK

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