Skip to content

LicenseLegalMetadataReportAPI.md

Latest commit

 

History

History
660 lines (410 loc) · 21 KB

LicenseLegalMetadataReportAPI.md

File metadata and controls

660 lines (410 loc) · 21 KB

\LicenseLegalMetadataReportAPI

All URIs are relative to http://localhost

Method HTTP request Description
GetLicenseLegalApplicationHTMLReport Get /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report
GetLicenseLegalApplicationReport Get /api/v2/licenseLegalMetadata/application/{applicationId}
GetLicenseLegalApplicationReport1 Get /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}
GetLicenseLegalComponentReport Get /api/v2/licenseLegalMetadata/{ownerType}/{ownerId}/component
GetLicenseLegalCustomApplicationHTMLReport Post /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report
GetLicenseLegalCustomApplicationHTMLReport1 Post /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report/templateId/{templateId}
GetLicenseLegalCustomMultiApplicationHTMLReport1 Post /api/v2/licenseLegalMetadata/multiApplication/report/templateId/{templateId}
GetLicenseLegalMultiApplicationHTMLReport Post /api/v2/licenseLegalMetadata/multiApplication/report
GetLicenseLegalMultiApplicationReportFromActiveUserFilter Post /api/v2/licenseLegalMetadata/multiApplication/activeUserFilter/report/templateId/{templateId}

GetLicenseLegalApplicationHTMLReport

