daiquiri (v1)

Download OpenAPI specification:Download

Schema

All schemas in a JSON API spec format

Authorizations:

bearer

List of schema names

Authorizations:

bearer

Responses

Get a single schema in JSON API Spec format

Authorizations:

bearer

path Parameters

name

required

string

Responses

Validate and compute calculated parameters for a s

Validate and compute calculated parameters for a schema

Authorizations:

bearer

path Parameters

name

required

string

Request Body schema: application/json

required	object
name	string

Responses

Request samples

Payload

Content type

application/json

{"data": {"property1": null,
"property2": null
},
"name": "string"
}

Save a schema preset

Authorizations:

bearer

path Parameters

name

required

string

Request Body schema: application/json

required	object
name	string
preset	string

Responses

Request samples

Payload

Content type

application/json

{"data": {"property1": null,
"property2": null
},
"name": "string",
"preset": "string"
}

Session

Get a list of current sessions

    Get a list of current sessions

Authorizations:

bearer

Responses

Get the current session

    Get the current session

Authorizations:

bearer

Responses

Yield control for the current session

    Yield control for the current session

Authorizations:

bearer

Responses

Request control for the current session

    Request control for the current session

Authorizations:

bearer

Responses

Respond to a request for control in the c

    Respond to a request for control in the current session

Authorizations:

bearer

Request Body schema: application/json

grant

required

boolean

Responses

Request samples

Payload

Content type

application/json

{"grant": true
}

Create a signed url This allows a resourc

Create a signed url

    This allows a resource to be accessed temporarily a single time without
    an access token. Can be used to downlad files, etc

Authorizations:

bearer

Request Body schema: application/json

url required	string^/[A-z0-9-/]+$ Url to sign
bewit	string The signed bewit

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"bewit": "string"
}

Request mirroring of a session

Authorizations:

bearer

Request Body schema: application/json

sessionid

string or null

The sessionid to mirror

Responses

Request samples

Payload

Content type

application/json

{"sessionid": "string"
}

Authenticator

Logout and delete the session

Login and obtain an authorisation token

Request Body schema: application/json

username required	string^[A-z0-9]+$
password required	string
client	string^[A-z0-9-]+$

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string",
"client": "string"
}

Queue

Clear the queue

Authorizations:

bearer

Request Body schema: application/json

finished

boolean

Clear the finished queue items

Responses

Request samples

Payload

Content type

application/json

{"finished": true
}

Start or pause the queue

Authorizations:

bearer

Request Body schema: application/json

state

required

boolean

The new queue state

Responses

Request samples

Payload

Content type

application/json

{"state": true
}

Update a queue setting

Authorizations:

bearer

Request Body schema: application/json

setting required	string The new queue setting
value required	any The queue setting value

Responses

Request samples

Payload

Content type

application/json

{"setting": "string",
"value": null
}

Get current queue status

Authorizations:

bearer

query Parameters

status

string

Responses

Kill the currently running queue item Arg

Kill the currently running queue item

    Args:
    stop (bool) : Whether the queue should stop after
    the current queue item was killed

Authorizations:

bearer

Request Body schema: application/json

stop	boolean Whether to Stop the queue if an actor is killed

Responses

Request samples

Payload

Content type

application/json

{"stop": true
}

Move a queue item to a different position

Authorizations:

bearer

Request Body schema: application/json

uid	string The queue item uuid
position	integer The new position

Responses

Request samples

Payload

Content type

application/json

{"uid": "string",
"position": 0
}

