API docs by Redocly

FastAPI (0.1.0)

Download OpenAPI specification:Download

Authentication

Config

Responses

Response samples

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

Login

Login a user

Request Body schema: application/json
plugin
string (Plugin)
login
string (Login)
password
string (Password)
token
string (Token)

Responses

Request samples

Content type
application/json
{
  • "plugin": "string",
  • "login": "string",
  • "password": "string",
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "login": "string",
  • "token": "string",
  • "permissions": [
    ]
}

Options

Get Ui Options

Get the available UI database options

Authorizations:
HTTPBearer

Responses

Response samples

Content type
application/json
{
  • "motd": "",
  • "beamLineGroups": [ ],
  • "enableShipping": false,
  • "enableReprocessing": false
}

Get Options

Get the available database options

Authorizations:
HTTPBearer

Responses

Response samples

Content type
application/json
{
  • "motd": "",
  • "beamLineGroups": [ ],
  • "enableShipping": false,
  • "enableReprocessing": false,
  • "query_debug": false,
  • "create_person_on_missing": false
}

Update Options

Update the database options

Authorizations:
HTTPBearer
Request Body schema: application/json
motd
string (Message of the Day)
Default: ""

Displayed at the top of the UI

Array of objects (Beamline Groups)
Default: []
enableShipping
boolean (Enable Shipping)
Default: false
enableReprocessing
boolean (Enable Reprocessing)
Default: false
query_debug
boolean (Query Debugging)
Default: false

Enable query debugging

create_person_on_missing
boolean (Create Missing Login)
Default: false

Automatically create a Person entry if the login is missing from the database. (!) Warning modifies the database

Responses

Request samples

Content type
application/json
{
  • "motd": "",
  • "beamLineGroups": [ ],
  • "enableShipping": false,
  • "enableReprocessing": false,
  • "query_debug": false,
  • "create_person_on_missing": false
}

Response samples

Content type
application/json
{
  • "motd": "",
  • "beamLineGroups": [ ],
  • "enableShipping": false,
  • "enableReprocessing": false,
  • "query_debug": false,
  • "create_person_on_missing": false
}

Current User

Current User

Authorizations:
HTTPBearer

Responses

Response samples

Content type
application/json
{
  • "givenName": "string",
  • "familyName": "string",
  • "login": "string",
  • "Permissions": [
    ],
  • "personId": 0,
  • "beamLineGroups": [
    ],
  • "beamLines": [
    ]
}

Sign Url

Sign a url with a one time token

Authorizations:
HTTPBearer
Request Body schema: application/json
validity
required
string (Validity)

The url to sign

token
string (Token)

Responses

Request samples

Content type
application/json
{
  • "validity": "string",
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "validity": "string",
  • "token": "string"
}

Proposals

Get Proposals

Get a list of proposals

Authorizations:
HTTPBearer
query Parameters
search
string (Search)

Search string to filter by

skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

Responses

Response samples

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

Get Proposal

Get a proposal

Authorizations:
HTTPBearer
path Parameters
proposal
required
string (Proposal)

Responses

Response samples

Content type
application/json
{
  • "proposalCode": "string",
  • "proposalNumber": "string",
  • "proposal": "string",
  • "title": "string",
  • "state": "Open",
  • "_metadata": {
    },
  • "proposalId": 0
}

Lab Contacts

Get Lab Contacts

Get a list of lab contacts

Authorizations:
HTTPBearer
query Parameters
proposal
string (Proposal) ^(\w|-)+\d+$

Proposal name to filter by

skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

Responses

Response samples

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

Create Lab Contact

Create a new lab contact

Authorizations:
HTTPBearer
Request Body schema: application/json
proposalId
required
integer (Proposalid)
cardName
required
string (Card Name)

The name for this lab contact

defaultCourrierCompany
string or null (Courrier Company)
courierAccount
string or null (Account No.)
billingReference
string or null (Billing Reference)
dewarAvgCustomsValue
integer (Avg Customs Value)
dewarAvgTransportValue
integer (Avg Transport Value)
required
object (Person)

Responses

Request samples

Content type
application/json
{
  • "proposalId": 0,
  • "cardName": "string",
  • "defaultCourrierCompany": "string",
  • "courierAccount": "string",
  • "billingReference": "string",
  • "dewarAvgCustomsValue": 0,
  • "dewarAvgTransportValue": 0,
  • "Person": {
    }
}

Response samples

Content type
application/json
{
  • "proposalId": 0,
  • "cardName": "string",
  • "defaultCourrierCompany": "string",
  • "courierAccount": "string",
  • "billingReference": "string",
  • "dewarAvgCustomsValue": 0,
  • "dewarAvgTransportValue": 0,
  • "Person": {
    },
  • "labContactId": 0,
  • "personId": 0,
  • "recordTimeStamp": "2019-08-24T14:15:22Z"
}

Get Lab Contact

Get a lab contact

Authorizations:
HTTPBearer
path Parameters
labContactId
required
integer (Labcontactid)

Responses

Response samples

Content type
application/json
{
  • "proposalId": 0,
  • "cardName": "string",
  • "defaultCourrierCompany": "string",
  • "courierAccount": "string",
  • "billingReference": "string",
  • "dewarAvgCustomsValue": 0,
  • "dewarAvgTransportValue": 0,
  • "Person": {
    },
  • "labContactId": 0,
  • "personId": 0,
  • "recordTimeStamp": "2019-08-24T14:15:22Z"
}

Update Lab Contact

Update a Lab Contact

Authorizations:
HTTPBearer
path Parameters
labContactId
required
integer (Labcontactid)
Request Body schema: application/json
cardName
string (Cardname)
defaultCourrierCompany
string (Defaultcourriercompany)
courierAccount
string (Courieraccount)
billingReference
string (Billingreference)
dewarAvgCustomsValue
integer (Dewaravgcustomsvalue)
dewarAvgTransportValue
integer (Dewaravgtransportvalue)
object (PersonCreateOptional)

Responses

Request samples