string GetLicenseLegalApplicationHTMLReport(ctx, applicationId, stageId).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 | Enter the application id or public id.
	stageId := "stageId_example" // string | Enter the stageId.

	configuration := sonatypeiq.NewConfiguration()
	apiClient := sonatypeiq.NewAPIClient(configuration)
	resp, r, err := apiClient.LicenseLegalMetadataReportAPI.GetLicenseLegalApplicationHTMLReport(context.Background(), applicationId, stageId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `LicenseLegalMetadataReportAPI.GetLicenseLegalApplicationHTMLReport``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetLicenseLegalApplicationHTMLReport`: string
	fmt.Fprintf(os.Stdout, "Response from `LicenseLegalMetadataReportAPI.GetLicenseLegalApplicationHTMLReport`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId string Enter the application id or public id.
stageId string Enter the stageId.

Other Parameters

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

Name Type Description Notes

Return type

string

Authorization

BasicAuth, BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/html

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

GetLicenseLegalApplicationReport

ApiLicenseLegalApplicationReportDTO GetLicenseLegalApplicationReport(ctx, applicationId).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 | Enter the application id or public id.

	configuration := sonatypeiq.NewConfiguration()
	apiClient := sonatypeiq.NewAPIClient(configuration)
	resp, r, err := apiClient.LicenseLegalMetadataReportAPI.GetLicenseLegalApplicationReport(context.Background(), applicationId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `LicenseLegalMetadataReportAPI.GetLicenseLegalApplicationReport``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetLicenseLegalApplicationReport`: ApiLicenseLegalApplicationReportDTO
	fmt.Fprintf(os.Stdout, "Response from `LicenseLegalMetadataReportAPI.GetLicenseLegalApplicationReport`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId string Enter the application id or public id.

Other Parameters

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

Name Type Description Notes

Return type

ApiLicenseLegalApplicationReportDTO

Authorization

BasicAuth, BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetLicenseLegalApplicationReport1

ApiLicenseLegalApplicationReportDTO GetLicenseLegalApplicationReport1(ctx, applicationId, stageId).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 | Enter the application id or public id.
	stageId := "stageId_example" // string | Enter the stageId.

	configuration := sonatypeiq.NewConfiguration()
	apiClient := sonatypeiq.NewAPIClient(configuration)
	resp, r, err := apiClient.LicenseLegalMetadataReportAPI.GetLicenseLegalApplicationReport1(context.Background(), applicationId, stageId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `LicenseLegalMetadataReportAPI.GetLicenseLegalApplicationReport1``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetLicenseLegalApplicationReport1`: ApiLicenseLegalApplicationReportDTO
	fmt.Fprintf(os.Stdout, "Response from `LicenseLegalMetadataReportAPI.GetLicenseLegalApplicationReport1`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId string Enter the application id or public id.
stageId string Enter the stageId.

Other Parameters

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

Name Type Description Notes

Return type

ApiLicenseLegalApplicationReportDTO

Authorization

BasicAuth, BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetLicenseLegalComponentReport

ApiLicenseLegalComponentReportDTO GetLicenseLegalComponentReport(ctx, ownerType, ownerId).ComponentIdentifier(componentIdentifier).PackageUrl(packageUrl).Hash(hash).IdentificationSource(identificationSource).ScanId(scanId).Execute()

Example

package main

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

func main() {
	ownerType := "ownerType_example" // string | Enter the ownerType
	ownerId := "ownerId_example" // string | Enter the ownerId corresponding to the ownerType.
	componentIdentifier := *sonatypeiq.NewComponentIdentifier() // ComponentIdentifier | Enter the componentIdentifier consisting of format and coordinates. (optional)
	packageUrl := "packageUrl_example" // string | Enter the package URL. (optional)
	hash := "hash_example" // string | Enter the component hash. (optional)
	identificationSource := "identificationSource_example" // string | Enter the identification source if a third party scan is used. (optional)
	scanId := "scanId_example" // string | Enter the scanId for the report where the component was identified (required if identified by third party scan). (optional)

	configuration := sonatypeiq.NewConfiguration()
	apiClient := sonatypeiq.NewAPIClient(configuration)
	resp, r, err := apiClient.LicenseLegalMetadataReportAPI.GetLicenseLegalComponentReport(context.Background(), ownerType, ownerId).ComponentIdentifier(componentIdentifier).PackageUrl(packageUrl).Hash(hash).IdentificationSource(identificationSource).ScanId(scanId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `LicenseLegalMetadataReportAPI.GetLicenseLegalComponentReport``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetLicenseLegalComponentReport`: ApiLicenseLegalComponentReportDTO
	fmt.Fprintf(os.Stdout, "Response from `LicenseLegalMetadataReportAPI.GetLicenseLegalComponentReport`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
ownerType string Enter the ownerType
ownerId string Enter the ownerId corresponding to the ownerType.

Other Parameters

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

Name Type Description Notes

componentIdentifier | ComponentIdentifier | Enter the componentIdentifier consisting of format and coordinates. | packageUrl | string | Enter the package URL. | hash | string | Enter the component hash. | identificationSource | string | Enter the identification source if a third party scan is used. | scanId | string | Enter the scanId for the report where the component was identified (required if identified by third party scan). |

Return type

ApiLicenseLegalComponentReportDTO

Authorization

BasicAuth, BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetLicenseLegalCustomApplicationHTMLReport

string GetLicenseLegalCustomApplicationHTMLReport(ctx, applicationId, stageId).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 | Enter the application id or public id.
	stageId := "stageId_example" // string | Enter the stageId.

	configuration := sonatypeiq.NewConfiguration()
	apiClient := sonatypeiq.NewAPIClient(configuration)
	resp, r, err := apiClient.LicenseLegalMetadataReportAPI.GetLicenseLegalCustomApplicationHTMLReport(context.Background(), applicationId, stageId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `LicenseLegalMetadataReportAPI.GetLicenseLegalCustomApplicationHTMLReport``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetLicenseLegalCustomApplicationHTMLReport`: string
	fmt.Fprintf(os.Stdout, "Response from `LicenseLegalMetadataReportAPI.GetLicenseLegalCustomApplicationHTMLReport`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId string Enter the application id or public id.
stageId string Enter the stageId.

Other Parameters

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

Name Type Description Notes

Return type

string

Authorization

BasicAuth, BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/html

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

GetLicenseLegalCustomApplicationHTMLReport1

GetLicenseLegalCustomApplicationHTMLReport1(ctx, applicationId, stageId, templateId).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 | Enter the application id or public id.
	stageId := "stageId_example" // string | Enter the stageId.
	templateId := "templateId_example" // string | Enter the templateId for the HTML report format.

	configuration := sonatypeiq.NewConfiguration()
	apiClient := sonatypeiq.NewAPIClient(configuration)
	r, err := apiClient.LicenseLegalMetadataReportAPI.GetLicenseLegalCustomApplicationHTMLReport1(context.Background(), applicationId, stageId, templateId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `LicenseLegalMetadataReportAPI.GetLicenseLegalCustomApplicationHTMLReport1``: %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 Enter the application id or public id.
stageId string Enter the stageId.
templateId string Enter the templateId for the HTML report format.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

BasicAuth, BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

GetLicenseLegalCustomMultiApplicationHTMLReport1

GetLicenseLegalCustomMultiApplicationHTMLReport1(ctx, templateId).Execute()

Example

package main

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

func main() {
	templateId := "templateId_example" // string | Enter the `templateId` for the HTML report.

	configuration := sonatypeiq.NewConfiguration()
	apiClient := sonatypeiq.NewAPIClient(configuration)
	r, err := apiClient.LicenseLegalMetadataReportAPI.GetLicenseLegalCustomMultiApplicationHTMLReport1(context.Background(), templateId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `LicenseLegalMetadataReportAPI.GetLicenseLegalCustomMultiApplicationHTMLReport1``: %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.
templateId string Enter the `templateId` for the HTML report.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

BasicAuth, BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

GetLicenseLegalMultiApplicationHTMLReport

GetLicenseLegalMultiApplicationHTMLReport(ctx).Execute()

Example

package main

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

func main() {

	configuration := sonatypeiq.NewConfiguration()
	apiClient := sonatypeiq.NewAPIClient(configuration)
	r, err := apiClient.LicenseLegalMetadataReportAPI.GetLicenseLegalMultiApplicationHTMLReport(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `LicenseLegalMetadataReportAPI.GetLicenseLegalMultiApplicationHTMLReport``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

(empty response body)

Authorization

BasicAuth, BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

GetLicenseLegalMultiApplicationReportFromActiveUserFilter

string GetLicenseLegalMultiApplicationReportFromActiveUserFilter(ctx, templateId).Execute()

Example

package main

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

func main() {
	templateId := "templateId_example" // string | Enter the templateId for the license legal data.

	configuration := sonatypeiq.NewConfiguration()
	apiClient := sonatypeiq.NewAPIClient(configuration)
	resp, r, err := apiClient.LicenseLegalMetadataReportAPI.GetLicenseLegalMultiApplicationReportFromActiveUserFilter(context.Background(), templateId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `LicenseLegalMetadataReportAPI.GetLicenseLegalMultiApplicationReportFromActiveUserFilter``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetLicenseLegalMultiApplicationReportFromActiveUserFilter`: string
	fmt.Fprintf(os.Stdout, "Response from `LicenseLegalMetadataReportAPI.GetLicenseLegalMultiApplicationReportFromActiveUserFilter`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId string Enter the templateId for the license legal data.

Other Parameters

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

Name Type Description Notes

Return type

string

Authorization

BasicAuth, BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/html

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