Inventory all tiers

Starts an inventory scan of cartridge bar codes on all cartridges in all tiers of the library or a specified frame. Use this option when a full library inventory is required. This option is concurrent and can take many hours depending on the number of cartridges in the library.

An inventory operation includes a check to determine whether each cartridge storage slot in the library is empty or full and a scan of the bar code labels. You can run an inventory on a single library frame or on an entire library.

The library occasionally runs automatic inventories. However, if an automatic inventory of the media was inconsistent, you might need to run a manual inventory by using this task to reconcile an inconsistency. Similarly, you might need to start a manual inventory if the host application software indicates that there is a problem with the library inventory.

Request syntax

POST /v1/tasks [{"type": "inventoryAllTiers", "location": <"library" | "frame_F<f>">}]
Runs an inventory scan on all tiers of the library or the specified frame. This starts a long-running task in the library that is visible from the GUI.

Request body parameters

type (string, required)

The task type to run. In this case, inventoryAllTiers.

location (string, required)

The location of a specific frame to inventory or library for all frames.


> POST /v1/tasks {"type": "inventoryAllTiers", "location": "frame_F1"}
HTTP/1.1 201 Created
Location: /v1/tasks/42
Content-Type: application/json
Content-Length: 10

{"ID": 43}