Get robotic accessors

Request syntax

Path parameters

Example

> GET /v1/accessors/accessor_Aa
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 439
[
     {
          "location": "accessor_Aa", 
          "state": "onlineActive",
          "stateReferenceEvent": null,
          "driveAccess":"normal",
          "cartridgeAccess":"normal",
          "pivots": 151321, 
          "barCodeScans": 92742,
          "velocityScalingXY": 100,  
          "velocityScalingPivot": 100,
          "travelX": 38056, 
          "travelY": 65039, 
          "getsGripper1": 63614, 
          "putsGripper1": 63595, 
          "getsGripper2": 63338, 
          "putsGripper2": 63310,
          "temperature": 32.1,
          "humidity": 28.9
     }, {
          ...
      }
]

Attributes

location (string)

The unique location of the accessor.

state (string)

The health status of the robotic accessor. Values include the following in priority order:

State	Description
inServiceMode	The accessor is being serviced and is not able to move cartridges. To end this state, use the completeAccessorService task.
noMovementAllowed	The accessor is in a state where movement is not allowed due to some failure or internal process that is not related to library/accessor initialization. If dual accessors are configured, the other accessor might still be operational in this state. Access to certain drives and cartridges might be restricted if the accessor is not in the Service Bay.
bothGrippersFailed	Both grippers within this accessor have failed, and the accessor is no longer usable. It may or might not have a cartridge in it.
gripper1Failed/ gripper2Failed	A gripper within this accessor has failed, but the accessor is still usable. It may or might not have a cartridge in it.
scannerFailed	One or more scanners are either not communicating with the library or require service.
noMotorPower	Power is removed from the accessor by the library. This is normally done in response to a user opening a door of the library.
calibrating	Accessor is in the process of initializing and orienting itself within the library and is not able to move cartridges.
onlineStandby	The accessor is parked in the Service Bay. If the other accessor goes down, then this accessor becomes active. In this option, the preferred zone for the other accessor includes the entire library except for the area for the Service Bay for this accessor.
onlineActive	The accessor is operational and can fulfill requests for media.

stateReferenceEvent (number)

The unique event ID that caused the state change. If no error or warning event caused this state, this is null.

driveAccess (string)

Indicates whether the accessor can access the drive or not.

In the case of a single-accessor library, this attribute is normal when the accessor is in a state that allows it to access the drives of the library. Otherwise, limited is reported. In the case of a dual-accessor library, this attribute also depends on the state of the other accessor. If the other accessor is in the noMovementAllowed state and in a position that blocks this accessor from reaching drives, a value of limited is reported.

cartridgeAccess (string)

Indicates whether the accessor can access the cartridge or not.

In the case of a single-accessor library, this attribute is normal when the accessor is in a state that allows it to access the cartridges of the library. Otherwise, limited is reported. In the case of a dual-accessor library, this attribute also depends on the state of the other accessor. If the other accessor is in the noMovementAllowed state and in a position that blocks this accessor from reaching cartridges that it can normally access given the LibraryelasticCapacity setting, a value of limited is reported.

pivots (number)

The number of pivots this accessor has performed in its lifetime.

For Diamondback, this is null as the accessor does not pivot.

barCodeScans (number)

The number of bar code scans this accessor has performed in its lifetime.

velocityScalingXY (number)

The percentage by which the maximum velocity of the accessor is scaled in the X and Y directions. The percentage value is between 0 and 100.

velocityScalingPivot (number)

The percentage by which the maximum velocity of the accessor is scaled for the Pivot movement. The percentage value is between 0 and 100.

For Diamondback, this is null as the accessor does not pivot.

travelX (number)

The number of meters this accessor has traveled in the X direction (horizontally) in its lifetime.

travelY (number)

The number of meters this accessor has traveled in the Y direction (vertically) in its lifetime.

getsGripper1 (number)

The number of times gripper 1 on this accessor has engaged to retrieve a cartridge into the accessor in its lifetime.

putsGripper1 (number)

The number of times gripper 1 on this accessor has engaged to place a cartridge out of the accessor in its lifetime.

getsGripper2 (number)

The number of times gripper 2 on this accessor has engaged to retrieve a cartridge into the accessor in its lifetime.

putsGripper2 (number)

The number of times gripper 2 on this accessor has engaged to place a cartridge out of the accessor in its lifetime.

temperature (number)

The most recently measured temperature value in Celsius to one decimal place inside the library as measured by a sensor on the robotic accessor at its current location. If the measurement was unable to be read, for example the accessor being replaced, null is returned. For TS4500, null is returned as there is no sensor.

humidity (number)

The most recently measured percent humidity to one decimal place inside the library as measured by a sensor on the robotic accessor at its current location. If the measurement was unable to be read, for example due to the accessor being replaced, null is returned. For TS4500, null is returned as there is no sensor.