Move cartridge to drive

Edit online

Creates a work item to move a cartridge to a specified drive.

Request syntax

POST /v1/workItems [{"type": "moveToDrive", "cartridge": <volser>,"sourceInternalAddress": <internalAddress>, "destinationLocation": <location>, "destinationSN": < serialNumber >}]
Moves a cartridge to the specified drive.

Request body parameters

type (string, required)
The type of work item that is being created. In this case, moveTodrive .
cartridge (string, optional)
The VOLSER of the cartridge to be moved. If duplicate VOLSERs exist for this cartridge in the library, the sourceInternalAddress must be used. If sourceInternalAddress is specified, this is not required.
sourceInternalAddress (string, optional)
The internal address of the cartridge that is to be moved. This changes if a cartridge is assigned or unassigned from a logical library or if the cartridge is moved by the host or library. Query this value before use. If cartridge is specified, this is not required.
destinationLocation (string, optional)
The location of the destination tape drive. If destinationSN is specified, this is not required.
destinationSN (string, optional)
The serial number of the destination tape drive. If destinationLocation is specified, this is not required.

Example 



> POST /v1/workItems {"type": "moveToDrive", "cartridge": "AAA000L8", "destinationLocation": "drive_F1R2C3"}

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 10
				
{"ID": 0}

Response attribute description

ID (number)

The unique identifier of the work item created. This is always 0. To monitor cartridge movement, poll the cartridge that is being moved and wait for the location attribute to change.