Content type
application/json
{
  • "cardName": "string",
  • "defaultCourrierCompany": "string",
  • "courierAccount": "string",
  • "billingReference": "string",
  • "dewarAvgCustomsValue": 0,
  • "dewarAvgTransportValue": 0,
  • "Person": {
    }
}

Response samples

Content type
application/json
{
  • "proposalId": 0,
  • "cardName": "string",
  • "defaultCourrierCompany": "string",
  • "courierAccount": "string",
  • "billingReference": "string",
  • "dewarAvgCustomsValue": 0,
  • "dewarAvgTransportValue": 0,
  • "Person": {
    },
  • "labContactId": 0,
  • "personId": 0,
  • "recordTimeStamp": "2019-08-24T14:15:22Z"
}

Shipping

Get Shippings

Get a list of shipments

Authorizations:
HTTPBearer
query Parameters
proposal
string (Proposal) ^(\w|-)+\d+$

Proposal name to filter by

skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

Responses

Response samples

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

Create Shipping

Create a new shipment

Authorizations:
HTTPBearer
Request Body schema: application/json
proposalId
required
integer (Proposalid)
shippingName
required
string (Name)
sendingLabContactId
required
integer (Sending Lab Contact)
returnLabContactId
required
integer (Return Lab Contact)
safetyLevel
string (Safety Level)
Default: "GREEN"
Enum: "GREEN" "YELLOW" "RED"

An enumeration.

comments
string (Comments)

Responses

Request samples

Content type
application/json
{
  • "proposalId": 0,
  • "shippingName": "string",
  • "sendingLabContactId": 0,
  • "returnLabContactId": 0,
  • "safetyLevel": "GREEN",
  • "comments": "string"
}

Response samples

Content type
application/json
{
  • "proposalId": 0,
  • "shippingName": "string",
  • "sendingLabContactId": 0,
  • "returnLabContactId": 0,
  • "safetyLevel": "GREEN",
  • "comments": "string",
  • "shippingId": 0,
  • "bltimeStamp": "2019-08-24T14:15:22Z",
  • "_metadata": {
    },
  • "LabContact": {
    },
  • "LabContact1": {
    }
}

Get Shipping

Get a shipment

Authorizations:
HTTPBearer
path Parameters
shippingId
required
integer (Shippingid)

Responses

Response samples

Content type
application/json
{
  • "proposalId": 0,
  • "shippingName": "string",
  • "sendingLabContactId": 0,
  • "returnLabContactId": 0,
  • "safetyLevel": "GREEN",
  • "comments": "string",
  • "shippingId": 0,
  • "bltimeStamp": "2019-08-24T14:15:22Z",
  • "_metadata": {
    },
  • "LabContact": {
    },
  • "LabContact1": {
    }
}

Update Shipping

Update a Shipment

Authorizations:
HTTPBearer
path Parameters
shippingId
required
integer (Shippingid)
Request Body schema: application/json
proposalId
integer (Proposalid)
shippingName
string (Shippingname)
sendingLabContactId
integer (Sendinglabcontactid)
returnLabContactId
integer (Returnlabcontactid)
safetyLevel
string (SafetyLevelEnum)
Enum: "GREEN" "YELLOW" "RED"

An enumeration.

comments
string (Comments)

Responses

Request samples

Content type
application/json
{
  • "proposalId": 0,
  • "shippingName": "string",
  • "sendingLabContactId": 0,
  • "returnLabContactId": 0,
  • "safetyLevel": "GREEN",
  • "comments": "string"
}

Response samples

Content type
application/json
{
  • "proposalId": 0,
  • "shippingName": "string",
  • "sendingLabContactId": 0,
  • "returnLabContactId": 0,
  • "safetyLevel": "GREEN",
  • "comments": "string",
  • "shippingId": 0,
  • "bltimeStamp": "2019-08-24T14:15:22Z",
  • "_metadata": {
    },
  • "LabContact": {
    },
  • "LabContact1": {
    }
}

Samples

Get Subsamples

Get a list of sub samples

Authorizations:
HTTPBearer
query Parameters
skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

blSampleId
integer (Blsampleid)

Sample id to filter by

proteinId
integer (Proteinid)

Protein id to filter by

proposal
string (Proposal) ^(\w|-)+\d+$

Proposal name to filter by

containerId
integer (Containerid)

Container id to filter by

order_by
any (SubSampleOrder)
Enum: "blSubSampleId" "datacollections" "type"

Field to order by

order
string (Order)
Enum: "asc" "desc"

Order direction

Responses

Response samples

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

Get Subsample

Get a sub sample

Authorizations:
HTTPBearer
path Parameters
blSubSampleId
required
integer (Blsubsampleid)

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "comments": "string",
  • "blSampleId": 0,
  • "_metadata": {
    },
  • "blSubSampleId": 0,
  • "extraMetadata": { },
  • "BLSample": {
    },
  • "Position1": {
    },
  • "Position2": {
    }
}

Get Sample Images

Get a list of sample images

Authorizations:
HTTPBearer
query Parameters
skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

blSampleId
integer (Blsampleid)

Sample id to filter by

Responses

Response samples

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

Get Sample Image

Get a sample image

Authorizations:
HTTPBearer
path Parameters
blSampleImageId
required
integer (Blsampleimageid)

Responses

Response samples

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

Get Samples

Get a list of samples

Authorizations:
HTTPBearer
query Parameters
status
any (SampleStatus)
Enum: "Sample Action" "Data Collected" "Strategy" "Auto Integrated" "Processed"

An enumeration.

skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

search
string (Search)

Search string to filter by

proteinId
integer (Proteinid)

Protein id to filter by

proposal
string (Proposal) ^(\w|-)+\d+$

Proposal name to filter by

containerId
integer (Containerid)

Container id to filter by

beamLineName
string (Beamlinename)

Beamline name to filter by

order_by
any (SampleOrder)
Enum: "blSampleId" "name" "location" "datacollections"

Field to order by

order
string (Order)
Enum: "asc" "desc"

Order direction

Responses

Response samples

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

Create Sample

Create a new sample

