Leash Response Schema

This is the Schema of the data the server sends back as a response.

The ‘*‘ signifies a required Field.

Schema for requests from Saxs Leash to Saxs Server

Type:

object
Contains:

result*, data*
Required:

True
JSON Path:

Example JSON:

{"data": {},"result": ""}

result

Type:

string
Required:

True
JSON Path:

Example JSON:

{"result": ""}

data

Type:

object
Contains:

cal, Error, syncplot, directory, attachments, threads, dircontent, history, fileslist, stat, filename, IntegralParameters, graphs
Required:

True
JSON Path:

Example JSON:

{"data": {}}

cal

Type:

object
Required:

False
JSON Path:

Example JSON:

{"cal": null}

Error

type:

object
Required:

False
JSON Path:

Example JSON:

{"Error": {}}

syncplot

type:

object
Required:

False
JSON Path:

Example JSON:

{"syncplot": {}}

directory

Directory this queue is going to use. New files in other directories are going to be ignored.

Type:

array() items:
Required:

False
Default:

[u’.’, u’‘, u’‘]
JSON Path:

Example JSON:

{"directory": [".","",""]}

attachments

type:

object
Required:

False
JSON Path:

Example JSON:

{"attachments": {}}

threads

Type:

integer
Required:

False
JSON Path:

Example JSON:

{"threads": 0}

dircontent

type:

object
Required:

False
JSON Path:

Example JSON:

{"dircontent": {}}

history

type:

object
Required:

False
JSON Path:

Example JSON:

{"history": {}}

fileslist

type:

object
Required:

False
JSON Path:

Example JSON:

{"fileslist": {}}

stat

type:

object
Contains:

queue length, images processed, time, start time, mergecount
Required:

False
JSON Path:

Example JSON:

{"stat": {}}

queue length

Type:

integer
Required:

False
JSON Path:

Example JSON:

{"queue length": 0}

images processed

Type:

integer
Required:

False
JSON Path:

Example JSON:

{"images processed": 0}

time

Type:

number
Required:

False
JSON Path:

Example JSON:

{"time": 0}

start time

Type:

number
Required:

False
JSON Path:

Example JSON:

{"start time": 0}

mergecount

Type:

number
Required:

False
JSON Path:

Example JSON:

{"mergecount": 0}

filename

Type:

string
Required:

False
JSON Path:

Example JSON:

{"filename": ""}

IntegralParameters

type:

object
Required:

False
JSON Path:

Example JSON:

{"IntegralParameters": {}}

graphs

Type:

array() items: {kind, conf, columnLabels, array}
Required:

False
JSON Path:

Example JSON:

{"graphs": []}

kind

Type:

string
values:

[Radial, Slice]
Required:

False
JSON Path:

Example JSON:

{"kind": "Radial"}

conf

Type:

object
Required:

False
JSON Path:

Example JSON:

{"conf": null}

columnLabels

Type:

array() items: string
Required:

False
JSON Path:

Example JSON:

{"columnLabels": []}

array

Type:

array() items:
Required:

False
JSON Path:

Example JSON:

{"array": []}