bluesky_queueserver_api.zmq.REManagerAPI.plans_existing

REManagerAPI.plans_existing(*, reload=False)

Returns the list (dictionary) of existing plans. The function checks plans_existing_uid status parameter and downloads the list of existing plans from the server if UID changed. Otherwise the copy of cached list of existing plans is returned.

Parameters:
reload: boolean

Set the parameter True to force reloading of status from the server before plans_existing_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.

  • plans_existing: dict - list (dictionary) of existing plans.

  • plans_existing_uid: str - UID of the list of existing plans.

Raises:
RequestTimeoutError, RequestFailedError, HTTPRequestError, HTTPClientError, HTTPServerError

All exceptions raised by send_request API.

Examples

# Synchronous code (0MQ, HTTP)
response = RM.plans_existing()
plans_existing = response["plans_existing"]

# Asynchronous code (0MQ, HTTP)
response = await RM.plans_existing()
plans_existing = response["plans_existing"]