Authorizations:
HTTPBearer
Request Body schema: application/json
name
required
string (Name)
comments
string or null (Comments)
location
integer (Location)

Location in container

containerId
integer (Containerid)
required
object (SampleCrystalCreate)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "comments": "string",
  • "location": 0,
  • "containerId": 0,
  • "Crystal": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "comments": "string",
  • "location": 0,
  • "containerId": 0,
  • "Crystal": {
    },
  • "blSampleId": 0,
  • "extraMetadata": { },
  • "Container": {
    },
  • "_metadata": {
    }
}

Get Sample

Get a sample

Authorizations:
HTTPBearer
path Parameters
blSampleId
required
integer (Blsampleid)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "comments": "string",
  • "location": 0,
  • "containerId": 0,
  • "Crystal": {
    },
  • "blSampleId": 0,
  • "extraMetadata": { },
  • "Container": {
    },
  • "_metadata": {
    }
}

Update Sample

Update a BLSample

Authorizations:
HTTPBearer
path Parameters
blSampleId
required
integer (Blsampleid)
Request Body schema: application/json
name
string (Name)
comments
string (Comments)
location
integer (Location)
object (SampleCrystalCreateOptional)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "comments": "string",
  • "location": 0,
  • "Crystal": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "comments": "string",
  • "location": 0,
  • "containerId": 0,
  • "Crystal": {
    },
  • "blSampleId": 0,
  • "extraMetadata": { },
  • "Container": {
    },
  • "_metadata": {
    }
}

Stats

Get Breakdown

Get stats breakdown for a session or run

Authorizations:
HTTPBearer
query Parameters
beamLineName
string (Beamlinename)

Beamline name to filter by

session
string (Session) ^(\w|-)+\d+-\d+$

Session name to filter by

sessionId
integer (Sessionid)

Session id to filter by

runId
string (Runid)

Run id filter by

Responses

Response samples

Content type
application/json
{
  • "overview": {
    },
  • "history": [
    ],
  • "plottables": {
    }
}

Get Times

Get total times for a session, proposal, or run

Authorizations:
HTTPBearer
query Parameters
beamLineName
string (Beamlinename)

Beamline name to filter by

session
string (Session) ^(\w|-)+\d+-\d+$

Session name to filter by

sessionId
integer (Sessionid)

Session id to filter by

proposal
string (Proposal) ^(\w|-)+\d+$

Proposal name to filter by

runId
string (Runid)

Run id filter by

Responses

Response samples

Content type
application/json
{
  • "average": {
    },
  • "sessions": [
    ]
}

Get Errors

Get the errors for a session or run

Authorizations:
HTTPBearer
query Parameters
beamLineName
string (Beamlinename)

Beamline name to filter by

session
string (Session) ^(\w|-)+\d+-\d+$

Session name to filter by

sessionId
integer (Sessionid)

Session id to filter by

runId
string (Runid)

Run id filter by

Responses

Response samples

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

Get Hourlies

Get the hourly stats for a session or run

Authorizations:
HTTPBearer
query Parameters
beamLineName
string (Beamlinename)

Beamline name to filter by

session
string (Session) ^(\w|-)+\d+-\d+$

Session name to filter by

sessionId
integer (Sessionid)

Session id to filter by

proposal
string (Proposal) ^(\w|-)+\d+$

Proposal name to filter by

runId
string (Runid)

Run id filter by

Responses

Response samples

Content type
application/json
{
  • "datacollections": {
    },
  • "loaded": {
    }
}

Get Parameter Histogram

Get histogram of parameters for a session or run

Authorizations:
HTTPBearer
query Parameters
parameter
string (Parameter)
Default: "energy"
beamLineName
string (Beamlinename)

Beamline name to filter by

session
string (Session) ^(\w|-)+\d+-\d+$

Session name to filter by

sessionId
integer (Sessionid)

Session id to filter by

runId
string (Runid)

Run id filter by

Responses

Response samples

Content type
application/json
{
  • "parameter": "string",
  • "unit": "string",
  • "beamLines": [
    ]
}

Get Datacollection Times

Get histogram of datacollection times for a session or run

Authorizations:
HTTPBearer
query Parameters
beamLineName
string (Beamlinename)

Beamline name to filter by

session
string (Session) ^(\w|-)+\d+-\d+$

Session name to filter by

sessionId
integer (Sessionid)

Session id to filter by

runId
string (Runid)

Run id filter by

Responses

Response samples

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

Get Runs

Get a list of runs

Authorizations:
HTTPBearer
query Parameters
skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

Responses

Response samples

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

Sessions

Get Sessions

Get a list of sessions

Authorizations:
HTTPBearer
query Parameters
beamLineGroup
string (Beamlinegroup)

Show sessions for a beamLineGroup

scheduled
boolean (Scheduled)

Get scheduled sessions only

upcoming
boolean (Upcoming)
Default: false

Get the upcoming sessions

previous
boolean (Previous)
Default: false

Get the recently finished sessions

sessionType
any (Sessiontype)

Filter by session type, i.e. commissioning, remote

proposal
string (Proposal) ^(\w|-)+\d+$

Proposal name to filter by

beamLineName
string (Beamlinename)

Beamline name to filter by

month
string (Month) ^\d\d?$

Month filter by

year
string (Year) ^\d\d\d\d$

Year filter by

skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

Responses

Response samples

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

Get Sessions For Beamline Group

Get a list of sessions for a beamline group Displays one session per beamline

Authorizations:
HTTPBearer
query Parameters
beamLineGroup
string (Beamlinegroup)

Beamline group to display session for

upcoming
boolean (Upcoming)
Default: false

Get the upcoming sessions

previous
boolean (Previous)
Default: false

Get the recently finished sessions

sessionType
any (Sessiontype)

Filter by session type, i.e. commissioning, remote

Responses

Response samples

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

Get Session

Get a session

Authorizations:
HTTPBearer
path Parameters
sessionId
required
integer (Sessionid)

Responses

Response samples

