API docs by Redocly

BlissAPI (1.0.0)

Download OpenAPI specification:

A REST/WebSocket API for BLISS

BeaconApi

Get a yaml file from beacon

path Parameters
path
required
string (Path)

Name of the file to retrieve

Responses

Response samples

Content type
application/json
{
  • "content": null
}

InfoApi

Get information from this BLISS session

Get information from the session.

Responses

Response samples

Content type
application/json
{
  • "synchrotron": "string",
  • "beamline": "string",
  • "instrument": "string",
  • "session": "string",
  • "bliss_version": "string",
  • "blissdata_version": "string",
  • "flint_version": "string",
  • "blisstomo_version": "string",
  • "fscan_version": "string",
  • "blisswebui_version": "string"
}

CallApi

Call a function in the session asynchronously

Call a function either directly in the session or on an object in the session asynchronously

This allows for example, to execute scans, and interact with bliss objects in the context
of the running session.

If has_scan_factory is true, assume the function returns a scan and return the scan in the
progress field of the call state.

Request Body schema: application/json
required
Env Object (string) or Env Object (null) (Env Object)
Default: null

A path to an object from the environment on which to call a function

Object (string) or Object (null) (Object)
Default: null

A name of a registered object

function
required
string (Function)

The function to call

Array of Args (any) or Args (null) (Args)

A list of arguments, special types can be handled with jsonready

Kwargs (object) or Kwargs (null) (Kwargs)

A dictionary of kwargs, special types can be handled with jsonready

Has Scan Factory (boolean) or Has Scan Factory (null) (Has Scan Factory)
Default: false

Assume this function creates a Scan, call it with run=False, start the scan, and retrieve the scan in the progress response

In Terminal (boolean) or In Terminal (null) (In Terminal)
Default: false

If true, the call is executed inside the BLISS terminal. If the terminal is busy an exception is raised.

Emit Stdout (boolean) or Emit Stdout (null) (Emit Stdout)
Default: false

If true, the call stdout are emitted as event in the websocket namespace /call.

Responses

Request samples

Content type
application/json
{
  • "env_object": null,
  • "object": null,
  • "function": "string",
  • "args": [
    ],
  • "kwargs": { },
  • "has_scan_factory": false,
  • "in_terminal": false,
  • "emit_stdout": false
}

Response samples

Content type
application/json
{
  • "call_id": "string"
}

Get the state and response for an asynchronous call to a function in the session

Get the state and response of an asynchronous function call in the session

When the the function returns it will try to json serialise the response,
if this is not possible an exception will be raised.

Exceptions will be caught and returned along with the traceback.

path Parameters
call_id
required
string (Call Id)

Responses

Response samples

Content type
application/json
{
  • "state": "running",
  • "return_value": null,
  • "progress": null
}

Kill an asynchronous call to a function in the session

Kill an asynchronous function call in the session

Exceptions will be caught and returned along with the traceback.

path Parameters
call_id
required
string (Call Id)

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

ObjectTypeApi

Get a list of all abstract objects

Get a list of all abstract objects

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "results": [
    ],
  • "skip": null,
  • "limit": null
}

Get a single abstract object

Get a single abstract object

path Parameters
id
required
string (Id)

The id of the object type

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "state_ok": [
    ],
  • "properties": null,
  • "callables": { }
}

ObjectApi

Get a list of all hardware objects and their statuses

Get a list of all hardware objects and their statuses

query Parameters
Type (string) or Type (null) (Type)
Default: null

Filter by a specific type

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "results": [
    ],
  • "skip": null,
  • "limit": null
}

Register a series of hardware objects to be made available via the API

Register a series of hardware objects to be made available via the API

Request Body schema: application/json
required
names
required
Array of strings (Names)

Responses

Request samples

Content type
application/json
{
  • "names": [
    ]
}

Response samples

Content type
application/json
{
  • "names": [
    ]
}

Get a single hardware object

Get the status of a particular hardware object

path Parameters
name
required
string (Name)

The unique bliss object name

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "online": true,
  • "errors": [
    ],
  • "alias": null,
  • "properties": { },
  • "user_tags": [
    ],
  • "locked": {
    }
}

Update an object property

Update a property on a hardware object

path Parameters
name
required
string (Name)

The unique bliss object name

Request Body schema: application/json
required
property
required
string (Property)

The property to set

value
required
any (Value)

Its value

Responses

Request samples

Content type
application/json
{
  • "property": "string",
  • "value": null
}

Response samples

Content type
application/json
{
  • "property": "string",
  • "value": null
}

Unregister an object

Unregister an object.

path Parameters
name
required
string (Name)

The unique bliss object name

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}