Beamline REST API

PUT /mxcube/api/v0.1/beamline/motor/value/(string: name)

Tries to set < name > to value Replies with status code 200 on success and 400 on exceptions.

POST /mxcube/api/v0.1/beamline/detector/command/restart

Tries to set < name > to value Replies with status code 200 on success and 409 on exceptions.

PUT /mxcube/api/v0.1/beamline/nstate/value/(string: name)

Tries to set < name > to value Replies with status code 200 on success and 400 on exceptions.

PUT /mxcube/api/v0.1/beamline/beam/size/(string: name)

Tries to set < name > to value Replies with status code 200 on success and 400 on exceptions.

PUT /mxcube/api/v0.1/beamline/actuator/value/(string: name)

Tries to set < name > to value Replies with status code 200 on success and 400 on exceptions.

PUT /mxcube/api/v0.1/beamline/energy/value/(string: name)

Tries to set < name > to value Replies with status code 200 on success and 400 on exceptions.

POST /mxcube/api/v0.1/beamline/diffractometer/command/abort

Tries to set < name > to value Replies with status code 200 on success and 409 on exceptions.

POST /mxcube/api/v0.1/beamline/diffractometer/command/status

Tries to set < name > to value Replies with status code 200 on success and 409 on exceptions.

POST /mxcube/api/v0.1/beamline/diffractometer/command/my_fancy_function

Tries to set < name > to value Replies with status code 200 on success and 409 on exceptions.

POST /mxcube/api/v0.1/beamline/diffractometer/command/my_other_funny_function

Tries to set < name > to value Replies with status code 200 on success and 409 on exceptions.

POST /mxcube/api/v0.1/beamline/diffractometer/command/set_chip_layout

Tries to set < name > to value Replies with status code 200 on success and 409 on exceptions.

GET /mxcube/api/v0.1/beamline/(name)/abort

Aborts an action in progress.

Parameters:

• name (str) – Owner / Actuator of the process/action to abort

Replies with status code 200 on success and 500 on exceptions.

POST /mxcube/api/v0.1/beamline/(name)/run

Starts a beamline action; POST payload is a json-encoded object with ‘parameters’ as a list of parameters

Parameters:

• name (str) – action to run

Replies with status code 200 on success and 500 on exceptions.

GET /mxcube/api/v0.1/beamline/beam/info

Beam information: position, size, shape return_data = {“position”: , “shape”: , “size_x”: , “size_y”: }

GET /mxcube/api/v0.1/beamline/datapath

Retrieve data directory from the session hwobj, this is specific for each beamline.

PUT /mxcube/api/v0.1/beamline/prepare_beamline

Prepare the beamline for a new sample.