Content type
application/json
{
  • "sessionId": 0,
  • "proposalId": 0,
  • "session": "string",
  • "proposal": "string",
  • "BeamLineSetup": {
    },
  • "visit_number": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "beamLineName": "string",
  • "beamLineOperator": "string",
  • "scheduled": true,
  • "comments": "string",
  • "nbReimbDewars": 0,
  • "_metadata": {
    }
}

Data Collections

Get Datacollection Diffraction Image

Get a data collection diffraction image

Authorizations:
HTTPBearer
path Parameters
dataCollectionId
required
integer (Datacollectionid)
query Parameters
snapshot
boolean (Snapshot)
Default: false

Get snapshot image

Responses

Response samples

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

Get Datacollection Anaylsis Image

Get a data collection per image analysis image

Authorizations:
HTTPBearer
path Parameters
dataCollectionId
required
integer (Datacollectionid)

Responses

Response samples

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

Get Robotaction Image

Get a robot (sample) action snapshot

Authorizations:
HTTPBearer
path Parameters
robotActionId
required
integer (Robotactionid)
query Parameters
snapshot
boolean (Snapshot)
Default: false

Get snapshot image

after
boolean (After)
Default: false

Get after image

Responses

Response samples

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

Get Datacollection Image

Get a data collection image

Authorizations:
HTTPBearer
path Parameters
dataCollectionId
required
integer (Datacollectionid)
query Parameters
imageId
integer (Imageid) [ 1 .. 4 ]
Default: 1

Image 1-4 to return

snapshot
boolean (Snapshot)
Default: false

Get snapshot image

Responses

Response samples

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

Get Datacollection Attachments

Get a list of data collection attachments

Authorizations:
HTTPBearer
query Parameters
skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

dataCollectionId
integer (Datacollectionid)

Data collection id to filter by

dataCollectionGroupId
integer (Datacollectiongroupid)

Data collection group id to filter by

Responses

Response samples

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

Get Datacollection Attachment

Get a data collection attachment

Authorizations:
HTTPBearer
path Parameters
dataCollectionFileAttachmentId
required
integer (Datacollectionfileattachmentid)

Responses

Response samples

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

Get Per Image Analysis

Get a list of per image/point analysis

Authorizations:
HTTPBearer
query Parameters
skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

dataCollectionId
integer (Datacollectionid)

Data collection id to filter by

dataCollectionGroupId
integer (Datacollectiongroupid)

Data collection group id to filter by

Responses

Response samples

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

Get Workflow Steps

Get a list of workflow steps

Authorizations:
HTTPBearer
query Parameters
workflowId
integer (Workflow id)
workflowStepId
integer (Workflow step id)
skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

Responses

Response samples

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

Get Workflow Step Attachment

Get a workflow step attachment

Authorizations:
HTTPBearer
path Parameters
workflowStepId
required
integer (Workflowstepid)
query Parameters
attachmentType
required
string (WorkflowStepAttachment)
Enum: "imageResultFilePath" "resultFilePath"

An enumeration.

Responses

Response samples

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

Processing Status and Results

Get Processing Statuses

Get processing statuses for a group of data collections

Authorizations:
HTTPBearer
query Parameters
dataCollectionIds
string <json-string> (List of data collection ids (JSON encoded))
Default: ""

Responses

Response samples

Content type
application/json
{
  • "statuses": {
    }
}

Get Screening Results

Get a list of screening results from Screening

Authorizations:
HTTPBearer
query Parameters
dataCollectionId
integer (Datacollectionid)

Data collection id to filter by

skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

Responses

Response samples

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

Get Processing Results

Get a list of processing results from ProcessingJob

Authorizations:
HTTPBearer
query Parameters
dataCollectionId
integer (Datacollectionid)

Data collection id to filter by

skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

Responses

Response samples

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

Get Auto Integration Results

Get a list of auto-integration results from AutoProcIntegration

Authorizations:
HTTPBearer
query Parameters
dataCollectionId
integer (Datacollectionid)

Data collection id to filter by

skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

Responses

Response samples

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

Get Processing Messages

Get a list of processing messages

Authorizations:
HTTPBearer
query Parameters
autoProcProgramMessageId
integer (Autoprocprogrammessageid)
dataCollectionId
integer (Datacollectionid)

Data collection id to filter by

skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

Responses

Response samples

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

Get Processing Messages Status

Get the processing messages status

Authorizations:
HTTPBearer
query Parameters
dataCollectionIds
string <json-string> (List of data collection ids (JSON encoded))
Default: ""

Responses

Response samples

Content type
application/json
{
  • "statuses": {
    }
}

Get Processing Attachments

Get a list of auto processing attachments

Authorizations:
HTTPBearer
query Parameters
autoProcProgramId
integer (Autoprocprogramid)
autoProcProgramAttachmentId
integer (Autoprocprogramattachmentid)
skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

Responses

Response samples

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

Get Processing Attachment

Get an auto processing attachment

Authorizations:
HTTPBearer
path Parameters
autoProcProgramAttachmentId
required
integer (Autoprocprogramattachmentid)

Responses

Response samples

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

Mapping

Get Map Rois

Get a list of map rois

Authorizations:
HTTPBearer
query Parameters
xrfFluorescenceMappingROIId
integer (xrfFluorescenceMapping ROI id)
blSampleId
integer (Blsampleid)

Sample id to filter by

skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

Responses

Response samples

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

Add Map Roi

Add a new map roi

Authorizations:
HTTPBearer
Request Body schema: application/json
element
required
string (Element)
edge
required
string (Edge)
startEnergy
required
number (Start Energy)
endEnergy
required
number (End Energy)
blSampleId
required
integer (Blsampleid)

Responses

Request samples

Content type
application/json
{
  • "element": "string",
  • "edge": "string",
  • "startEnergy": 0,
  • "endEnergy": 0,
  • "blSampleId": 0
}

Response samples

Content type
application/json
{
  • "xrfFluorescenceMappingROIId": 0,
  • "element": "string",
  • "edge": "string",
  • "scalar": "string",
  • "startEnergy": 0,
  • "endEnergy": 0,
  • "_metadata": {
    }
}

