sampledbapi.actions module

This is the module docstring.

class sampledbapi.actions.Action(d: Dict)[source]

Bases: SampleDBObject

action_id: int | None = None

description: str | None = None

instrument_id: int | None = None

is_hidden: bool | None = None

name: str | None = None

schema: dict | None = None

type: str | None = None

type_id: int | None = None

sampledbapi.actions.get(action_id: int) → Action[source]

Get the specific action (action_id).

Parameters:: action_id (int) – ID of the action to be retrieved.
Returns:: The requested Action.
Return type:: Action

sampledbapi.actions.get_list() → List[Action][source]

Get a list of all actions.

Returns:: List of Action objects.
Return type:: List