Page Comparison

requestType

API request type that returns an organization’s licenses per library.

string

Yes

orgToken

API key which is a unique identifier of the organization. Used to identify the organization in plugins.

string

Yes

userKey

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

string

Yes

excludeProjectOccurrences

“true” or “false” depending on whether or not you want to exclude project occurrences of the licenses.

boolean

No

requestType

API request type that returns a product's licenses per library.

string

Yes

productToken

Unique identifier of the product.

string

Yes

userKey

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

string

Yes

excludeProjectOccurrences

“true” or “false” depending on whether or not you want to exclude project occurrences of the licenses.

boolean

No

requestType

API request type that returns a project's licenses per library.

string

Yes

projectToken

Unique identifier of the project.

string

Yes

userKey

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

string

Yes

requestType

API request type that returns a histogram of an organization’s licenses.

string

Yes

orgToken

API key which is a unique identifier of the organization. Used to identify the organization in plugins.

string

Yes

userKey

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

string

Yes

requestType

API request type that returns a history of a product’s licenses.

string

Yes

productToken

Unique identifier of the product.

string

Yes

userKey

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

string

Yes

requestType

API request type that returns a project’s licenses histogram.

string

Yes

projectToken

Unique identifier of the project.

string

Yes

userKey

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

string

Yes

requestType

API request type that gets a License text zip file for a product.

string

Yes

productToken

Unique identifier of the product.

string

Yes

userKey

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

string

Yes

requestType

API request type that gets a License text zip file for a project.

string

Yes

projectToken

Unique identifier of the project.

string

Yes

userKey

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

string

Yes

requestType

API request type that gets a Copyrights text file for a product.

string

Yes

productToken

Unique identifier of the product.

string

Yes

userKey

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

string

Yes

requestType

API request type that gets a Copyrights text file for a project.

string

Yes

projectToken

Unique identifier of the project.

string

Yes

userKey

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

string

Yes

requestType

API request type that gets a Notices text file for a product.

string

Yes

productToken

Unique identifier of the product.

string

Yes

userKey

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

string

Yes

requestType

API request type that sets a library notice.

string

Yes

orgToken

API key which is a unique identifier of the organization. Used to identify the organization in plugins.

string

Yes

userKey

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

string

Yes

libraryUUID

Unique ID of the library in which you want to set the notice.

string

Yes

text

Text of the library’s notice that you want to set.

string

Yes

reference

Optionally, add library reference information to the notice.

string

No

requestType

API request type that gets the library locations for a product.

string

Yes

productToken

Unique identifier of the product.

string

Yes

userKey

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

string

Yes

requestType

API request type that gets the library locations for a project.

string

Yes

projectToken

Unique identifier of the project.

string

Yes

userKey

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

string

Yes

requestType

API request type that changes the original library of your source files.

string

Yes

orgToken

API key which is a unique identifier of the organization. Used to identify the organization in plugins.

string

Yes

userKey

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

string

Yes

targetKeyUuid

Unique ID of the library to which you want to change the source files.

string

Yes

sourceFiles

An array of the source files to be moved.

array

Yes

userComments

Optionally, add a comment to this action.

string

No