Delete Map Roi

Delete a map ROI

Authorizations:
HTTPBearer
path Parameters
xrfFluorescenceMappingROIId
required
integer (Xrffluorescencemappingroiid)

Responses

Response samples

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

Update Map Roi

Update a Map

Authorizations:
HTTPBearer
path Parameters
xrfFluorescenceMappingROIId
required
integer (Xrffluorescencemappingroiid)
Request Body schema: application/json
element
string (Element)
edge
string (Edge)
startEnergy
number (Startenergy)
endEnergy
number (Endenergy)

Responses

Request samples

Content type
application/json
{
  • "element": "string",
  • "edge": "string",
  • "startEnergy": 0,
  • "endEnergy": 0
}

Response samples

Content type
application/json
{
  • "xrfFluorescenceMappingROIId": 0,
  • "element": "string",
  • "edge": "string",
  • "scalar": "string",
  • "startEnergy": 0,
  • "endEnergy": 0,
  • "_metadata": {
    }
}

Get Composite Maps

Get a list of composite maps

Authorizations:
HTTPBearer
query Parameters
xfeFluorescenceCompositeId
integer (XfeFluorescenceCompositeId id)
xrfFluorescenceMappingId
integer (XrfFluorescenceMapping id)
dataCollectionId
integer (Datacollectionid)

Data collection id to filter by

dataCollectionGroupId
integer (Datacollectiongroupid)

Data collection group id to filter by

blSampleId
integer (Blsampleid)

Sample id to filter by

blSubSampleId
integer (Blsubsampleid)

Sub sample id to filter by

skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

Responses

Response samples

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

Create Composite Map

Create a new composite map

Authorizations:
HTTPBearer
Request Body schema: application/json
r
required
integer (R)
g
required
integer (G)
b
required
integer (B)
rOpacity
number (Ropacity)
Default: 1
gOpacity
number (Gopacity)
Default: 1
bOpacity
number (Bopacity)
Default: 1
opacity
number (Opacity)
Default: 1

Responses

Request samples

Content type
application/json
{
  • "r": 0,
  • "g": 0,
  • "b": 0,
  • "rOpacity": 1,
  • "gOpacity": 1,
  • "bOpacity": 1,
  • "opacity": 1
}

Response samples

Content type
application/json
{
  • "r": 0,
  • "g": 0,
  • "b": 0,
  • "rOpacity": 1,
  • "gOpacity": 1,
  • "bOpacity": 1,
  • "opacity": 1,
  • "xfeFluorescenceCompositeId": 0,
  • "_metadata": {
    },
  • "XRFFluorescenceMapping": {
    }
}

Get Composite Map

Get a composite map in image format

Authorizations:
HTTPBearer
path Parameters
xfeFluorescenceCompositeId
required
integer (Xfefluorescencecompositeid)

Responses

Response samples

Content type
application/json
null

Delete Composite Map

Delete a Composite map

Authorizations:
HTTPBearer
path Parameters
xfeFluorescenceCompositeId
required
integer (Xfefluorescencecompositeid)

Responses

Response samples

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

Update Composite Map

Update a Composite map

Authorizations:
HTTPBearer
path Parameters
xfeFluorescenceCompositeId
required
integer (Xfefluorescencecompositeid)
Request Body schema: application/json
rOpacity
number (Ropacity)
gOpacity
number (Gopacity)
bOpacity
number (Bopacity)
opacity
number (Opacity)

Responses

Request samples

Content type
application/json
{
  • "rOpacity": 0,
  • "gOpacity": 0,
  • "bOpacity": 0,
  • "opacity": 0
}

Response samples

Content type
application/json
{
  • "r": 0,
  • "g": 0,
  • "b": 0,
  • "rOpacity": 1,
  • "gOpacity": 1,
  • "bOpacity": 1,
  • "opacity": 1,
  • "xfeFluorescenceCompositeId": 0,
  • "_metadata": {
    },
  • "XRFFluorescenceMapping": {
    }
}

Add Scalar Map

Create a new scalar map

Authorizations:
HTTPBearer
Request Body schema: application/json
dataCollectionId
required
integer (Datacollectionid)
scalar
required
string (Scalar Name)

Responses

Request samples

Content type
application/json
{
  • "dataCollectionId": 0,
  • "scalar": "string"
}

Response samples

Content type
application/json
{
  • "colourMap": "string",
  • "opacity": 0,
  • "scale": "string",
  • "min": 0,
  • "max": 0,
  • "xrfFluorescenceMappingId": 0,
  • "points": 0,
  • "dataFormat": "string",
  • "_metadata": {
    },
  • "GridInfo": {
    },
  • "XRFFluorescenceMappingROI": {
    }
}

Regenerate Maps

Regenerate maps for a sample

Authorizations:
HTTPBearer
Request Body schema: application/json
blSampleId
required
integer (Blsampleid)
dataCollectionId
integer (Datacollectionid)
ev_per_bin
number (Ev Per Bin)
Default: 5

eV per bin for MCA

ev_offset
number (Ev Offset)
Default: 0

eV zero offset for MCA

Responses

Request samples

Content type
application/json
{
  • "blSampleId": 0,
  • "dataCollectionId": 0,
  • "ev_per_bin": 5,
  • "ev_offset": 0
}

Response samples

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

Get Map

Get a map in image format

Authorizations:
HTTPBearer
path Parameters
xrfFluorescenceMappingId
required
integer (Xrffluorescencemappingid)

Responses

Response samples

Content type
application/json
null

Delete Map

Delete a map

Authorizations:
HTTPBearer
path Parameters
xrfFluorescenceMappingId
required
integer (Xrffluorescencemappingid)

Responses

Response samples

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

Update Map

Update a Map

Authorizations:
HTTPBearer
path Parameters
xrfFluorescenceMappingId
required
integer (Xrffluorescencemappingid)
Request Body schema: application/json
colourMap
string (Colourmap)
opacity
number (Opacity)
scale
string (Scale)
min
number (Min)
max
number (Max)

Responses

Request samples

