Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This API request returns the current status of a project including the last process that was performed on the project and its date, and whether the process is currently in progress.

The projectState response can have one of the following values:

  • SETUP: Initializing project

  • DIFF: Calculating inventory changes

  • UPDATE: Updating inventory

  • CHANGE_EXCLUSIONS: Updating dependency exclusions

  • CHANGE_LOCAL_PATHS: Updating library paths

  • REMOVE: Removing libraries

  • PARTNER_UPDATE: Updating inventory

  • UPDATE_ALERTS: Updating alerts

  • CREATE_ISSUES: Creating external tickets

QUERY PARAMETERS

Parameter

Description

Type

Required

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 WhiteSource.

string

Yes

projectToken

Project token which identifies the project.

string

Yes

...