Queue REST API

PUT /mxcube/api/v0.1/queue/start

Start execution of the queue.

Returns:

Respons object, status code set to: 200: On success 409: Queue could not be started

PUT /mxcube/api/v0.1/queue/stop

Stop execution of the queue.

Returns:

Response object status code set to: 200: On success 409: Queue could not be stopped

PUT /mxcube/api/v0.1/queue/abort

Abort execution of the queue.

Returns:

Response object, status code set to: 200 On success 409 queue could not be aborted

PUT /mxcube/api/v0.1/queue/pause

Pause the execution of the queue.

Returns:

Response object, status code set to: 200: On success 409: Queue could not be paused

PUT /mxcube/api/v0.1/queue/unpause

Unpause execution of the queue.

Returns:

Response object, status code set to: 200: On success 409: Queue could not be unpause

PUT /mxcube/api/v0.1/queue/clear

Clear the queue.

Returns:

Response object, status code set to: 200: On success 409: Queue could not be started

GET /mxcube/api/v0.1/queue/

Get the queue.

Returns:

Response object response Content-Type: application/json, json object containing the queue on the format returned by queue_to_dict. The status code is set to:

200: On success 409: On error, could not retrieve queue

GET /mxcube/api/v0.1/queue/queue_state

Get the queue.

Returns:

Response object response Content-Type: application/json, json object containing the queue state. The status code is set to:

200: On success 409: On error, could not retrieve queue

PUT /mxcube/api/v0.1/queue/(sid)/(tindex)/execute

Execute the entry at position (sampleID, task index) in queue.

Parameters:

• sid (str) – sampleID

• tindex (int) – task index of task within sample with id sampleID

Statuscode:

200, no error 409, queue entry could not be executed

PUT /mxcube/api/v0.1/queue/(sample_id)

Update a sample info.

Parameters:

• node_id – entry identifier, integer. It can be a sample or a task within a sample

Request Content-Type:

application/json, object containing the parameter(s) to be updated, any parameter not sent will not be modified.

Statuscode:

200: no error

Statuscode:

409: sample info could not be updated, possibly because the given sample does not exist in the queue

GET /mxcube/api/v0.1/queue/available_tasks

Return a list of all available tasks.

POST /mxcube/api/v0.1/queue/update_dependent_field

Update the dependent fields of the given task.