Get BOM Report

GET 
/code/api/v1/bom/getBOMReport/:repoId

Get a BOM Report

Request

Path Parameters

repoId stringrequired

Query Parameters

format stringrequired

Possible values: [csv, cyclonedx]

material stringrequired

Possible values: [oss, iac, images, all]

Responses

200

Get BOM Report

application/json

Schema

Schema

bomResponse object[]required
Array [
format BOMReportFormat (string)required
Possible values: [csv, cyclonedx]
reportLink stringrequired
]

Example (from schema)

{
  "bomResponse": [
    {
      "format": "csv",
      "reportLink": "string"
    }
  ]
}

Example 1

{
  "bomResponse": [
    {
      "format": "csv",
      "reportLink": "Presigned BOM Report Link"
    }
  ]
}

401

Unauthorized to get the BOM report

422

Request arguments validation error

500

Failed to get BOM Report

Loading...