bluesky_queueserver_api.zmq.REManagerAPI.history_get

REManagerAPI.history_get(*, reload=False)

Returns the list of plans in the history. The function checks plan_history_uid status parameter and downloads the history from the server if UID changed. Otherwise the copy of cached history is returned.

Parameters:
reload: boolean

Set the parameter True to force reloading of status from the server before plan_history_uid is checked. Otherwise cached status is used.

Returns:
response: dict

Dictionary keys:

  • success: boolean - success of the request.

  • msg: str - error message in case the request is rejected by RE Manager or operation failed.

  • items: list(dict) - list of dictionaries containing history item parameters.

  • plan_history_uid: str - UID of the plan queue

Raises:
RequestTimeoutError, RequestFailedError, HTTPRequestError, HTTPClientError, HTTPServerError

All exceptions raised by send_request API.

Examples

# Synchronous code (0MQ, HTTP)
response = RM.history_get()
history_items = response["items"]
history_uid = response["plan_history_uid"]

# Asynchronous code (0MQ, HTTP)
response = await RM.history_get()
history_items = response["items"]
history_uid = response["plan_history_uid"]