Other API Updates

The following API updates were also added in this release.

Additional API Updates in this Release

Resource

API Endpoint

Method

Description

Inventory

/inventories

POST

Includes new provenanceInventoryId property to define. This property indicates the project from which the inventory item originated.

/inventories/{inventoryId}

GET

Now shows list of alerts for the inventory and retrieves these new properties:

• parentInventoryID to show the parent, if any, of the inventory item
• provenanceInventoryId to show the project from which the inventory item originated

/inventories/{inventoryId}

PUT

Includes new provenanceInventoryId property to update. This property indicates the project from which the inventory item originated.

Projects

/project/inventory/{projectId}

GET

Includes new properties:

• parentInventoryID to show the parent, if any, of the inventory item
• provenanceInventoryId to show the project from which the inventory item originated
• New alerts query filter to retrieve only inventory with open, closed, or any alerts.

/project/exportProjectData

GET

Outputs data containing new provenanceInventoryId to show the project from which the inventory item originated.

project/uploadProjectCodebase

POST

Includes new properties to configure the codebase upload:

• deleteArchiveAfterExpand removes archives whose contents have been expanded during an upload. (The archive is removed from the uploaded codebase after the upload is finished.)
• archiveDirSuffix defines a suffix to add to the name of any folder automatically created during the upload to store an archive’s contents. Once the codebase is scanned, the suffix helps you to easily identify those folders in the codebase tree whose contents are from an archive.

/projects/{projectId}/allscannedfiles

GET

Provides new query property, includeMD5Hash property, enabling the retrieval of the MD5 for retrieved files.