Content type
application/json
{
  • "colourMap": "string",
  • "opacity": 0,
  • "scale": "string",
  • "min": 0,
  • "max": 0
}

Response samples

Content type
application/json
{
  • "colourMap": "string",
  • "opacity": 0,
  • "scale": "string",
  • "min": 0,
  • "max": 0,
  • "xrfFluorescenceMappingId": 0,
  • "points": 0,
  • "dataFormat": "string",
  • "_metadata": {
    },
  • "GridInfo": {
    },
  • "XRFFluorescenceMappingROI": {
    }
}

Get Maps

Get a list of maps

Authorizations:
HTTPBearer
query Parameters
xrfFluorescenceMappingId
integer (XrfFluorescenceMapping id)
dataCollectionId
integer (Datacollectionid)

Data collection id to filter by

dataCollectionGroupId
integer (Datacollectiongroupid)

Data collection group id to filter by

blSampleId
integer (Blsampleid)

Sample id to filter by

blSubSampleId
integer (Blsubsampleid)

Sub sample id to filter by

skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

Responses

Response samples

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

Get Map Histogram

Get a map histogram

Authorizations:
HTTPBearer
path Parameters
xrfFluorescenceMappingId
required
integer (Xrffluorescencemappingid)

Responses

Response samples

Content type
application/json
{
  • "xrfFluorescenceMappingId": 0,
  • "hist": [
    ],
  • "bins": [
    ],
  • "width": [
    ]
}

Get Map Pixel Value

Get a map histogram

Authorizations:
HTTPBearer
path Parameters
xrfFluorescenceMappingId
required
integer (Xrffluorescencemappingid)
query Parameters
x
integer (Y position)
y
integer (Y position)

Responses

Response samples

Content type
application/json
{
  • "xrfFluorescenceMappingId": 0,
  • "x": 0,
  • "y": 0,
  • "value": 0
}

Containers

Get Queued Containers

Get a list of queued containers

Authorizations:
HTTPBearer
query Parameters
proposal
string (Proposal) ^(\w|-)+\d+$

Proposal name to filter by

beamLineName
string (Beamlinename)

Beamline name to filter by

skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

Responses

Response samples

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

Update Queued Container

Update a queued container

Authorizations:
HTTPBearer
path Parameters
containerQueueId
required
integer (Containerqueueid)
Request Body schema: application/json
completed
boolean (Completed)

Responses

Request samples

Content type
application/json
{
  • "completed": true
}

Response samples

Content type
application/json
{
  • "containerQueueId": 0,
  • "createdTimeStamp": "2019-08-24T14:15:22Z",
  • "completedTimeStamp": "2019-08-24T14:15:22Z",
  • "Container": {
    },
  • "_metadata": {
    }
}

Get Queued Subsamples

Get a list of queued samples and sub samples

Authorizations:
HTTPBearer
query Parameters
status
any (QueuedSampleStatus)
Enum: "Queued" "Completed" "Failed"

An enumeration.

proposal
string (Proposal) ^(\w|-)+\d+$

Proposal name to filter by

blSampleId
integer (Blsampleid)

Sample id to filter by

containerId
integer (Containerid)

Container id to filter by

beamLineName
string (Beamlinename)

Beamline name to filter by

order_by
any (QueuedSampleOrder)
Enum: "containerQueueSampleId" "started" "finished"

Field to order by

order
string (Order)
Enum: "asc" "desc"

Order direction

skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

Responses

Response samples

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

Delete Queued Sample

Delete a queued sample

Authorizations:
HTTPBearer
path Parameters
containerQueueSampleId
required
integer (Containerqueuesampleid)

Responses

Response samples

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

Get Container History

Get a list of container history

Authorizations:
HTTPBearer
query Parameters
proposal
string (Proposal) ^(\w|-)+\d+$

Proposal name to filter by

containerId
integer (Containerid)

Container id to filter by

skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

Responses

Response samples

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

Get Containers

Get a list of containers

Authorizations:
HTTPBearer
query Parameters
assigned
boolean (Assigned)
Default: false

List containers assigned on a beamline

proposal
string (Proposal) ^(\w|-)+\d+$

Proposal name to filter by

beamLineName
string (Beamlinename)

Beamline name to filter by

dewarId
integer (Dewarid)

Dewar id to filter by

search
string (Search)

Search string to filter by

skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

Responses

Response samples

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

Create Container

Create a new container

Authorizations:
HTTPBearer
Request Body schema: application/json
code
required
string (Name)
dewarId
required
integer (Dewarid)
containerType
required
string (Container Type)
capacity
integer (Capacity)
containerStatus
string (Status)
sampleChangerLocation
string (Sample Changer Location)

Position in sample change

beamlineLocation
string (Beamline Location)

Beamline if container is assigned

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "dewarId": 0,
  • "containerType": "string",
  • "capacity": 0,
  • "containerStatus": "string",
  • "sampleChangerLocation": "string",
  • "beamlineLocation": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "dewarId": 0,
  • "containerType": "string",
  • "capacity": 0,
  • "containerStatus": "string",
  • "sampleChangerLocation": "string",
  • "beamlineLocation": "string",
  • "containerId": 0,
  • "Dewar": {
    },
  • "_metadata": {
    }
}

Get Session Container

Get the default session container

Authorizations:
HTTPBearer
path Parameters
sessionId
required
integer (Sessionid)

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "dewarId": 0,
  • "containerType": "string",
  • "capacity": 0,
  • "containerStatus": "string",
  • "sampleChangerLocation": "string",
  • "beamlineLocation": "string",
  • "containerId": 0,
  • "Dewar": {
    },
  • "_metadata": {
    }
}

Get Container

Get a container

Authorizations:
HTTPBearer
path Parameters
containerId
required
integer (Containerid)

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "dewarId": 0,
  • "containerType": "string",
  • "capacity": 0,
  • "containerStatus": "string",
  • "sampleChangerLocation": "string",
  • "beamlineLocation": "string",
  • "containerId": 0,
  • "Dewar": {
    },
  • "_metadata": {
    }
}

Update Container

Update a Container

