Start service on robotic accessor

Initiates a service action on the specified accessor. This puts the accessor in the inServiceMode state. This is typically done at the start of a replacement procedure.

While the accessor state is inServiceMode, the accessor is offline, and will not be able to move cartridges.

Request syntax

POST /v1/tasks {"type": "startAccessorService", "accessor": "accessor_A<a|b>"}
Initiates a service action on the specified accessor. This puts the accessor in the inServiceMode state and 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, startAccessorService.

accessor (string, required)

The accessor that is to be serviced.

Example

> POST /v1/tasks {"type": "startAccessorService", "accessor": "accessor_Aa"}
HTTP/1.1 201 Created
Accessor: /v1/tasks/42
Content-Type: application/json
Content-Length: 10

{"ID": 48}