Page Comparison

requestType

API request type that returns an Inventory report for a specific product.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

productToken

API key which is a unique Unique identifier of the product.

string

Yes

format

Requested format of the report. Options are: xlsx (default), xml, or json.

string

Yes

requestType

API request type that returns an Inventory report for a specific project.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

projectToken

API key which is a unique Unique identifier of the project.

string

Yes

format

Requested format of the report. Options are: xlsx (default), xml, or json.

string

Yes

requestType

API request type that returns a Source File Inventory report for a product.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

productToken

API key which is a unique Unique identifier of the product.

string

Yes

format

Requested format of the report. Options are: xlsx (default) or json.

string

Yes

requestType

API request type that returns a Source File Inventory report for a project.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

projectToken

API key which is a unique Unique identifier of the project.

string

Yes

format

Requested format of the report. Options are: xlsx (default) or json.

string

Yes

requestType

API request type that returns a Due Diligence report for a specific product.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

productToken

API key which is a unique Unique identifier of the product.

string

Yes

format

Requested format of the report. Options are: xlsx (default), xml, or json.

string

Yes

requestType

API request type that returns a Due Diligence report for a specific project.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

projectToken

API key which is a unique Unique identifier of the project.

string

Yes

format

Requested format of the report. Options are: xlsx (default), xml, or json.

string

Yes

requestType

API request type that returns an Attribution report with for a specific product.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

productToken

API key which is a unique Unique identifier of the product.

string

Yes

reportHeader

Report header - default value is Attribution Report.

string

No

reportTitle

Text that you want to appear in the report title.

string

No

reportFooter

Text that you want to appear in the footer of the report.

string

No

reportingScope

Scope of the information to be included in the report. By default, the following:

• Summary

• Licenses

• Copyrights

• Notices

• Primary attributes

string

No

reportingAggregationMode

How to group the information in the report - according to the library (i.e. BY_COMPONENT) or by project (BY_PROJECT).

string

Yes

missingLicenseDisplayOption

What to write if the license is missing. Options are: “BLANK” (default) or “GENERIC_LICENSE”.

string

No

exportFormat

Format of exported report: TXT, HTML, or JSON. Case insensitive.

string

No

licenseReferenceTextPlacement

LICENSE_SECTION (default) or APPENDIX_SECTION.

string

No

customAttribute

Name of custom attribute for the product.

string

No

includeVersions

“true” (default) or “false”. If set to “false”, the report will not include the “version” field.

boolean

No

requestType

API request type that returns an Attribution report with for a specific project.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

projectToken

API key which is a unique Unique identifier of the project.

string

Yes

reportHeader

Report header - default value is Attribution Report.

string

No

reportTitle

Text that you want to appear in the report title.

string

No

reportFooter

Text that you want to appear in the footer of the report.

string

No

reportingScope

Scope of the information to be included in the report. By default, the following:

• Summary

• Licenses

• Copyrights

• Notices

• Primary attributes

string

No

reportingAggregationMode

How to group the information in the report - according to the library (i.e. BY_COMPONENT) or by project (BY_PROJECT).

string

Yes

missingLicenseDisplayOption

What to write if the license is missing. Options are: “BLANK” (default) or “GENERIC_LICENSE”.

string

No

exportFormat

Format of exported report: TXT, HTML, or JSON. Case insensitive.

string

No

licenseReferenceTextPlacement

LICENSE_SECTION (default) or APPENDIX_SECTION.

string

No

customAttribute

Name of custom attribute for the project.

string

No

includeVersions

“true” (default) or “false”. If set to “false”, the report will not include the “version” field.

boolean

No

requestType

API request type that returns a product comparison report between two products.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

productToken

API key which is a unique Unique identifier of the first product.

string

Yes

productToken2

API key which is a unique Unique identifier of the second product.

string

Yes

requestType

API request type that returns a project comparison report between two projects.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

projectToken

API key which is a unique Unique identifier of the first project.

string

Yes

projectToken2

API key which is a unique Unique identifier of the second project.

string

Yes

requestType

API request type that returns custom attributes with their values for a specific product.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

productToken

API key which is a unique Unique identifier of the product.

string

Yes

requestType

API request type that returns custom attributes with their values for a specific project.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

projectToken

API key which is a unique Unique identifier of the project.

string

Yes

requestType

API request type that returns library locations for a specific product.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

productToken

API key which is a unique Unique identifier of the product.

string

Yes

requestType

API request type that returns a compatibility report of library licenses in a product.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

productToken

API key which is a unique Unique identifier of the product.

string

Yes

requestType

API request type that returns a compatibility report of library licenses in a project.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

projectToken

API key which is a unique Unique identifier of the project.

string

Yes

requestType

API request type that returns all Effective Licenses for a specific product.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

productToken

API key which is a unique Unique identifier of the product.

string

Yes

requestType

API request type that returns a report about all In-House libraries in a specific product.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

productToken

API key which is a unique Unique identifier of the product.

string

Yes

requestType

API request type that returns a report about all In-House libraries in a specific project.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

projectToken

