BdsApi
3.0.2
This is the Blacknest BDS API.
|
Functions | |
Error | validateUser (in String user, in String email) |
Checks the user given name or email. More... | |
Error | setUser (in String user, in String email) |
Sets user to given name or email. More... | |
Error | setUserReal () |
Sets user back to real user. More... | |
Error | getVersion (out String version, out String name) |
Gets the software version and server name. More... | |
Error | userGetFromId (in UInt32 id, out User user) |
Get user info given user ID. More... | |
Error | userGet (out User user) |
Get user info. More... | |
Error | userSet (in User user) |
Set user info. More... | |
Error | userGetGroups (out List< String > groups) |
Get list of groups the user belongs to. More... | |
Error | userGetOptions (out Dict< String > items) |
Get user options. More... | |
Error | userSetOptions (out Dict< String > items) |
Set user options. More... | |
Error | groupGetList (out List< Group > groups) |
Get list of Groups. More... | |
Error | networkGetList (out List< Network > networks) |
Get list of Networks. More... | |
Error | stationGetList (in Selection sel, out List< Station > stations) |
Get list of Stations. More... | |
Error | channelGetList (in Selection sel, out List< Channel > channels) |
Get list of Channels. More... | |
Error | sourceGetList (out List< Source > sources) |
Get list of Sources. More... | |
Error | sourcePriorityGetList (out List< SourcePriority > sourcePrioritys) |
Get list of SourcePriorities. More... | |
Error | dataFileGetList (in Selection sel, out List< DataFileInfo > dataFile) |
Get list of DataFiles. More... | |
Error | dataChannelGetList (in Selection sel, out List< DataChannel > dataChannel) |
Get list of DataChannels. More... | |
Error | channelInstrumentGetList (in Selection sel, out List< ChannelInstrument > channelInstruments) |
Get list of Instruments. More... | |
Error | digitiserGetList (in Selection sel, out List< Digitiser > digitisers) |
Get list of Digitisers. More... | |
Error | digitiserGet (in UInt32 id, out Digitiser digitiser) |
Get a Digitiser object given its ID. More... | |
Error | sensorGetList (in Selection sel, out List< Sensor > sensors) |
Get list of Sensors. More... | |
Error | sensorGet (in UInt32 id, out Sensor sensor) |
Get a Sensor object given its ID. More... | |
Error | calibrationGetList (in Selection sel, out List< Calibration > calibrations) |
Get list of Calibrations. More... | |
Error | responseGetList (in Selection sel, out List< Response > responses) |
Get list of Responces. More... | |
Error | locationGetList (in Selection sel, out List< Location > locations) |
Get list of Station Locations. More... | |
Error | eventGetList (in Selection sel, out List< Event > events) |
Get list of Events. More... | |
Error | specialChannelGetList (in Selection sel, out List< SpecialChannel > specialChannels) |
Get list of Special Channels. More... | |
Error | metadataGetChannelInfo (in Selection sel, out ChannelInfos channelInfos) |
Return the channel MetaData in structured form. More... | |
Error | metadataGetFormatted (in Selection sel, in String format, out Array< UInt8 > data) |
Return the channel MetaData in a particular format. More... | |
Error | getSelectionInfo (in SelectionGroup group, in Selection selectionIn, out SelectionInfo selectionInfo) |
Get information on possible selections. Use in GUI programs to list options available. More... | |
Error | getSelections (in SelectionGroup group, in Selection selectionIn, out Selection selectionOut) |
Get selection list. More... | |
Error | dataAvailability (in Selection selection, in UInt32 num, out Array< DataAvailChan > dataAvailChans) |
Return availability for data matching the given selection parameters. If num > 0 segment ito this number of fixed time segments. More... | |
Error | dataSearch (in Selection selection, out DataInfo dataInfo) |
Search for data matching the given selection parameters. More... | |
Error | dataGetChannelInfo (in DataInfo dataInfo, out ChannelInfos channelInfos) |
Return the channel MetaData in structured form. More... | |
Error | dataOpen (in DataInfo dataInfo, in String mode, in String format, in UInt32 flags, out DataHandle dataHandle) |
Open a data file. More... | |
Error | dataGetInfo (in DataHandle dataHandle, in UInt32 infoExtra, out DataInfo dataInfo) |
Get information on the data file. More... | |
Error | dataGetNotes (in DataHandle dataHandle, out List< Note > notes) |
Get notes on the data file. More... | |
Error | dataGetWarnings (in DataHandle dataHandle, out List< String > warnings) |
Get information on the data file. More... | |
Error | dataSeekBlock (in DataHandle dataHandle, in UInt32 channel, in UInt32 segment, in TimeStamp time, out UInt32 blockNumber) |
Searches for a data block matching the time given. More... | |
Error | dataGetBlock (in DataHandle dataHandle, in UInt32 channel, in UInt32 segment, in UInt32 blockNumber, out DataBlock data) |
Return a block of data. More... | |
Error | dataClose (in DataHandle dataHandle, in Error error, in Bool del) |
Close a file. More... | |
Error | dataFormattedRead (in DataHandle dataHandle, in UInt32 number, out Array< UInt8 > data) |
Read the raw data from the file. More... | |
Error | dataFormattedGetLength (in DataHandle dataHandle, out UInt64 length) |
Read the raw data from the file. More... | |
Error | dataRealtimeConfig (in Bool enable, in Selection sel) |
Configures the sending of real-time data blocks. More... | |
Error | dataRealtimeGet (in UInt32 numBlocks, out UInt32 numBlocksAvailable, out List< DataBlockChannel > dataBlocks) |
Returns the number of data blocks available and up to nymBlocks of these. More... | |
Error | noteGetList (in Selection sel, out List< Note > notes) |
Return a list of Notes. More... | |
Error | noteUpdate (in Bool append, in Note note, out UInt32 id) |
Add or update a Note. More... | |
Error | noteWriteDocument (in UInt32 id, in String format, in Array< UInt8 > data) |
Given a Note write a document associated with it. More... | |
Error | noteReadDocument (in UInt32 id, out String format, out Array< UInt8 > data) |
Read a document associated with a Note. More... | |
Error | logUpdate (in Bool append, in Log log, out UInt32 id) |
Add or update a Log item. More... | |
Error | logAppend (in String type, in UInt32 priority, in String subSystem, in String title, in String description) |
Append a log item. More... | |
Error | modeSet (in Mode mode, out Mode previousMode) |
Changes the system mode from Master to slave. More... | |
Error | modeSnapshotPause (in Bool on) |
Enables/disables backup synchronisation pause. More... | |
Error | clean (in CleanOptions cleanOptions) |
Cleans the system logs and Changes information. More... | |
Error | databaseBackup (out String ref) |
Backup the database. More... | |
Error | statisticsGet (out Dict< String > info) |
Get a list of system statistics. More... | |
Error | serverConfigurationGet (out Dict< String > items) |
Get server configuration parameters. More... | |
Error | dataFormatGetList (out List< DataFormat > formats) |
Get list of data formats. More... | |
Error | eventUpdate (in Bool append, in Event event, out UInt32 id) |
Add or update a Event entry. More... | |
Error | eventDelete (in UInt32 id) |
Delete a Event entry. More... | |
Error | dataSetInfo (in DataHandle dataHandle, in DataInfo dataInfo) |
Set the info when writing to a file. More... | |
Error | dataPutBlock (in DataHandle dataHandle, in DataBlock data) |
Send a block of data. More... | |
Error | userGetList (out List< User > users) |
Get list of Users. More... | |
Error | userUpdate (in Bool append, in User user, out UInt32 id) |
Update or append a user entry. More... | |
Error | userDelete (in UInt32 id) |
Delete a user entry. More... | |
Error | groupUpdate (in Bool append, in Group group, out UInt32 id) |
Update or append a group entry. More... | |
Error | groupDelete (in UInt32 id) |
Delete a group entry. More... | |
Error | accessGroupGetList (out List< AccessGroup > accessGroups) |
Get list of AccessGroups. More... | |
Error | accessGroupUpdate (in Bool append, in AccessGroup group, out UInt32 id) |
Update or append an AccessGroup entry. More... | |
Error | accessGroupDelete (in UInt32 id) |
Delete an AccessGroup entry. More... | |
Error | networkUpdate (in Bool append, in Network network, out UInt32 id) |
Add or update a Network entry. More... | |
Error | networkDelete (in UInt32 id) |
Delete a Network entry. More... | |
Error | stationUpdate (in Bool append, in Station station, out UInt32 id) |
Add or update a Station entry. More... | |
Error | stationDelete (in UInt32 id) |
Delete a Station entry. More... | |
Error | locationUpdate (in Bool append, in Location location, out UInt32 id) |
Add or update a Station Location entry. More... | |
Error | locationDelete (in UInt32 id) |
Delete a Station Location entry. More... | |
Error | channelGet (in UInt32 id, out Channel channel) |
Get a channel. More... | |
Error | channelUpdate (in Bool append, in Channel channel, out UInt32 id) |
Add or update a Channel entry. More... | |
Error | channelDelete (in UInt32 id) |
Delete a Channel entry. More... | |
Error | sourceUpdate (in Bool append, in Source source, out UInt32 id) |
Add or update a Source entry. More... | |
Error | sourceDelete (in UInt32 id) |
Delete a Source entry. More... | |
Error | sourcePriorityUpdate (in Bool append, in SourcePriority sourcePriority, out UInt32 id) |
Error | sourcePriorityDelete (in UInt32 id) |
Error | channelInstrumentUpdate (in Bool append, in ChannelInstrument channelInstrument, out UInt32 id) |
Add or update a Instrument entry. More... | |
Error | channelInstrumentDelete (in UInt32 id) |
Delete an Instrument entry. More... | |
Error | digitiserUpdate (in Bool append, in Digitiser digitiser, out UInt32 id) |
Add or update a Digitiser entry. More... | |
Error | digitiserDelete (in UInt32 id) |
Delete a Digitiser entry. More... | |
Error | sensorUpdate (in Bool append, in Sensor sensor, out UInt32 id) |
Add or update a Sensor entry. More... | |
Error | sensorDelete (in UInt32 id) |
Delete a Sensor entry. More... | |
Error | calibrationUpdate (in Bool append, in Calibration calibration, out UInt32 id) |
Add or update a Calibration entry. More... | |
Error | calibrationDelete (in UInt32 id) |
Delete a Calibration entry. More... | |
Error | responseUpdate (in Bool append, in Response response, out UInt32 id) |
Add or update a Response entry. More... | |
Error | responseDelete (in UInt32 id) |
Delete a Response entry. More... | |
Error | specialChannelUpdate (in Bool append, in SpecialChannel specialChannel, out UInt32 id) |
Add or update a SpecialChannel entry. More... | |
Error | specialChannelDelete (in UInt32 id) |
Delete a SpecialChannel entry. More... | |
Error | dataFileUpdate (in Bool append, in DataFileInfo dataFile, out UInt32 id) |
Add or update a DataFile entry. More... | |
Error | dataFileDelete (in UInt32 id) |
Delete a DataFile entry. More... | |
Error | dataChannelUpdate (in Bool append, in DataChannel dataChannel, out UInt32 id) |
Add or update a DataChannel entry. More... | |
Error | dataChannelDelete (in UInt32 id) |
Delete a DataChannel entry. More... | |
Error | changeGroupStart (in ChangeGroup changeGroup) |
Start a new ChangeGroup when making a set of changes to the BDS's database. More... | |
Error | changeGroupEnd () |
End a ChangeGroup. More... | |
Error | changeGroupGetList (in ListRange range, out List< ChangeGroup > changeGroups) |
Return a list of ChangeGroups. More... | |
Error | changeGroupDelete (in TimeStamp beforeDate, in String type, in Bool empty) |
Delete a ChangeGroup. More... | |
Error | changeGetListNumber (in UInt32 id, out UInt32 number) |
Get the number of changes in a ChangeGroup. More... | |
Error | changeGetList (in UInt32 id, in ListRange range, out List< Change > changes) |
Get a list of Changes. More... | |
Error | changeDelete (in TimeStamp beforeDate, in String type) |
Delete a Change. More... | |
Error | noteDelete (in UInt32 id) |
Delete a Note. More... | |
Error | logGetList (in LogSelect sel, out List< Log > logs) |
Get list of log entries. More... | |
Error | logDelete (in UInt32 id) |
Delete a Log item. More... | |
Error | transactionStart () |
Starts a set of transactions. More... | |
Error | transactionEnd (in Bool abort) |
Ends a set of transactions. More... | |
Error | databaseRestore (in String ref, in String type) |
Restore the database. More... | |
Error | sqlQuery (in String query, out List< Dict< String >> result) |
A low level SQL access function. More... | |
Error | extraCall (in UInt32 function, in String args, out String result) |
A special function to add new functions to the API prior to a full API update. More... | |
Variables | |
module | Bds |
apiVersion = 25 | |
class DataFormats | List< DataFormat > |
enum AvailType |
enum DataFlags |
enum DataFormatSet |
enum Errors |
The System Error number list in addition to standard system error numbers.
enum Mode |
enum Priority |
enum SampleFormat |
enum SelectionGroup |
Error accessGroupDelete | ( | in UInt32 | id | ) |
Delete an AccessGroup entry.
Error accessGroupGetList | ( | out List< AccessGroup > | accessGroups | ) |
Get list of AccessGroups.
Update or append an AccessGroup entry.
Error calibrationDelete | ( | in UInt32 | id | ) |
Delete a Calibration entry.
Error calibrationGetList | ( | in Selection | sel, |
out List< Calibration > | calibrations | ||
) |
Get list of Calibrations.
Add or update a Calibration entry.
Error changeDelete | ( | in TimeStamp | beforeDate, |
in String | type | ||
) |
Delete a Change.
Error changeGetList | ( | in UInt32 | id, |
in ListRange | range, | ||
out List< Change > | changes | ||
) |
Get a list of Changes.
Get the number of changes in a ChangeGroup.
Error changeGroupDelete | ( | in TimeStamp | beforeDate, |
in String | type, | ||
in Bool | empty | ||
) |
Delete a ChangeGroup.
Error changeGroupEnd | ( | ) |
End a ChangeGroup.
Error changeGroupGetList | ( | in ListRange | range, |
out List< ChangeGroup > | changeGroups | ||
) |
Return a list of ChangeGroups.
Error changeGroupStart | ( | in ChangeGroup | changeGroup | ) |
Start a new ChangeGroup when making a set of changes to the BDS's database.
Error channelDelete | ( | in UInt32 | id | ) |
Delete a Channel entry.
Error channelGet | ( | in UInt32 | id, |
out Channel | channel | ||
) |
Get a channel.
Error channelGetList | ( | in Selection | sel, |
out List< Channel > | channels | ||
) |
Get list of Channels.
Error channelInstrumentDelete | ( | in UInt32 | id | ) |
Delete an Instrument entry.
Error channelInstrumentGetList | ( | in Selection | sel, |
out List< ChannelInstrument > | channelInstruments | ||
) |
Get list of Instruments.
Get list of Channel Instruments.
Error channelInstrumentUpdate | ( | in Bool | append, |
in ChannelInstrument | channelInstrument, | ||
out UInt32 | id | ||
) |
Add or update a Instrument entry.
Add or update a Channel entry.
Error clean | ( | in CleanOptions | cleanOptions | ) |
Cleans the system logs and Changes information.
Error dataAvailability | ( | in Selection | selection, |
in UInt32 | num, | ||
out Array< DataAvailChan > | dataAvailChans | ||
) |
Return availability for data matching the given selection parameters. If num > 0 segment ito this number of fixed time segments.
Error databaseBackup | ( | out String | ref | ) |
Backup the database.
Error databaseRestore | ( | in String | ref, |
in String | type | ||
) |
Restore the database.
Error dataChannelDelete | ( | in UInt32 | id | ) |
Delete a DataChannel entry.
Error dataChannelGetList | ( | in Selection | sel, |
out List< DataChannel > | dataChannel | ||
) |
Get list of DataChannels.
Add or update a DataChannel entry.
Error dataClose | ( | in DataHandle | dataHandle, |
in Error | error, | ||
in Bool | del | ||
) |
Close a file.
Error dataFileDelete | ( | in UInt32 | id | ) |
Delete a DataFile entry.
Error dataFileGetList | ( | in Selection | sel, |
out List< DataFileInfo > | dataFile | ||
) |
Get list of DataFiles.
Add or update a DataFile entry.
Error dataFormatGetList | ( | out List< DataFormat > | formats | ) |
Get list of data formats.
Get list of supported data formats.
Error dataFormattedGetLength | ( | in DataHandle | dataHandle, |
out UInt64 | length | ||
) |
Read the raw data from the file.
The total length in bytes of the formated data.
Read the raw data from the file.
Read the raw data from the stream.
Error dataGetBlock | ( | in DataHandle | dataHandle, |
in UInt32 | channel, | ||
in UInt32 | segment, | ||
in UInt32 | blockNumber, | ||
out DataBlock | data | ||
) |
Return a block of data.
Error dataGetChannelInfo | ( | in DataInfo | dataInfo, |
out ChannelInfos | channelInfos | ||
) |
Return the channel MetaData in structured form.
Error dataGetInfo | ( | in DataHandle | dataHandle, |
in UInt32 | infoExtra, | ||
out DataInfo | dataInfo | ||
) |
Get information on the data file.
Error dataGetNotes | ( | in DataHandle | dataHandle, |
out List< Note > | notes | ||
) |
Get notes on the data file.
Error dataGetWarnings | ( | in DataHandle | dataHandle, |
out List< String > | warnings | ||
) |
Get information on the data file.
Error dataOpen | ( | in DataInfo | dataInfo, |
in String | mode, | ||
in String | format, | ||
in UInt32 | flags, | ||
out DataHandle | dataHandle | ||
) |
Open a data file.
Error dataPutBlock | ( | in DataHandle | dataHandle, |
in DataBlock | data | ||
) |
Send a block of data.
Error dataRealtimeConfig | ( | in Bool | enable, |
in Selection | sel | ||
) |
Configures the sending of real-time data blocks.
Error dataRealtimeGet | ( | in UInt32 | numBlocks, |
out UInt32 | numBlocksAvailable, | ||
out List< DataBlockChannel > | dataBlocks | ||
) |
Returns the number of data blocks available and up to nymBlocks of these.
Error dataSearch | ( | in Selection | selection, |
out DataInfo | dataInfo | ||
) |
Search for data matching the given selection parameters.
Error dataSeekBlock | ( | in DataHandle | dataHandle, |
in UInt32 | channel, | ||
in UInt32 | segment, | ||
in TimeStamp | time, | ||
out UInt32 | blockNumber | ||
) |
Searches for a data block matching the time given.
Error dataSetInfo | ( | in DataHandle | dataHandle, |
in DataInfo | dataInfo | ||
) |
Set the info when writing to a file.
Error digitiserDelete | ( | in UInt32 | id | ) |
Delete a Digitiser entry.
Error digitiserGet | ( | in UInt32 | id, |
out Digitiser | digitiser | ||
) |
Get a Digitiser object given its ID.
Error digitiserGetList | ( | in Selection | sel, |
out List< Digitiser > | digitisers | ||
) |
Get list of Digitisers.
Get list of Channels.
Add or update a Digitiser entry.
Error eventDelete | ( | in UInt32 | id | ) |
Delete a Event entry.
Error eventGetList | ( | in Selection | sel, |
out List< Event > | events | ||
) |
Get list of Events.
Error extraCall | ( | in UInt32 | function, |
in String | args, | ||
out String | result | ||
) |
A special function to add new functions to the API prior to a full API update.
Error getSelectionInfo | ( | in SelectionGroup | group, |
in Selection | selectionIn, | ||
out SelectionInfo | selectionInfo | ||
) |
Get information on possible selections. Use in GUI programs to list options available.
Error getSelections | ( | in SelectionGroup | group, |
in Selection | selectionIn, | ||
out Selection | selectionOut | ||
) |
Get selection list.
Error getVersion | ( | out String | version, |
out String | name | ||
) |
Gets the software version and server name.
Error groupDelete | ( | in UInt32 | id | ) |
Delete a group entry.
Error groupGetList | ( | out List< Group > | groups | ) |
Get list of Groups.
Error locationDelete | ( | in UInt32 | id | ) |
Delete a Station Location entry.
Error locationGetList | ( | in Selection | sel, |
out List< Location > | locations | ||
) |
Get list of Station Locations.
Add or update a Station Location entry.
Error logAppend | ( | in String | type, |
in UInt32 | priority, | ||
in String | subSystem, | ||
in String | title, | ||
in String | description | ||
) |
Append a log item.
Error logDelete | ( | in UInt32 | id | ) |
Delete a Log item.
Error logGetList | ( | in LogSelect | sel, |
out List< Log > | logs | ||
) |
Get list of log entries.
Add or update a Log item.
Add or Update a Log item.
Append a log item ///< Add or update a Log item.
Error metadataGetChannelInfo | ( | in Selection | sel, |
out ChannelInfos | channelInfos | ||
) |
Return the channel MetaData in structured form.
Error metadataGetFormatted | ( | in Selection | sel, |
in String | format, | ||
out Array< UInt8 > | data | ||
) |
Return the channel MetaData in a particular format.
Error modeSnapshotPause | ( | in Bool | on | ) |
Enables/disables backup synchronisation pause.
Error networkDelete | ( | in UInt32 | id | ) |
Delete a Network entry.
Error networkGetList | ( | out List< Network > | networks | ) |
Get list of Networks.
Add or update a Network entry.
Error noteDelete | ( | in UInt32 | id | ) |
Delete a Note.
Error noteGetList | ( | in Selection | sel, |
out List< Note > | notes | ||
) |
Return a list of Notes.
Get a list of Notes.
Read a document associated with a Note.
Given a Note write a document associated with it.
Error responseDelete | ( | in UInt32 | id | ) |
Delete a Response entry.
Error responseGetList | ( | in Selection | sel, |
out List< Response > | responses | ||
) |
Get list of Responces.
Get list of Responses.
Add or update a Response entry.
Error sensorDelete | ( | in UInt32 | id | ) |
Delete a Sensor entry.
Error sensorGet | ( | in UInt32 | id, |
out Sensor | sensor | ||
) |
Get a Sensor object given its ID.
Error sensorGetList | ( | in Selection | sel, |
out List< Sensor > | sensors | ||
) |
Get list of Sensors.
Add or update a Sensor entry.
Error serverConfigurationGet | ( | out Dict< String > | items | ) |
Get server configuration parameters.
Error setUser | ( | in String | user, |
in String | |||
) |
Sets user to given name or email.
Error setUserReal | ( | ) |
Sets user back to real user.
Error sourceDelete | ( | in UInt32 | id | ) |
Delete a Source entry.
Error sourceGetList | ( | out List< Source > | sources | ) |
Get list of Sources.
Error sourcePriorityDelete | ( | in UInt32 | id | ) |
Error sourcePriorityGetList | ( | out List< SourcePriority > | sourcePrioritys | ) |
Get list of SourcePriorities.
Add or update a Source entry.
Error specialChannelDelete | ( | in UInt32 | id | ) |
Delete a SpecialChannel entry.
Error specialChannelGetList | ( | in Selection | sel, |
out List< SpecialChannel > | specialChannels | ||
) |
Get list of Special Channels.
Add or update a SpecialChannel entry.
Error sqlQuery | ( | in String | query, |
out List< Dict< String >> | result | ||
) |
A low level SQL access function.
Error stationDelete | ( | in UInt32 | id | ) |
Delete a Station entry.
Error stationGetList | ( | in Selection | sel, |
out List< Station > | stations | ||
) |
Get list of Stations.
Add or update a Station entry.
Error statisticsGet | ( | out Dict< String > | info | ) |
Get a list of system statistics.
Error transactionEnd | ( | in Bool | abort | ) |
Ends a set of transactions.
Error transactionStart | ( | ) |
Starts a set of transactions.
Error userDelete | ( | in UInt32 | id | ) |
Delete a user entry.
Error userGet | ( | out User | user | ) |
Get user info.
Error userGetFromId | ( | in UInt32 | id, |
out User | user | ||
) |
Get user info given user ID.
Error userGetGroups | ( | out List< String > | groups | ) |
Get list of groups the user belongs to.
Error userGetList | ( | out List< User > | users | ) |
Get list of Users.
Error userGetOptions | ( | out Dict< String > | items | ) |
Get user options.
Error userSet | ( | in User | user | ) |
Set user info.
Error userSetOptions | ( | out Dict< String > | items | ) |
Set user options.
Error validateUser | ( | in String | user, |
in String | |||
) |
Checks the user given name or email.
apiVersion = 25 |
module Bds |
class DataFormats List< DataFormat > |