pyicat_plus.client.icatplus_restricted.IcatPlusRestrictedClient#

class pyicat_plus.client.icatplus_restricted.IcatPlusRestrictedClient(url, password=None)[source]#

Bases: object

Client for the restricted 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)

  • password (Optional[str])

DEFAULT_SCHEME = 'https'#
property authentication_result: dict#
get_investigations_by(filter=None, instrument_name=None, start_date=None, end_date=None)[source]#

Returns a list of investigations matching the provided criteria.

Parameters:

  • filter (Optional[str])

  • instrument_name (Optional[str])

  • start_date (Optional[datetime])

  • end_date (Optional[datetime])

Return type:

List[dict]

get_parcels_by(investigation_id)[source]#

Returns the list of parcels associated to an investigation.

Parameters:

investigation_id (str)

Return type:

List[dict]

property icat_session_id: str#
login(password)[source]#
Parameters:

password (str)

Return type:

dict