Add a pause item to the queue (pauses the queue wh

Add a pause item to the queue (pauses the queue when reached)

Authorizations:

bearer

Responses

Add a sleep item to the queue (sleeps for n second

Add a sleep item to the queue (sleeps for n seconds when reached)

Authorizations:

bearer

Request Body schema: application/json

time

required

integer

Responses

Request samples

Payload

Content type

application/json

{"time": 0
}

Remove an item from the queue

Authorizations:

bearer

path Parameters

uuid

required

string

Responses

Layout

List of layouts

Authorizations:

bearer

Responses

IspyalchemyMetaDataHandler

Get the current user

Authorizations:

bearer

Responses

Get the current user cache

Authorizations:

bearer

Responses

Update the user cache

Authorizations:

bearer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"cache": {"property1": null,
"property2": null
}
}

Get a list of proposals

Authorizations:

bearer

Responses

Get selected proposal

Authorizations:

bearer

path Parameters

proposal

required

string

Responses

Get a list of session

Authorizations:

bearer

query Parameters

current

boolean

Responses

Get selected session

Authorizations:

bearer

path Parameters

session

required

string

Responses

Set the session for the current user

Authorizations:

bearer

Request Body schema: application/json

session

string

Responses

Request samples

Payload

Content type

application/json

{"session": "string"
}

Create a component

Authorizations:

bearer

Request Body schema: application/json

name required	string (Name) <= 255 characters ^[\w\s-]+$
acronym required	string (Acronym) <= 45 characters ^[A-z0-9-]+$
molecularmass	number (Mass)
density	number (Density)
sequence	string (SMILES) ^([^J][A-Za-z0-9@+\-\[\]\\\/%=#$]+)$ Chemical composition

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"acronym": "string",
"molecularmass": 0,
"density": 0,
"sequence": "string"
}

Get a list of components

Authorizations:

bearer

Responses

Get selected component

Authorizations:

bearer

path Parameters

componentid

required

integer <int32>

Responses

Update a component

Authorizations:

bearer

path Parameters

componentid

required

integer <int32>

Request Body schema: application/json

name	string (Name) ^[\w\s-]+$
acronym	string (Acronym) ^[A-z0-9-]+$ A short name for the component
molecularmass	number (Mass)
density	number (Density)
sequence	string (SMILES) ^([^J][A-Za-z0-9@+\-\[\]\\\/%=#$]+)$ Chemical composition
componentid	integer
samples	integer
datacollections	integer

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"acronym": "string",
"molecularmass": 0,
"density": 0,
"sequence": "string",
"componentid": 0,
"samples": 0,
"datacollections": 0
}

Create a sample

Authorizations:

bearer

Request Body schema: application/json

name required	string (Name) <= 100 characters ^[A-z0-9-]+$
offsetx	integer (X Offset)
offsety	integer (Y Offset)
	object
componentid	integer (Component)
comments	string or null (Comments) <= 1024 characters ^(\w\|\s\|-\|%\|$\|$\|,\|\.)+$

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"offsetx": 0,
"offsety": 0,
"positions": {"property1": 0,
"property2": 0
},
"componentid": 0,
"comments": "string"
}

Get a list of samples

Authorizations:

bearer

Responses

Delete a sample

Authorizations:

bearer

path Parameters

sampleid

required

integer <int32>

Responses

Update a sample

Authorizations:

bearer

path Parameters

sampleid

required

integer <int32>

Request Body schema: application/json

name	string (Name) ^[A-z0-9-]+$
offsetx	integer (X Offset)
offsety	integer (Y Offset)
	object
componentid	integer (Component)
comments	string or null (Comments) <= 1024 characters ^(\w\|\s\|-\|%\|$\|$\|,\|\.)+$
sampleid	integer
component	string
subsamples	integer
datacollections	integer
queued	boolean
	object (Metadata)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"offsetx": 0,
"offsety": 0,
"positions": {"property1": 0,
"property2": 0
},
"componentid": 0,
"comments": "string",
"sampleid": 0,
"component": "string",
"subsamples": 0,
"datacollections": 0,
"queued": true,
"extrametadata": {"property1": null,
"property2": null
}
}

Get selected sample

Authorizations:

bearer

path Parameters

sampleid

required

integer <int32>

Responses

Create a subsample

Authorizations:

bearer

Request Body schema: application/json

sampleid required	integer
name	string (Name) ^[\w\s-]+$
type	string (Type) Enum: "roi" "poi" "loi"
source	string (Source) Enum: "manual" "auto" "reference"
comments	string or null (Comments) ^(\w\|\s\|-\|%\|$\|$\|,\|\.)+$
x	integer
y	integer
x2	integer
y2	integer
	object

Responses

Request samples

Payload

Content type

application/json

{"sampleid": 0,
"name": "string",
"type": "roi",
"source": "manual",
"comments": "string",
"x": 0,
"y": 0,
"x2": 0,
"y2": 0,
"positions": {"property1": 0,
"property2": 0
}
}

Get a list of subsamples

Authorizations:

bearer

query Parameters

sampleid

integer

Responses

Delete a subsample

Authorizations:

bearer

path Parameters

subsampleid

required

integer <int32>

Responses

Update a sub sample

Authorizations:

bearer

path Parameters

subsampleid

required

integer <int32>

Request Body schema: application/json

sampleid	integer
name	string (Name) ^[\w\s-]+$
type	string (Type) Enum: "roi" "poi" "loi"
source	string (Source) Enum: "manual" "auto" "reference"
comments	string or null (Comments) ^(\w\|\s\|-\|%\|$\|$\|,\|\.)+$
x	integer
y	integer
x2	integer
y2	integer
	object
sample	string
subsampleid	integer
datacollections	integer
queued	boolean
	object (Metadata)

Responses

Request samples

Payload

Content type

application/json

{"sampleid": 0,
"name": "string",
"type": "roi",
"source": "manual",
"comments": "string",
"x": 0,
"y": 0,
"x2": 0,
"y2": 0,
"positions": {"property1": 0,
"property2": 0
},
"sample": "string",
"subsampleid": 0,
"datacollections": 0,
"queued": true,
"extrametadata": {"property1": null,
"property2": null
}
}

Get selected subsample

Authorizations:

bearer

path Parameters

subsampleid

required

integer <int32>

Responses

Create a sample image

Authorizations:

bearer

Request Body schema: application/json

sampleid required	integer
offsetx	integer
offsety	integer
scalex	number
scaley	number
rotation	number
	object

Responses

Request samples

Payload

Content type

application/json

{"sampleid": 0,
"offsetx": 0,
"offsety": 0,
"scalex": 0,
"scaley": 0,
"rotation": 0,
"positions": {"property1": 0,
"property2": 0
}
}

Get a list of sample images

Authorizations:

bearer

query Parameters

proposal	string
sampleid	integer

Responses

Get a sample image

Authorizations:

bearer

path Parameters

sampleimageid

required

integer <int32>

query Parameters

no_cache	integer Send no cache header
scale	number Scale images by this factor

Get a list of sub/sample tags

Authorizations:

bearer

query Parameters

type	string Enum: "sample" "subsample"

Responses

Get a list of sample actions

Authorizations:

bearer

query Parameters

actiontype	string
sampleid	integer

Responses

Get a sample action

Authorizations:

bearer

path Parameters

sampleactionid

required

integer <int32>

Responses

Create a sample action position

Authorizations:

bearer

Request Body schema: application/json

sampleactionid required	integer
posx required	integer
posy required	integer
type required	string Enum: "reference" "real"
id required	integer

Responses

Request samples

Payload

Content type

application/json

{"sampleactionid": 0,
"posx": 0,
"posy": 0,
"type": "reference",
"id": 0
}

Get a list of sample action positions

Authorizations:

bearer

query Parameters

sampleactionid	integer
type	string Enum: "reference" "real"

Responses

Delete a sample action position

Authorizations:

bearer

path Parameters

positionid

required

integer <int32>

Responses

Get a list of datacollections

Authorizations:

bearer

query Parameters

session	string
datacollectiongroupid	integer
subsampleid	integer
sampleid	integer
status	string
ungroup	integer
page	integer
per_page	integer
order	string Enum: "asc" "desc"
order_by	string

Responses

Update a datacollection Only allows updat

Update a datacollection

    Only allows updating the comments field

Authorizations:

bearer

path Parameters

datacollectionid

required

integer <int32>

Request Body schema: application/json

sessionid	integer
datacollections	integer
datacollectionid required	integer
datacollectiongroupid	integer
sampleid	integer
sample	string
subsampleid	integer
starttime	string
datacollectionplanid	integer
endtime	string
duration	integer
experimenttype	string
datacollectionnumber	integer
runstatus	string
filetemplate	string
imagedirectory	string
exposuretime	number
wavelength	number
transmission	number
numberofimages	number
numberofpasses	integer
xbeam	number
ybeam	number
beamsizeatsamplex	number
beamsizeatsampley	number
steps_x	integer
steps_y	integer
dx_mm	number
dy_mm	number
patchesx	integer
patchesy	integer
	object
comments	string (Comments)

Responses

Request samples

Payload

Content type

application/json

{"sessionid": 0,
"datacollections": 0,
"datacollectionid": 0,
"datacollectiongroupid": 0,
"sampleid": 0,
"sample": "string",
"subsampleid": 0,
"starttime": "string",
"datacollectionplanid": 0,
"endtime": "string",
"duration": 0,
"experimenttype": "string",
"datacollectionnumber": 0,
"runstatus": "string",
"filetemplate": "string",
"imagedirectory": "string",
"exposuretime": 0,
"wavelength": 0,
"transmission": 0,
"numberofimages": 0,
"numberofpasses": 0,
"xbeam": 0,
"ybeam": 0,
"beamsizeatsamplex": 0,
"beamsizeatsampley": 0,
"steps_x": 0,
"steps_y": 0,
"dx_mm": 0,
"dy_mm": 0,
"patchesx": 0,
"patchesy": 0,
"snapshots": {"property1": true,
"property2": true
},
"comments": "string"
}

Get a list of datacollection file attachments

Authorizations:

bearer

query Parameters

datacollectionid	integer
filetype	string

Responses

Get a datacollection attachment

Authorizations:

bearer

path Parameters

datacollectionattachmentid

required

integer <int32>

Get a datacollection snapshot

Authorizations:

bearer

path Parameters

datacollectionid required	integer <int32>
snapshotid required	integer <int32>

query Parameters

thumb	integer Return thumbnail image
no_cache	integer Send no cache header

Create a datacollection plan

Authorizations:

bearer

Request Body schema: application/json

sampleid required	integer
experimentkind	string
energy	number
exposuretime	number
planorder	integer
required	object

Responses

Request samples

Payload

Content type

application/json

{"sampleid": 0,
"experimentkind": "string",
"energy": 0,
"exposuretime": 0,
"planorder": 0,
"scanparameters": {"property1": null,
"property2": null
}
}

Get a list of datacollection plans

Authorizations:

bearer

query Parameters

session	string
subsampleid	integer
sampleid	integer
status	string Enum: "executed" "pending"
queued	boolean
order	string Enum: "asc" "desc"
order_by	string

Responses

Delete a datacollection plan

Authorizations:

bearer

path Parameters

datacollectionplanid

required

integer <int32>

Responses

Update a datacollection plan

Authorizations:

bearer

path Parameters

datacollectionplanid

required

integer <int32>

Request Body schema: application/json

sampleid	integer
experimentkind	string
energy	number
exposuretime	number
planorder	integer
	object
datacollectionplanid	integer
timestamp	string <date-time>
subsampleid	integer
sample	string
component	string
datacollectionid	integer
containerqueuesampleid	integer
queued	boolean
status	string
linked	boolean

Responses

Request samples

Payload

Content type

application/json

{"sampleid": 0,
"experimentkind": "string",
"energy": 0,
"exposuretime": 0,
"planorder": 0,
"scanparameters": {"property1": null,
"property2": null
},
"datacollectionplanid": 0,
"timestamp": "2019-08-24T14:15:22Z",
"subsampleid": 0,
"sample": "string",
"component": "string",
"datacollectionid": 0,
"containerqueuesampleid": 0,
"queued": true,
"status": "string",
"linked": true
}

Get selected datacollection plan

Authorizations:

bearer

path Parameters

datacollectionplanid

required

integer <int32>

Responses

Get scan quality indicators

Authorizations:

bearer

path Parameters

datacollectionid

required

integer <int32>

Responses

Get a list of XRF maps

Authorizations:

bearer

query Parameters

datacollectiongroupid	integer
sampleid	integer The sampleid
subsampleid	integer The subsampleid

Responses

Delete an XRF map

Authorizations:

bearer

path Parameters

mapid

required

integer <int32>

Responses

Update an XRF map

Authorizations:

bearer

path Parameters

mapid

required

integer <int32>

Request Body schema: application/json

maproiid	integer The roiid
subsampleid	integer Object this map relates to
datacollectionid	integer
datacollectiongroupid	integer
datacollectionnumber	integer
mapid	integer The id of the map
sampleid	integer
w	integer Width of the map
h	integer Height of the map
snaked	boolean Whether the map is collected interleaved left to right
orientation	string Wehther the map is collected horizontally or vertically
element	string
edge	string
scalar	string
composites	integer
points	integer Number of completed points
opacity	number
min	number
max	number
colourmap	string
scale	string
autoscale	boolean
url	string

Responses

Request samples

Payload

Content type

application/json

{"maproiid": 0,
"subsampleid": 0,
"datacollectionid": 0,
"datacollectiongroupid": 0,
"datacollectionnumber": 0,
"mapid": 0,
"sampleid": 0,
"w": 0,
"h": 0,
"snaked": true,
"orientation": "string",
"element": "string",
"edge": "string",
"scalar": "string",
"composites": 0,
"points": 0,
"opacity": 0,
"min": 0,
"max": 0,
"colourmap": "string",
"scale": "string",
"autoscale": true,
"url": "string"
}

Get an image of an XRF map

Authorizations:

bearer

path Parameters

mapid

required

integer <int32>

Responses

Get a value at an x,y point from an XRF map

Authorizations:

bearer

path Parameters

mapid

required

integer <int32>

query Parameters

x required	integer
y required	integer

Responses

Get a histogram of values for an XRF map

Authorizations:

bearer

path Parameters

mapid

required

integer <int32>

query Parameters

autoscale

boolean

Responses

Add a new XRF composite map

Authorizations:

bearer

Request Body schema: application/json

subsampleid required	integer Object this map relates to
r required	integer
g required	integer
b required	integer
ropacity	number
gopacity	number
bopacity	number

Responses

Request samples

Payload

Content type

application/json

{"subsampleid": 0,
"r": 0,
"g": 0,
"b": 0,
"ropacity": 0,
"gopacity": 0,
"bopacity": 0
}

Get a list of XRF composite maps

Authorizations:

bearer

query Parameters

sampleid

integer

The sampleid

Responses

Delete an XRF composite map

Authorizations:

bearer

path Parameters

compositeid

required

integer <int32>

Responses

Update an XRF composite map

Authorizations:

bearer

path Parameters

compositeid

required

integer <int32>

Request Body schema: application/json

subsampleid	integer
r	integer
g	integer
b	integer
ropacity	number
gopacity	number
bopacity	number
compositeid	integer The id of the composite map
sampleid	integer
opacity	number
rroi	string
groi	string
broi	string
url	string

Responses

Request samples

Payload

Content type

application/json

{"subsampleid": 0,
"r": 0,
"g": 0,
"b": 0,
"ropacity": 0,
"gopacity": 0,
"bopacity": 0,
"compositeid": 0,
"sampleid": 0,
"opacity": 0,
"rroi": "string",
"groi": "string",
"broi": "string",
"url": "string"
}

Get an image of an XRF composite map

Authorizations:

bearer

path Parameters

compositeid

required

integer <int32>

Responses

Add a new XRF map ROI

Authorizations:

bearer

Request Body schema: application/json

sampleid required	integer (Sample ROI is associated to)
element required	string (Element) <= 2 characters ^[A-z0-9-]+$
edge required	string (Edge) <= 3 characters ^[A-z0-9-]+$
start required	number (Start) Start Energy of ROI
end required	number (End) End Energy of ROI

Responses

Request samples

Payload

Content type

application/json

{"sampleid": 0,
"element": "st",
"edge": "str",
"start": 0,
"end": 0
}

Get a list of XRF map ROIs

Authorizations:

bearer

query Parameters

sampleid

integer

Responses

Delete an XRF map ROI

Authorizations:

bearer

path Parameters

maproiid

required

integer <int32>

Responses

Update an XRF map ROI

Authorizations:

bearer

path Parameters

maproiid

required

integer <int32>

Request Body schema: application/json

sampleid required	integer (Sample ROI is associated to)
element required	string (Element) <= 2 characters ^[A-z0-9-]+$
edge required	string (Edge) <= 3 characters ^[A-z0-9-]+$
start required	number (Start) Start Energy of ROI
end required	number (End) End Energy of ROI
maproiid	integer
maps	integer

Responses

Request samples

Payload

Content type

application/json

{"sampleid": 0,
"element": "st",
"edge": "str",
"start": 0,
"end": 0,
"maproiid": 0,
"maps": 0
}

Get a list of auto processings

Authorizations:

bearer

query Parameters

sampleid	integer
subsampleid	integer
datacollectionid	integer
exclude_sqi	integer Exclude SQI Programs
page	integer
per_page	integer
order	string Enum: "asc" "desc"
order_by	string

Responses

Get a list of auto processing attachments

Authorizations:

bearer

query Parameters

autoprocprogramid

integer

Responses

Get an auto processing attachment

Authorizations:

bearer

path Parameters

autoprocprogramattachmentid

required

integer <int32>

Get a list of auto processing messages

Authorizations:

bearer

query Parameters

autoprocprogramid

integer

Responses

Bliss_BasicSavingHandler

Get the current saving configuration

Authorizations:

bearer

query Parameters

sessionid	integer
sampleid	integer
subsampleid	integer

Responses

Update the saving arguments

Authorizations:

bearer

Request Body schema: application/json

required

object (Arguments)

Responses

Request samples

Payload

Content type

application/json

{"arguments": {"property1": "string",
"property2": "string"
}
}

Celery

Get a list of workers and their tasks

Authorizations:

bearer

Responses

Revoke and terminate a running task

Authorizations:

bearer

path Parameters

task_id

required

string

Responses

Get a list of available tasks

Authorizations:

bearer

Responses

Get a list of executed tasks

Authorizations:

bearer

query Parameters

page	integer
per_page	integer

Responses

Get details of an executed tasks

Authorizations:

bearer

path Parameters

job_id

required

string

Responses

/api/celery/tasks/sleep

Authorizations:

bearer

Request Body schema: application/json

sleep_time	integer
raise_exception	boolean
reject	boolean

Request samples

Payload

Content type

application/json

{"sleep_time": 0,
"raise_exception": true,
"reject": true
}

Synoptic

Get a synoptic image

Authorizations:

bearer

path Parameters

sid

required

integer <int32>

Responses

H5Grove

/api/h5grove/attr/

Authorizations:

bearer

query Parameters

autoprocprogramid	integer Auto processing program id
autoprocprogramattachmentid	integer Auto processing program attachment id
datacollectionid	integer Data collection id
sampleactionid	integer Sample action id
type	string Value: "processing"
path	string Default: "/"
attr_keys	Array of strings Default: null

Responses

/api/h5grove/data/

Authorizations:

bearer

query Parameters

autoprocprogramid	integer Auto processing program id
autoprocprogramattachmentid	integer Auto processing program attachment id
datacollectionid	integer Data collection id
sampleactionid	integer Sample action id
type	string Value: "processing"
path	string Default: "/"
selection	string Default: null
format	string Default: "json" Enum: "json" "bin" "csv" "npy" "tiff"
flatten	boolean Default: false
dtype	string Default: "origin" Enum: "origin" "safe"

Responses

/api/h5grove/meta/

Authorizations:

bearer

query Parameters

autoprocprogramid	integer Auto processing program id
autoprocprogramattachmentid	integer Auto processing program attachment id
datacollectionid	integer Data collection id
sampleactionid	integer Sample action id
type	string Value: "processing"
path	string Default: "/"

Responses

Parameteriser

Get the list of parameter sets for the selected pa

Get the list of parameter sets for the selected parameter type

Authorizations:

bearer

query Parameters

type

required

string

The type of parameters to list

Responses

/api/parameteriser/scircle

Authorizations:

bearer

Request Body schema: application/json

name required	string (Name) ^[A-z0-9-]+$
overwrite	boolean
center_horizontal required	number (Center Horizontal)
center_vertical required	number (Center Vertical)
diameter required	number (Diameter)

Request samples

Payload

Content type

application/json

{"name": "string",
"overwrite": true,
"center_horizontal": 0,
"center_vertical": 0,
"diameter": 0
}

/api/parameteriser/srect

Authorizations:

bearer

Request Body schema: application/json

name required	string (Name) ^[A-z0-9-]+$
overwrite	boolean
center_horizontal required	number (Center Horizontal)
center_vertical required	number (Center Vertical)
size_horizontal required	number (Size Horizontal)
size_vertical required	number (Size Vertical)

Request samples

Payload

Content type

application/json

{"name": "string",
"overwrite": true,
"center_horizontal": 0,
"center_vertical": 0,
"size_horizontal": 0,
"size_vertical": 0
}

Hardware

Get a list of all hardware statuses

Authorizations:

bearer

query Parameters

type	string Filter by a specific type
group	string Filter by a specific group name

Responses

Update a property on a hardware object

Authorizations:

bearer

path Parameters

id

required

string

Request Body schema: application/json

property required	string^[A-z0-9]+$
value required	any or null

Responses

Request samples

Payload

Content type

application/json

{"property": "string",
"value": null
}

Call a function on a hardware object

Authorizations:

bearer

path Parameters

id

required

string

Request Body schema: application/json

function required	string^[A-z0-9]+$
value	any

Responses

Request samples

Payload

Content type

application/json

{"function": "string",
"value": null
}

Get the status of a particular hardware object

Authorizations:

bearer

path Parameters

id

required

string

Responses

Get a list of the hardware object groups

Authorizations:

bearer

Responses

Get a list of the different hardware types in use

Authorizations:

bearer

Responses

Fileeditor

Get the directory listing

Authorizations:

bearer

Responses

Get a file

Authorizations:

bearer

path Parameters

path

required

string

query Parameters

path

string

Responses

Update a file

Authorizations:

bearer

path Parameters

path

required

string

Request Body schema: application/json

path	string
contents required	string
ext	string

Responses

Request samples

Payload

Content type

application/json

{"path": "string",
"contents": "string",
"ext": "string"
}

Samplescan

Get a list of available scans

Authorizations:

bearer

Responses

Queue a scan from a datacollectionplan

Authorizations:

bearer

path Parameters

datacollectionplanid

required

integer <int32>

Responses

/api/samplescan/scan1

Authorizations:

bearer

Request Body schema: application/json

sampleid required	integer
motor_start required	number (Start Position)
motor_end required	number (End Position)
npoints required	integer (No. Points)
time required	number (Time(s) per Point) [ 0.1 .. 5 ]
detectors required	Array of strings (Detectors) non-empty unique Items Enum: "diode" "simu1" "lima_simulator"
enqueue	boolean (Queue Scan)

Request samples

Payload

Content type

application/json

{"sampleid": 0,
"motor_start": 0,
"motor_end": 0,
"npoints": 0,
"time": 0.1,
"detectors": ["diode"
],
"enqueue": true
}

/api/samplescan/scan2

Authorizations:

bearer

Request Body schema: application/json

sampleid required	integer
motor_start required	number (Start Position)
motor_end required	number (End Position)
detectors required	Array of strings (Detectors) non-empty unique Items Enum: "diode" "simu1" "lima_simulator"

Request samples

Payload

Content type

application/json

{"sampleid": 0,
"motor_start": 0,
"motor_end": 0,
"detectors": ["diode"
]
}

Imageviewer

Get a list of image sources defined in the current

Get a list of image sources defined in the current 2d viewer

Authorizations:

bearer

Responses

/api/imageviewer/sources/origin

Authorizations:

bearer

Responses

/api/imageviewer/sources/origin

Authorizations:

bearer

Request Body schema: application/json

has_fine	boolean Whether this origin has fine axes
fine_fixed	boolean Whether the fine axis is fixed during movement
coarse_fixed	boolean Whether the coarse axis is fixed during movement
	object (ImageSourceConfig)

Responses

Request samples

Payload

Content type

application/json

{"has_fine": true,
"fine_fixed": true,
"coarse_fixed": true,
"config": {"fine_fixed": true,
"allow_fixed_axes": true
}
}

Capture an image from a source

Authorizations:

bearer

Request Body schema: application/json

sampleid required	integer The sampleid
subsampleid	integer Optionally a subsampleid

Responses

Request samples

Payload

Content type

application/json

{"sampleid": 0,
"subsampleid": 0
}

/api/imageviewer/maps

Authorizations:

bearer

Responses

/api/imageviewer/maps

Authorizations:

bearer

Request Body schema: application/json

during_scan	boolean Whether to generate maps during a scan
scalar_maps	Array of strings List of scalars to automatically create maps from

Responses

Request samples

Payload

Content type

application/json

{"during_scan": true,
"scalar_maps": ["string"
]
}

Generate a new map for a subsampleid

Authorizations:

bearer

path Parameters

subsampleid

required

integer <int32>

Request Body schema: application/json

datacollectionid

integer

Optionally a datacollectionid

Responses

Request samples

Payload

Content type

application/json

{"datacollectionid": 0
}

Generate a new map from additional scalars

Authorizations:

bearer

Request Body schema: application/json

datacollectionid required	integer
scalars required	Array of strings non-empty

Responses

Request samples

Payload

Content type

application/json

{"datacollectionid": 0,
"scalars": ["string"
]
}

Move the cursor position to the current origin mar

Move the cursor position to the current origin marking position

Authorizations:

bearer

Request Body schema: application/json

x required	number (X Position)
y required	number (Y Position)

Responses

Request samples

Payload

Content type

application/json

{"x": 0,
"y": 0
}

Move the cursor position to a position from a refe

Move the cursor position to a position from a reference image

Authorizations:

bearer

Request Body schema: application/json

x required	number (X Position)
y required	number (Y Position)
execute	boolean

Responses

Request samples

Payload

Content type

application/json

{"x": 0,
"y": 0,
"execute": true
}

Select a sampleaction and calculate transformation

Select a sampleaction and calculate transformation matrix

Authorizations:

bearer

Request Body schema: application/json

sampleactionid

required

integer (Sample Action)

Responses

Request samples

Payload

Content type

application/json

{"sampleactionid": 0
}

Move the specified subsample to the current origin

Move the specified subsample to the current origin marking position

Authorizations:

bearer

path Parameters

subsampleid

required

integer <int32>

Responses

Upload an image and send it to an actor

Authorizations:

bearer

path Parameters

sampleid

required

integer <int32>

Request Body schema: application/json

image required	string Base64 encoded image
sampleid required	integer Sample this image belongs to

Responses

Request samples

Payload

Content type

application/json

{"image": "string",
"sampleid": 0
}

Export the selected subsamples to json

Authorizations:

bearer

Request Body schema: application/json

subsampleids

required

Array of integers

A list of subsamples to export

Responses

Request samples

Payload

Content type

application/json

{"subsampleids": [0
]
}

/api/imageviewer/mosaic

Authorizations:

bearer

Request Body schema: application/json

x1 required	integer (X Start)
y1 required	integer (Y Start)
x2 required	integer (X End)
y2 required	integer (Y End)
sampleid required	integer (Sampleid)
steps_x required	integer
steps_y required	integer

Request samples

Payload

Content type

application/json

{"x1": 0,
"y1": 0,
"x2": 0,
"y2": 0,
"sampleid": 0,
"steps_x": 0,
"steps_y": 0
}

/api/imageviewer/reference

Authorizations:

bearer

Export a reference image to a sample image

    Transforms the image into the current 2dview coordinate space
    using the selected transformation matrix

Authorizations:

bearer

Request Body schema: application/json

sampleactionid required	integer (Sample Action)
	object (Region to crop reference image to)

Responses

Request samples

Payload

Content type

application/json

{"sampleactionid": 0,
"crop": {"x": [0
],
"y": [0
]
}
}

/api/imageviewer/sources/autofocus

Authorizations:

bearer

/api/imageviewer/scan/roiscan

Authorizations:

bearer

Request Body schema: application/json

subsampleid required	integer
step_size_x required	number (Size Vert) >= 0.1
step_size_y required	number (Size Horz) >= 0.1
dwell required	number (Dwell time) [ 0.001 .. 60 ]
	object (Beamline Parameters)
with_lima	boolean (Enable Lima Camera)
enqueue	boolean (Queue Scan)
estimate	number

Request samples

Payload

Content type

application/json

{"subsampleid": 0,
"step_size_x": 0.1,
"step_size_y": 0.1,
"dwell": 0.001,
"beamlineparams": {"detector_distance": 20,
"fast_shutter": true,
"attenuators": "0.1mm_al",
"pinhole": "10um",
"light": true,
"diode_gain": [{"name": "d1",
"value": 0
}
],
"arb_motor": [{"name": "x",
"value": 0
}
],
"energy": 0
},
"with_lima": true,
"enqueue": true,
"estimate": 0
}

/api/imageviewer/scan/fluoxas

Authorizations:

bearer

Request Body schema: application/json

subsampleid required	integer
step_size_x required	number (Step Size Horizontally) >= 0.1
step_size_y required	number (Step Size Vertically) >= 0.1
reference required	number (Energy Reference) >= 0.1
required	Array of objects (Energy Regions) non-empty
	object (Beamline Parameters)
enqueue	boolean (Queue Scan)

Request samples

Payload

Content type

application/json

{"subsampleid": 0,
"step_size_x": 0.1,
"step_size_y": 0.1,
"reference": 0.1,
"regions": [{"start_e": 0,
"end_e": 0,
"step": 0.01,
"dwell": 0.01
}
],
"beamlineparams": {"detector_distance": 20,
"fast_shutter": true,
"attenuators": "0.1mm_al",
"pinhole": "10um",
"light": true,
"diode_gain": [{"name": "d1",
"value": 0
}
],
"arb_motor": [{"name": "x",
"value": 0
}
],
"energy": 0
},
"enqueue": true
}

/api/imageviewer/scan/myscan

Authorizations:

bearer

Request Body schema: application/json

subsampleid

required

integer

Request samples

Payload

Content type

application/json

{"subsampleid": 0
}

/api/imageviewer/scan/poiscan

Authorizations:

bearer

Request Body schema: application/json

subsampleid required	integer
repeats required	integer (No. Repeats) >= 1
required	Array of objects (Energy Regions) non-empty
reference required	number (Energy Reference) >= 0.1
	object (Beamline Parameters)
enqueue	boolean (Queue Scan)

Request samples

Payload

Content type

application/json

{"subsampleid": 0,
"repeats": 1,
"regions": [{"start_e": 0,
"end_e": 0,
"step": 0.01,
"dwell": 0.01
}
],
"reference": 0.1,
"beamlineparams": {"detector_distance": 20,
"fast_shutter": true,
"attenuators": "0.1mm_al",
"pinhole": "10um",
"light": true,
"diode_gain": [{"name": "d1",
"value": 0
}
],
"arb_motor": [{"name": "x",
"value": 0
}
],
"energy": 0
},
"enqueue": true
}

/api/imageviewer/scan/loiscan

Authorizations:

bearer

Request Body schema: application/json

subsampleid required	integer
steps required	integer (Steps) >= 2
required	Array of objects (Energy Regions) = 1 items
reference required	number (Energy Reference) >= 0.1
	object (Beamline Parameters)
enqueue	boolean (Queue Scan)

Request samples

Payload

Content type

application/json

{"subsampleid": 0,
"steps": 2,
"regions": [{"start_e": 0,
"end_e": 0,
"step": 0.01,
"dwell": 0.01
}
],
"reference": 0.1,
"beamlineparams": {"detector_distance": 20,
"fast_shutter": true,
"attenuators": "0.1mm_al",
"pinhole": "10um",
"light": true,
"diode_gain": [{"name": "d1",
"value": 0
}
],
"arb_motor": [{"name": "x",
"value": 0
}
],
"energy": 0
},
"enqueue": true
}

Simplescan

/api/simplescan

Authorizations:

bearer

Request Body schema: application/json

motor required	string (Motor) Enum: "robz" "roby"
motor_start required	number (Start Position)
motor_end required	number (End Position)
npoints required	integer (No. Points)
time required	number (Time per Point) [ 0.1 .. 5 ]
detectors required	Array of strings (Detectors) non-empty unique Items Enum: "diode" "simu1" "lima_simulator"

Request samples

Payload

Content type

application/json

{"motor": "robz",
"motor_start": 0,
"motor_end": 0,
"npoints": 0,
"time": 0.1,
"detectors": ["diode"
]
}

Hdf5

Get the contents of an hdf5 file

Authorizations:

bearer

query Parameters

autoprocprogramid	integer Auto processing program id
autoprocprogramattachmentid	integer Auto processing program attachment id
datacollectionid	integer Data collection id
type	string Value: "processing"

Responses

Get a group and its data from a hdf5 file

Authorizations:

bearer

path Parameters

path

required

string

query Parameters

autoprocprogramid	integer Auto processing program id
autoprocprogramattachmentid	integer Auto processing program attachment id
datacollectionid	integer Data collection id
type	string Value: "processing"

Responses

Scans

Get a list of all scans and their info

Authorizations:

bearer

query Parameters

page	integer
per_page	integer

Responses

Get current scan status i.e. if there is

Get current scan status

    i.e. if there is a running scan

Authorizations:

bearer

Responses

Get info for a specific scan

Authorizations:

bearer

path Parameters

scanid

required

integer <int32>

Responses

Get the data for a specific scan

Authorizations:

bearer

path Parameters

scanid

required

integer <int32>

query Parameters

scalars	Array of strings
page	integer
per_page	integer

Responses

Get all the data for a specific scan scalar in bin

Get all the data for a specific scan scalar in binary format

    Arguments:
        scanid: Identifier of the scan
        channel: Name of the data channel
        dtype: One of "origin" or "safe" or numpy string like "float32" or "<f16"
        selection: A string representation to slice the data (`1,2::2`)

Authorizations:

bearer

path Parameters

scanid

required

integer <int32>

query Parameters

channel required	string
dtype	string
selection	string

Responses

Get the spectra for a specific scan

Authorizations:

bearer

path Parameters

scanid

required

integer <int32>

query Parameters

point

required

integer

The point to return a spectrum for

Responses

Get the image for a specific scan

Authorizations:

bearer

path Parameters

scanid

required

integer <int32>

query Parameters

node_name	string The scan node name to get images from
image_no	integer The image number to load
raw	boolean Return the raw data rather than an image (gzipped)
norm	string Normalization of the image, can be 'linear', 'log', 'arcsinh', 'sqrt'
autoscale	string Autoscale for the domain of the image, can be 'none', 'minmax', 'stddev3'
lut	string LUT for the colors, can be 'gray', 'gray_r', 'viridis', 'cividis'

Responses

Version

Returns the current daiquiri version

Authorizations:

bearer

Responses

Logging

Get the last n lines of the user level log

Authorizations:

bearer

query Parameters

lines	integer
offset	integer

Responses

Log a UI Error

Authorizations:

bearer

Request Body schema: application/json

status required	string Enum: "resolved" "error" Whether the frame stacktrace was resolved
message required	string The error messsage
frame	string The frame stacktrace
error	string The (secondary) error as to why the frame couldnt be resolved

Responses

Request samples

Payload

Content type

application/json

{"status": "resolved",
"message": "string",
"frame": "string",
"error": "string"
}

Chat

Mark all chat message as read

Authorizations:

bearer

Responses

Add a new chat message

Authorizations:

bearer

Request Body schema: application/json

message required	string The message
messageid	integer Unique id of the message
timestamp	integer Epoch timestamp message was sent
sessionid	string Author sessionid
user	string User name associated with sessionid
read	Array of strings List of sessions that have read the message

Responses

Request samples

Payload

Content type

application/json

{"message": "string",
"messageid": 0,
"timestamp": 0,
"sessionid": "string",
"user": "string",
"read": ["string"
]
}

Get the last n chat messages

Authorizations:

bearer

query Parameters

limit	integer
offset	integer

Responses

Mark a chat message as read

Authorizations:

bearer

path Parameters

messageid

required

integer <int32>

Responses

Components

Get a list of loaded components

Responses

Returns any config that is exported from each of t

Returns any config that is exported from each of the loaded components

Reload all components with new config

Authorizations:

bearer

Responses

Change the app debug state

Request Body schema: application/json

state

required

boolean

The requested application debug state

Responses

Request samples

Payload

Content type

application/json

{"state": true
}

Get the app debug state