API key which is a unique Unique identifier of the project.

string

Yes

requestType

API request type that returns a risk report for a specific product.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

productToken

API key which is a unique Unique identifier of the product.

string

Yes

requestType

API request type that returns a risk report for a specific project.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

projectToken

API key which is a unique Unique identifier of the project.

string

Yes

requestType

API request type that returns a Vulnerabilities report for a specific product.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

productToken

API key which is a unique Unique identifier of the product.

string

Yes

format

Requested format of the report. Options are: xlsx (default) or json.

string

Yes

requestType

API request type that returns a Vulnerabilities report for a specific project.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

projectToken

API key which is a unique Unique identifier of the project.

string

Yes

format

Requested format of the report. Options are: xlsx (default) or json.

string

Yes

requestType

API request type that returns a Container Vulnerabilities report at the Cluster level.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

productToken

API key which is a unique Unique identifier of the product.

string

Yes

format

Requested format of the report. Options are: xlsx (default) or json.

string

Yes

requestType

API request type that returns a report for all the alerts in a specific product.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

productToken

API key which is a unique Unique identifier of the product.

string

Yes

format

Requested format of the report. Options are: xlsx (default), xml, or json.

string

Yes

requestType

API request type that returns a report for all the alerts in a specific project.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

projectToken

API key which is a unique Unique identifier of the project.

string

Yes

format

Requested format of the report. Options are: xlsx (default), xml, or json.

string

Yes

requestType

API request type that returns a report for all Ignored Alerts in a specific product.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

productToken

API key which is a unique Unique identifier of the product.

string

Yes

format

Requested format of the report. Options are: xlsx (default) or xml.

string

Yes

requestType

API request type that returns a report for all Ignored Alerts in a specific project.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

projectToken

API key which is a unique Unique identifier of the project.

string

Yes

format

Requested format of the report. Options are: xlsx (default) or xml.

string

Yes

requestType

API request type that returns a report for all Resolved Alerts in a specific product.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

productToken

API key which is a unique Unique identifier of the product.

string

Yes

format

Requested format of the report. Options are: xlsx (default) or xml.

string

Yes

requestType

API request type that returns a report for all Resolved Alerts in a specific project.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

projectToken

API key which is a unique Unique identifier of the project.

string

Yes

format

Requested format of the report. Options are: xlsx (default) or xml.

string

Yes

requestType

API request type that returns a history report of all requests for a specific product.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

productToken

API key which is a unique Unique identifier of the product.

string

Yes

requestType

API request type that returns a history report of all requests for a specific project.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

projectToken

API key which is a unique Unique identifier of the project.

string

Yes

requestType

API request type that returns a report of all members in a product.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

productToken

API key which is a unique Unique identifier of the product.

string

Yes

requestType

API request type that returns a report of all members in a project.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

projectToken

API key which is a unique Unique identifier of the project.

string

Yes

requestType

API request type that returns a report of all security alerts by for a product.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

productToken

API key which is a unique Unique identifier of the product.

string

Yes

status

Yes status of the alerts: Active, Ignored or Resolved. By default, all statuses are returned.

string

Yes

format

Requested format of the report. Options are: xlsx (default), xml, or json.

string

Yes

requestType

API request type that returns a report of all security alerts by for a project.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

projectToken

API key which is a unique Unique identifier of the project.

string

Yes

status

Yes status of the alerts: Active, Ignored or Resolved. By default, all statuses are returned.

string

Yes

format

Requested format of the report. Options are: xlsx (default), xml, or json.

string

Yes

requestType

API request type that returns a report of all security alerts by library for a product.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

productToken

API key which is a unique Unique identifier of the product.

string

Yes

status

Yes status of the alerts: Active or Ignored. By default, all statuses are returned.

A library that is marked as "active" has at least 1 active alert; a library that is marked as "ignored" has at least 1 ignored alert.

string

Yes

format

Requested format of the report. Options are: xlsx (default), xml, or json.

string

Yes

requestType

API request type that returns a report of all security alerts by library for a project.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

projectToken

API key which is a unique Unique identifier of the project.

string

Yes

status

Yes status of the alerts: Active or Ignored. By default, all statuses are returned.

A library that is marked as "active" has at least 1 active alert; a library that is marked as "ignored" has at least 1 ignored alert.

string

Yes

format

Requested format of the report. Options are: xlsx (default), xml, or json.

string

Yes

requestType

API request type that returns a report of licensing and compliance alerts for a specific product.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

productToken

API key which is a unique Unique identifier of the product.

string

Yes

status

Yes status of the alerts: Active, Ignored or Resolved. By default, all statuses are returned.

string

Yes

format

Requested format of the report. Options are: xlsx (default), xml, or json.

string

Yes

requestType

API request type that returns a report of licensing and compliance alerts for a specific project.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

projectToken

API key which is a unique Unique identifier of the project.

string

Yes

status

Yes status of the alerts: Active, Ignored or Resolved. By default, all statuses are returned.

string

Yes

format

Requested format of the report. Options are: xlsx (default), xml, or json.

string

Yes