Updates to Existing APIs

The following section describes updates that have occurred to existing APIs in this release.

Updates to Existing APIs

Resource

API Name/Endpoint

Method

Function Change Description

Component

Component search

/components/search

GET

The new purl property, showing the package URL, is now listed for each inventory item in the response. If no package URL is available for the inventory item, the value is N/A. See Package URL Property Now Listed for Inventory.

Get component version details

/components/versions/{id}

Get component

/components/{componentId}

Inventory

Get the inventories of file/folder Ids

/inventories/search

GET

The new purl property, showing the package URL, is now listed for each inventory item in the response. If no package URL is available for the inventory item, the value is N/A. See Package URL Property Now Listed for Inventory.

Get details of an inventory

/inventories/{inventoryId}

Create Inventory

POST

An automatic review by policy is triggered on the item once the item is created. See Automatic Review by Policy When Saving New Inventory on the Project Inventory Tab.

Update inventory

PUT

This API has been enhanced as follows:

• If inventory item’s component, license, or any usage properties were edited, an automatic review by policy is triggered on the item once the update is complete. See Automatic Review by Policy After Editing Published Inventory.
• Users are now able to update the priority property for a given inventory item. Possible values are P1 (highest), P2, P3, or P4 (lowest).

If the priority value is not updated, existing logic for automatically setting the priority is used. For example, a Work in Progress inventory item is, by default, set to P3. If the inventory item is updated to a component with critical or high confidenceLevel, the priority of the inventory item is automatically set to P1 in the user interface.

Jobs

Get jobs details based on filters

/jobs

GET

Two new job types—Apply Policy - Project and Apply Policy - Global—have been added as available filters for setting up the request.

The response includes either Apply Policy - Project or Apply Policy - Global for the jobType property if response was filtered on this value.

For details, see Forced Automatic Review by Policy Across All Published Inventory in a Project and Forced Automatic Review by Policy Across Published Inventory in All Projects.

Get job details based on the jobId provided

/jobs/{jobId}

The response can now include one of the new job types—Apply Policy - Project or Apply Policy - Global—for the jobType property when applicable.

License

License lookup

/licenses/lookup

GET

Responses now include a new custom property indicating whether the license was manually created (true) or not (false).

License lookup based on short name

/licenses/{shortName}

Project API

Get Project Inventory

/project/inventory/{projectID}

GET

The new purl property, showing the package URL, is now listed for each inventory item in the response. If no package URL is available for the inventory item, the value is N/A. See Package URL Property Now Listed for Inventory.

Get Inventory Summary of the project

/projects/{projectID}/inventorySummary