Page Comparison

requestType

API request type that creates a product.

string

Yes

userKey

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

string

Yes

productName

Name to be assigned to the product.

string

Yes

orgToken

API key which is the unique identifier of the organization.

string

Yes

requestType

API request type that deletes a product.

string

Yes

userKey

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

string

Yes

productToken

Product token which uniquely identifies the product.

string

Yes

orgToken

API key which is the unique identifier of the organization.

string

Yes

requestType

API request type that returns all the keys and values of a product’s tags.

string

Yes

userKey

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

string

Yes

productToken

Unique identifier of the product.

string

Yes

requestType

API request type that returns all the product tags in an organization.
NOTE: Products without tags are also returned.

string

Yes

userKey

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

string

Yes

orgToken

API key which is a unique identifier of the organization.

string

Yes

requestType

API request type that saves a product’s tag.

string

Yes

userKey

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

string

Yes

productToken

Unique identifier of the product.

string

Yes

tagKey

Label that describes the tag.

string

Yes

tagValue

Value assigned to the tag.

string

Yes

requestType

API request type that removes a product’s tag.

string

Yes

userKey

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

string

Yes

productToken

Unique identifier of the product.

string

Yes

tagKey

Label that describes the tag.

string

Yes

tagValue

Value assigned to the tag.

string

Yes

requestType

API request type that creates a project.

string

Yes

userKey

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

string

Yes

productToken

Name of the product within which to create the project.

string

Yes

projectName

Name to be assigned to the project.

string

Yes

projectDescription

A description of the new project (optional field).

string

No

requestType

API request type that deletes a project.

string

Yes

userKey

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

string

Yes

productToken

Product token which identifies the product in which the project resides.

string

Yes

projectToken

Project token of the project to be deleted.

string

Yes

requestType

API request type that returns all the project tags in an organization.
NOTE: Products without tags are also returned.

string

Yes

userKey

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

string

Yes

orgToken

API key which is a unique identifier of the organization.

string

Yes

requestType

API request type that returns all the project tags in a product.
NOTE: Products without tags are also returned.

string

Yes

userKey

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

string

Yes

productToken

Unique identifier of the product.

string

Yes

requestType

API request type that returns all the keys and values of a project’s tags.
NOTE: Projects without tags are also returned.

string

Yes

userKey

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

string

Yes

projectToken

Unique identifier of the project.

string

Yes

requestType

API request type that saves a project’s tag.

string

Yes

userKey

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

string

Yes

projectToken

Unique identifier of the project.

string

Yes

tagKey

Label that describes the tag.

string

Yes

tagValue

Value assigned to the tag.

string

Yes

requestType

API request type that removes a project’s tag.

string

Yes

userKey

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

string

Yes

projectToken

Unique identifier of the project.

string

Yes

tagKey

Label that describes the tag.

string

Yes

tagValue

Value assigned to the tag.

string

Yes

requestType

API request type that gets a hierarchy of the libraries in a project.

string

Yes

userKey

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

string

Yes

projectToken

Unique identifier of the project.

string

Yes

includeInHouseData

Set to “true” (default value) when you want in-house library data to be included in the API response. When set to ‘false’, in-house library data is not returned in the API response.

boolean

No

requestType

API request type that gets an inventory of the libraries in a project.

string

Yes

userKey

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

string

Yes

projectToken

Unique identifier of the project.

string

Yes

includeInHouseData

Set to “true” (default value) when you want in-house library data to be included in the API response. When set to ‘false’, in-house library data is not returned in the API response.

boolean

No

includeOutdatedLibraryData

Returns outdated information. “New Version” alert type must be enabled in order to see the outdated and outdatedModel data

boolean

No, Default is false

requestType

API request type that gets the current state of a project.

string

Yes

userKey

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

string

Yes

projectToken

Unique identifier of the project.

string

Yes

requestType

API request type that gets a library’s source files.

string

Yes

userKey

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

string

Yes

projectToken

Unique identifier of the project.

integer

Yes

keyUuid

Unique ID of the library containing the source files.

integer

Yes

requestType

API request type that gets a library’s dependencies.

string

Yes

userKey

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

string

Yes

projectToken

Unique identifier of the project.

integer

Yes

keyUuid

Unique ID of the library containing the dependencies.

integer

Yes

requestType

API request type that defines the project setup notification configuration.

string

Yes

userKey

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

string

Yes

orgToken

API key which is a unique identifier of the organization.

string

Yes

action

The action that describes the type of notification: Custom, Enabled, or Disabled.

string

Yes

projectTagKeyRegex

The project tag key pattern that describes the notification rule. Must be a formatted regex valid string.

Notifications will be sent when the projectTagKeyRegex and projectTagValueRegex patterns are in accordance with the defined project tags.

string

Required only if the action is Custom.

projectTagValueRegex

The project tag value pattern that describes the notification rule. Must be a formatted regex valid string.

Notifications will be sent when the projectTagKeyRegex and projectTagValueRegex patterns are in accordance with the defined project tags.

string

Mandatory only if the action is Custom.

requestType

API request type that returns the current progress of a request.

string

Yes

userKey

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

string

Yes

orgToken

API key which is a unique identifier of the organization.

string

Yes

requestToken

Token that identifies the plugin request. Also called "support_token" - can be found in the data of the response returned from the server.

string

Yes