SpdxAPI.md

\SpdxAPI

All URIs are relative to http://localhost

Method	HTTP request	Description
GetByScanId	Get /api/v2/spdx/{applicationId}/reports/{scanId}
GetLatestForStage	Get /api/v2/spdx/{applicationId}/stages/{stageId}

GetByScanId

GetByScanId(ctx, applicationId, scanId).Format(format).GenerateCycloneDx(generateCycloneDx).SpdxVersion(spdxVersion).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonatypeiq "github.com/sonatype-nexus-community/nexus-iq-api-client-go"
)

func main() {
	applicationId := "applicationId_example" // string | 
	scanId := "scanId_example" // string | 
	format := "format_example" // string |  (optional) (default to "json")
	generateCycloneDx := true // bool |  (optional) (default to false)
	spdxVersion := "spdxVersion_example" // string |  (optional) (default to "2.3")

	configuration := sonatypeiq.NewConfiguration()
	apiClient := sonatypeiq.NewAPIClient(configuration)
	r, err := apiClient.SpdxAPI.GetByScanId(context.Background(), applicationId, scanId).Format(format).GenerateCycloneDx(generateCycloneDx).SpdxVersion(spdxVersion).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SpdxAPI.GetByScanId``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	string
scanId	string

Other Parameters

Other parameters are passed through a pointer to a apiGetByScanIdRequest struct via the builder pattern

Name	Type	Description	Notes

format | string | | [default to "json"] generateCycloneDx | bool | | [default to false] spdxVersion | string | | [default to "2.3"]

Return type

(empty response body)

Authorization

BasicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/octet-stream, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLatestForStage

GetLatestForStage(ctx, applicationId, stageId).Format(format).GenerateCycloneDx(generateCycloneDx).SpdxVersion(spdxVersion).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonatypeiq "github.com/sonatype-nexus-community/nexus-iq-api-client-go"
)

func main() {
	applicationId := "applicationId_example" // string | 
	stageId := "stageId_example" // string | 
	format := "format_example" // string |  (optional) (default to "json")
	generateCycloneDx := true // bool |  (optional) (default to false)
	spdxVersion := "spdxVersion_example" // string |  (optional) (default to "2.3")

	configuration := sonatypeiq.NewConfiguration()
	apiClient := sonatypeiq.NewAPIClient(configuration)
	r, err := apiClient.SpdxAPI.GetLatestForStage(context.Background(), applicationId, stageId).Format(format).GenerateCycloneDx(generateCycloneDx).SpdxVersion(spdxVersion).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SpdxAPI.GetLatestForStage``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	string
stageId	string

Other Parameters

Other parameters are passed through a pointer to a apiGetLatestForStageRequest struct via the builder pattern

Name	Type	Description	Notes

format | string | | [default to "json"] generateCycloneDx | bool | | [default to false] spdxVersion | string | | [default to "2.3"]

Return type

(empty response body)

Authorization

BasicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/octet-stream, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]