pyicat_plus.client.elogbook.IcatElogbookClient#

class pyicat_plus.client.elogbook.IcatElogbookClient(url, api_key=None, timeout=None, **payload)[source]#

Bases: object

Client for the e-logbook part of the ICAT+ REST API.

REST API docs: https://icatplus.esrf.fr/api-docs/

The ICAT+ server project: https://gitlab.esrf.fr/icat/icat-plus/-/blob/master/README.md

Parameters:

  • url (str)

  • api_key (Optional[str])

  • timeout (Optional[float])

DEFAULT_SCHEME = 'https'#
send_binary_data(data, mimetype, beamline=None, proposal=None, investigation_id=None, **call_payload)[source]#
Parameters:

  • data (bytes)

  • mimetype (str)

  • beamline (Optional[str])

  • proposal (Optional[str])

  • investigation_id (Optional[str])

send_binary_file(filename, beamline=None, proposal=None, **payload)[source]#
Parameters:

  • filename (str)

  • beamline (Optional[str])

  • proposal (Optional[str])

send_message(message, message_type=None, editable=None, formatted=None, mimetype=None, beamline=None, investigation_id=None, proposal=None, dataset=None, **call_payload)[source]#
Parameters:

  • message (str)

  • message_type (Optional[str])

  • editable (Optional[bool])

  • formatted (Optional[bool])

  • mimetype (Optional[str])

  • beamline (Optional[str])

  • investigation_id (Optional[str])

  • proposal (Optional[str])

  • dataset (Optional[str])

send_text_file(filename, beamline=None, proposal=None, investigation_id=None, dataset=None, message_type=None, editable=None, formatted=None, mimetype=None, **payload)[source]#
Parameters:

  • filename (str)

  • beamline (Optional[str])

  • proposal (Optional[str])

  • investigation_id (Optional[str])

  • dataset (Optional[str])

  • message_type (Optional[str])

  • editable (Optional[bool])

  • formatted (Optional[bool])

  • mimetype (Optional[str])