Authorizations:
HTTPBearer
path Parameters
containerId
required
integer (Containerid)
Request Body schema: application/json
code
string (Code)
dewarId
integer (Dewarid)
containerType
string (Containertype)
capacity
integer (Capacity)
containerStatus
string (Containerstatus)
sampleChangerLocation
string (Samplechangerlocation)
beamlineLocation
string (Beamlinelocation)

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "dewarId": 0,
  • "containerType": "string",
  • "capacity": 0,
  • "containerStatus": "string",
  • "sampleChangerLocation": "string",
  • "beamlineLocation": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "dewarId": 0,
  • "containerType": "string",
  • "capacity": 0,
  • "containerStatus": "string",
  • "sampleChangerLocation": "string",
  • "beamlineLocation": "string",
  • "containerId": 0,
  • "Dewar": {
    },
  • "_metadata": {
    }
}

People

Get Persons

Get a list of people

Authorizations:
HTTPBearer
query Parameters
userGroupId
integer (Usergroupid)
showAll
boolean (Showall)
Default: false
proposal
string (Proposal) ^(\w|-)+\d+$

Proposal name to filter by

sessionId
integer (Sessionid)

Session id to filter by

search
string (Search)

Search string to filter by

skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

Responses

Response samples

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

Proteins

Get Proteins

Get a list of proteins

Authorizations:
HTTPBearer
query Parameters
skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

proteinId
integer (Proteinid)

Protein id to filter by

proposal
string (Proposal) ^(\w|-)+\d+$

Proposal name to filter by

search
string (Search)

Search string to filter by

order_by
any (ProteinOrder)
Enum: "proteinId" "acronym" "name"

Field to order by

order
string (Order)
Enum: "asc" "desc"

Order direction

Responses

Response samples

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

Get Protein

Get a protein

Authorizations:
HTTPBearer
path Parameters
proteinId
required
integer (Proteinid)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "acronym": "string",
  • "proposalId": 0,
  • "sequence": "string",
  • "density": 0,
  • "molecularMass": 0,
  • "containmentLevel": "string",
  • "hazardGroup": "string",
  • "safetyLevel": "string",
  • "ComponentType": {
    },
  • "proteinId": 0,
  • "_metadata": {
    }
}

Update Protein

Update a Protein

Authorizations:
HTTPBearer
path Parameters
proteinId
required
integer (Proteinid)
Request Body schema: application/json
name
string (Name)
acronym
string (Acronym)
sequence
string (Sequence)
density
number (Density)
molecularMass
number (Molecularmass)
object (ComponentTypeOptional)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "acronym": "string",
  • "sequence": "string",
  • "density": 0,
  • "molecularMass": 0,
  • "ComponentType": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "acronym": "string",
  • "proposalId": 0,
  • "sequence": "string",
  • "density": 0,
  • "molecularMass": 0,
  • "containmentLevel": "string",
  • "hazardGroup": "string",
  • "safetyLevel": "string",
  • "ComponentType": {
    },
  • "proteinId": 0,
  • "_metadata": {
    }
}

Dewars

Get Dewars

Get a list of dewars

Authorizations:
HTTPBearer
query Parameters
shippingId
integer (Shippingid)

Shipping id to filter by

proposal
string (Proposal) ^(\w|-)+\d+$

Proposal name to filter by

skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

Responses

Response samples

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

Create Dewar

Create a new dewar

Authorizations:
HTTPBearer
Request Body schema: application/json
shippingId
required
integer (Shippingid)
code
required
string (Name)
dewarType
string (Dewartype)

Responses

Request samples

Content type
application/json
{
  • "shippingId": 0,
  • "code": "string",
  • "dewarType": "string"
}

Response samples

Content type
application/json
{
  • "shippingId": 0,
  • "code": "string",
  • "dewarType": "string",
  • "dewarId": 0,
  • "Shipping": {
    }
}

Get Dewar

Get a dewar

Authorizations:
HTTPBearer
path Parameters
dewarId
required
integer (Dewarid)

Responses

Response samples

Content type
application/json
{
  • "shippingId": 0,
  • "code": "string",
  • "dewarType": "string",
  • "dewarId": 0,
  • "Shipping": {
    }
}

Update Dewar

Update a Dewar

Authorizations:
HTTPBearer
path Parameters
dewarId
required
integer (Dewarid)
Request Body schema: application/json
code
string (Code)
dewarType
string (Dewartype)

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "dewarType": "string"
}

Response samples

Content type
application/json
{
  • "shippingId": 0,
  • "code": "string",
  • "dewarType": "string",
  • "dewarId": 0,
  • "Shipping": {
    }
}

Events

Get Events

Get a list of events

Authorizations:
HTTPBearer
query Parameters
blSubSampleType
string (SubSampleType)
Enum: "roi" "poi" "loi"

An enumeration.

status
string (EventStatus)
Enum: "success" "failed" "processed" "processerror"

An enumeration.

eventType
string (Eventtype)
skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

session
string (Session) ^(\w|-)+\d+-\d+$

Session name to filter by

sessionId
integer (Sessionid)

Session id to filter by

proposal
string (Proposal) ^(\w|-)+\d+$

Proposal name to filter by

proposalId
integer (Proposalid)

Proposal id to filter by

beamLineName
string (Beamlinename)

Beamline name to filter by

dataCollectionId
integer (Datacollectionid)

Data collection id to filter by

dataCollectionGroupId
integer (Datacollectiongroupid)

Data collection group id to filter by

blSampleId
integer (Blsampleid)

Sample id to filter by

blSubSampleId
integer (Blsubsampleid)

Sub sample id to filter by

proteinId
integer (Proteinid)

Protein id to filter by

Responses

Response samples

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

Get Event Types

Get a list of event types

Authorizations:
HTTPBearer
query Parameters
session
string (Session) ^(\w|-)+\d+-\d+$

Session name to filter by

sessionId
integer (Sessionid)

Session id to filter by

blSampleId
integer (Blsampleid)

Sample id to filter by

proteinId
integer (Proteinid)

Protein id to filter by

