benchling_sdk.services.v2.stable.location_service module¶
- class LocationService¶
Bases:
benchling_sdk.services.v2.base_service.BaseService
Locations.
Manage locations objects. Like all storage, every Location has a barcode that is unique across the registry.
See https://benchling.com/api/reference#/Locations
- archive(location_ids: Iterable[str], reason: LocationsArchiveReason, should_remove_barcodes: bool) LocationsArchivalChange ¶
Archive locations.
See https://benchling.com/api/reference#/Locations/archiveLocations
- bulk_get(*, location_ids: Optional[Iterable[str]] = None, barcodes: Optional[Iterable[str]] = None) Optional[List[Location]] ¶
Bulk get locations.
See https://benchling.com/api/reference#/Locations/bulkGetLocations
- create(location: LocationCreate) Location ¶
Create a location.
See https://benchling.com/api/reference#/Locations/createLocation
- get_by_id(location_id: str) Location ¶
Get a location by ID.
See https://benchling.com/api/reference#/Locations/getLocation
- list(*, sort: Optional[ListLocationsSort] = None, schema_id: Optional[str] = None, modified_at: Optional[str] = None, name: Optional[str] = None, name_includes: Optional[str] = None, ancestor_storage_id: Optional[str] = None, archive_reason: Optional[str] = None, ids: Optional[Iterable[str]] = None, barcodes: Optional[Iterable[str]] = None, names_any_of: Optional[Iterable[str]] = None, names_any_of_case_sensitive: Optional[Iterable[str]] = None, creator_ids: Optional[Iterable[str]] = None, schema_fields: Optional[Dict[str, Any]] = None, page_size: Optional[int] = None) PageIterator[Location] ¶
List locations.
See https://benchling.com/api/reference#/Locations/listLocations
- unarchive(location_ids: Iterable[str]) LocationsArchivalChange ¶
Unarchive locations.
See https://benchling.com/api/reference#/Locations/unarchiveLocations
- update(location_id: str, location: LocationUpdate) Location ¶
Update a location.
See https://benchling.com/api/reference#/Locations/updateLocation