# Inventory API

## Add Files and/or Folders to Inventory

 - [PUT /inventories/{inventoryId}/files](https://codeinsightapi.redocly.app/swagger/inventory-api/addfilestoinventory.md): Add files and/or folders to inventory item and returns the response message

## Create Inventory

 - [POST /inventories](https://codeinsightapi.redocly.app/swagger/inventory-api/createinventory.md): Create an inventory. Name and Inventory type is a mandatory field.

Note: Value for rememberLicense can be GLOBAL or INVENTORY (default).
- GLOBAL: Saves and applies the component version and license mapping to the current inventory and all future inventories across projects.
- INVENTORY: Updates only the current inventory. Future inventories will use the original license mapping.

## Get details of an inventory

 - [GET /inventories/{inventoryId}](https://codeinsightapi.redocly.app/swagger/inventory-api/getinventorybyid.md): Get details of an inventory.

## Update Inventory

 - [PUT /inventories/{inventoryId}](https://codeinsightapi.redocly.app/swagger/inventory-api/updateinventory.md): Update an inventory for a given inventoryId.

Note: Value for rememberLicense can be GLOBAL or INVENTORY (default).
- GLOBAL: Saves and applies the component version and license mapping to the current inventory and all future inventories across projects.
- INVENTORY: Updates only the current inventory. Future inventories will use the original license mapping.

## Delete the inventory

 - [DELETE /inventories/{inventoryId}](https://codeinsightapi.redocly.app/swagger/inventory-api/deleteinventory.md): delete inventory

## Get history of an inventory

 - [GET /inventories/{inventoryId}/history](https://codeinsightapi.redocly.app/swagger/inventory-api/fetchhistory.md): Fetches the history for a given inventoryId, changes are grouped based on the revision id.

## Get children of an inventory

 - [GET /inventories/{inventoryId}/children](https://codeinsightapi.redocly.app/swagger/inventory-api/fetchinventorychildren.md): Fetches the children for a given inventoryId.

## Get parents of an inventory

 - [GET /inventories/{inventoryId}/parents](https://codeinsightapi.redocly.app/swagger/inventory-api/fetchinventoryparents.md): Fetches the parents for a given inventoryId.

## Get All Inventories by Date

 - [GET /inventories/searchByDate](https://codeinsightapi.redocly.app/swagger/inventory-api/getallprojectinventoriesbydate.md): Returns a list of inventories and relevant details within the given date and time. All users can view project inventories of public projects and users with permission can view the inventories of private project

## Get the inventories of file/folder ids

 - [GET /inventories/search](https://codeinsightapi.redocly.app/swagger/inventory-api/getinventory.md): Returns the inventories file and/or folder ids

## Get vulnerability analysis details of an inventory

 - [GET /inventories/{inventoryId}/vulnerabilities/analysis](https://codeinsightapi.redocly.app/swagger/inventory-api/getvulnerabilityanalysis.md): Get vulnerability analysis details of an inventory.

## Get vulnerability details of an inventory

 - [GET /inventories/{inventoryId}/vulnerabilities](https://codeinsightapi.redocly.app/swagger/inventory-api/getvulnerabilties_1.md): Get vulnerability details of an inventory.

## Update notices text

 - [PUT /inventories/{inventoryId}/notices](https://codeinsightapi.redocly.app/swagger/inventory-api/noticestextinventory.md): Update notices text for the given inventory

## Publish Inventory

 - [PUT /inventories/{inventoryId}/publish](https://codeinsightapi.redocly.app/swagger/inventory-api/publishinventory.md): Publish an inventory for a given inventoryId

## Recall Inventory

 - [PUT /inventories/{inventoryId}/recall](https://codeinsightapi.redocly.app/swagger/inventory-api/recallinventory.md): Recall an inventory for a given inventoryId

## inventory status

 - [PUT /inventories/{inventoryId}/status](https://codeinsightapi.redocly.app/swagger/inventory-api/updateinventorystatus.md): update an inventory status with DRAFT, APPROVED and REJECTED status.The approve/reject inventory affects Manual Review task only. Any changes made to Inventory will not affect Remediation and Miscellaneous tasks. On Approving Inventory, Inventory gets Approved and Manual review task will be closed with Approve status. On Rejecting Inventory, Inventory gets Rejected by creating an open Remediation task and the Manual review task will be closed with Reject status.