beamLineName
string (Beamlinename)

Beamline name to filter by

Responses

Response samples

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

Data

Get Image

Get raw image data

Authorizations:
HTTPBearer
query Parameters
imageNumber
required
integer (Imagenumber) > 0
dataCollectionId
integer (Datacollectionid)

Data collection id to filter by

Responses

Response samples

Content type
application/json
null

Get Image Header

Get image header

Authorizations:
HTTPBearer
query Parameters
imageNumber
required
integer (Imagenumber)
dataCollectionId
integer (Datacollectionid)

Data collection id to filter by

Responses

Response samples

Content type
application/json
null

Get Image Histogram

Get image histogram data

Authorizations:
HTTPBearer
query Parameters
imageNumber
required
integer (Imagenumber)
dataCollectionId
integer (Datacollectionid)

Data collection id to filter by

Responses

Response samples

Content type
application/json
{
  • "values": [
    ],
  • "bins": [
    ],
  • "shape": [
    ],
  • "max": 0
}

Get Attr

h5grove /attr/ endpoint handler

Authorizations:
HTTPBearer
query Parameters
path
string (Path)
Default: "/"
attr_keys
Array of strings (Attr Keys)
autoProcProgramAttachmentId
integer (AutoProcProgramAttachment id)
robotActionId
integer (RobotAction id)
dataCollectionId
integer (Datacollectionid)

Data collection id to filter by

Responses

Response samples

Content type
application/json
null

Get Data

h5grove /data/ endpoint handler

Authorizations:
HTTPBearer
query Parameters
path
string (Path)
Default: "/"
dtype
string (Dtype)
Default: "origin"
format
string (Format)
Default: "json"
flatten
boolean (Flatten)
Default: false
selection
any (Selection)
autoProcProgramAttachmentId
integer (AutoProcProgramAttachment id)
robotActionId
integer (RobotAction id)
dataCollectionId
integer (Datacollectionid)

Data collection id to filter by

Responses

Response samples

Content type
application/json
null

Get Meta

h5grove /meta/ endpoint handler

Authorizations:
HTTPBearer
query Parameters
path
string (Path)
Default: "/"
resolve_links
string (Resolve Links)
Default: "only_valid"
autoProcProgramAttachmentId
integer (AutoProcProgramAttachment id)
robotActionId
integer (RobotAction id)
dataCollectionId
integer (Datacollectionid)

Data collection id to filter by

Responses

Response samples

Content type
application/json
null

Get Stats

h5grove /stats/ endpoint handler

Authorizations:
HTTPBearer
query Parameters
path
string (Path)
Default: "/"
selection
any (Selection)
autoProcProgramAttachmentId
integer (AutoProcProgramAttachment id)
robotActionId
integer (RobotAction id)
dataCollectionId
integer (Datacollectionid)

Data collection id to filter by

Responses

Response samples

Content type
application/json
null

Admin

Get Activity

Get list of admin activity

Authorizations:
HTTPBearer
query Parameters
action_type
string (ActionType)
Enum: "db_options" "online"

An enumeration.

skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

Responses

Response samples

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

Get Groups

Get a list of UserGroups

Authorizations:
HTTPBearer
query Parameters
userGroupId
integer (Usergroupid)

UserGroup id to filter by

skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

search
string (Search)

Search string to filter by

Responses

Response samples

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

Add Group

Add a new UserGroup

Authorizations:
HTTPBearer
Request Body schema: application/json
name
required
string (Name)

The name of the group

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "name": "string",
  • "userGroupId": 0,
  • "_metadata": {
    }
}

Get Group

Get a UserGroups

Authorizations:
HTTPBearer
path Parameters
userGroupId
required
integer (Usergroupid)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "userGroupId": 0,
  • "_metadata": {
    }
}

Update Group

Update a UserGroup

Authorizations:
HTTPBearer
path Parameters
userGroupId
required
integer (Usergroupid)
Request Body schema: application/json
name
string (Name)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "name": "string",
  • "userGroupId": 0,
  • "_metadata": {
    }
}

Add Permission To Group

Add a Permission to a UserGroup

Authorizations:
HTTPBearer
path Parameters
userGroupId
required
integer (Usergroupid)
Request Body schema: application/json
permissionId
required
integer (Permission)

Responses

Request samples

Content type
application/json
{
  • "permissionId": 0
}

Response samples

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

Remove Permission From Group

Remove a Permission from a UserGroup

Authorizations:
HTTPBearer
path Parameters
userGroupId
required
integer (Usergroupid)
permissionId
required
integer (Permissionid)

Responses

Response samples

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

Add Person To Group

Add a Person to a UserGroup

Authorizations:
HTTPBearer
path Parameters
userGroupId
required
integer (Usergroupid)
Request Body schema: application/json
personId
required
integer (Person)

Responses

Request samples

Content type
application/json
{
  • "personId": 0
}

Response samples

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

Remove Person From Group

Remove a Person from a UserGroup

Authorizations:
HTTPBearer
path Parameters
userGroupId
required
integer (Usergroupid)
personId
required
integer (Personid)

Responses

Response samples

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

Get Permissions

Get a list of Permissions

Authorizations:
HTTPBearer
query Parameters
permissionId
integer (Permissionid)

Permission id to filter by

userGroupId
integer (Usergroupid)

UserGroup id to filter by

search
string (Search)

Search string to filter by

skip
integer (Skip) >= 0
Default: 0

Results to skip

limit
integer (Limit) > 0
Default: 25

Number of results to show

Responses

Response samples

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

Add Permission

Add a new Permission

Authorizations:
HTTPBearer
Request Body schema: application/json
type
required
string (Permission) <= 15 characters

The permission identifier

description
string (Description) <= 100 characters

Description of this permission

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "description": "string",
  • "permissionId": 0
}

Update Permission

Update a Permission

Authorizations:
HTTPBearer
path Parameters
permissionId
required
integer (Permissionid)
Request Body schema: application/json
type
string (Type) <= 15 characters
description
string (Description) <= 100 characters

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "description": "string",
  • "permissionId": 0
}