sampledbapi package

sampledbapi.authenticate(address: str, api_key: str)

Authenticate with a SampleDB instance

To retrieve data from SampleDB and upload data to it, you have to authenticate first.

Parameters:

• address – URL of the SampleDB server.

• api_key – API token you can generate using “Preferences/API Tokens”.

Submodules

• sampledbapi.actions module
  • Action
    • Action.action_id
    • Action.description
    • Action.instrument_id
    • Action.is_hidden
    • Action.name
    • Action.schema
    • Action.type
    • Action.type_id
  • get()
  • get_list()
• sampledbapi.actiontypes module
  • ActionType
    • ActionType.admin_only
    • ActionType.name
    • ActionType.object_name
    • ActionType.type_id
  • get()
  • get_list()
• sampledbapi.comm module
  • SampleDBObject
  • __headers()
  • authenticate()
  • get_data()
  • post_data()
  • put_data()
• sampledbapi.instruments module
  • Instrument
    • Instrument.create_log_entry()
    • Instrument.description
    • Instrument.get_log_category()
    • Instrument.get_log_category_list()
    • Instrument.get_log_entry()
    • Instrument.get_log_entry_list()
    • Instrument.instrument_id
    • Instrument.instrument_scientists
    • Instrument.is_hidden
    • Instrument.name
  • InstrumentLogCategory
    • InstrumentLogCategory.category_id
    • InstrumentLogCategory.title
  • InstrumentLogEntry
    • InstrumentLogEntry.author
    • InstrumentLogEntry.get_file_attachment()
    • InstrumentLogEntry.get_file_attachment_list()
    • InstrumentLogEntry.get_object_attachment()
    • InstrumentLogEntry.get_object_attachment_list()
    • InstrumentLogEntry.instrument_id
    • InstrumentLogEntry.log_entry_id
    • InstrumentLogEntry.versions
  • InstrumentLogFileAttachment
    • InstrumentLogFileAttachment.content
    • InstrumentLogFileAttachment.file_attachment_id
    • InstrumentLogFileAttachment.file_name
  • InstrumentLogObjectAttachment
    • InstrumentLogObjectAttachment.object_attachment_id
    • InstrumentLogObjectAttachment.object_id
  • get()
  • get_list()
• sampledbapi.locations module
  • Location
    • Location.description
    • Location.is_hidden
    • Location.location_id
    • Location.name
    • Location.parent_location_id
    • Location.type_id
  • get()
  • get_list()
• sampledbapi.locationtypes module
  • LocationType
    • LocationType.location_type_id
    • LocationType.name
  • get()
  • get_list()
• sampledbapi.object_log module
  • ObjectLogEntry
    • ObjectLogEntry.data
    • ObjectLogEntry.log_entry_id
    • ObjectLogEntry.object_id
    • ObjectLogEntry.type
    • ObjectLogEntry.user_id
    • ObjectLogEntry.utc_datetime
  • get_object_log_entries()
• sampledbapi.objects module
  • Comment
    • Comment.comment_id
    • Comment.content
    • Comment.object_id
    • Comment.user_id
    • Comment.utc_datetime
  • File
    • File.base64_content
    • File.file_id
    • File.hash
    • File.object_id
    • File.original_file_name
    • File.storage
    • File.url
  • Object
    • Object.action_id
    • Object.data
    • Object.from_json()
    • Object.get_all_group_permissions()
    • Object.get_all_project_group_permissions()
    • Object.get_all_user_permissions()
    • Object.get_comment()
    • Object.get_comment_list()
    • Object.get_file()
    • Object.get_file_list()
    • Object.get_group_permissions()
    • Object.get_location_occurence()
    • Object.get_location_occurences()
    • Object.get_project_group_permissions()
    • Object.get_public()
    • Object.get_related_objects()
    • Object.get_user_permissions()
    • Object.get_version()
    • Object.object_id
    • Object.post_comment()
    • Object.post_link()
    • Object.schema
    • Object.set_group_permissions()
    • Object.set_project_group_permissions()
    • Object.set_public()
    • Object.set_user_permissions()
    • Object.to_json()
    • Object.update()
    • Object.upload_file()
    • Object.upload_file_raw()
    • Object.version_datetime
    • Object.version_editor
    • Object.version_id
  • create()
  • get()
  • get_list()
• sampledbapi.users module
  • User
    • User.affiliation
    • User.email
    • User.name
    • User.orcid
    • User.role
    • User.user_id
  • get()
  • get_current()
  • get_list()
• sampledbapi.utils module
  • Quantity
    • Quantity.units
    • Quantity.value
  • TimeSeries
    • TimeSeries.data
    • TimeSeries.units
  • bool2json()
  • convert_json()
  • datetime2json()
  • file2json()
  • json2bool()
  • json2datetime()
  • json2objectreference()
  • json2quantity()
  • json2text()
  • json2timeseries()
  • objectreference2json()
  • quantity2json()
  • str2datetime()
  • text2json()
  • timeseries2json()