Skip to content

Commit b3233f0

Browse files
authored
Freezer Manager API - add Primary Storage option to storage related action documentation (#55)
1 parent f4f2c4d commit b3233f0

File tree

4 files changed

+30
-20
lines changed

4 files changed

+30
-20
lines changed

CHANGE.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
+++++++++++
22
LabKey Python Client API News
33
+++++++++++
4+
5+
What's New in the LabKey 2.4.1 package
6+
==============================
7+
8+
*Release date: 12/15/2022*
9+
- Freezer Manager API - add Primary Storage option to storage-related action documentation
10+
411
What's New in the LabKey 2.4.0 package
512
==============================
613

docs/storage.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,21 @@
22

33
Create, update, or delete a LabKey Freezer Manager storage item.
44

5-
Storage items can be used in the creation of a freezer hierarchy. Freezer hierarchies consist of a top level Freezer,
6-
which can have any combination of child non-terminal storage locations (i.e. those that do not directly contain samples
7-
but can contain other units) and terminal storage locations (i.e. units in the freezer that directly contain samples
8-
and cannot contain other units).
5+
Storage items can be used in the creation of a storage hierarchy. Storage hierarchies consist of a top level Freezer
6+
or Primary Storage location, which can have any combination of child non-terminal storage locations (i.e. those that
7+
do not directly contain samples but can contain other units) and terminal storage locations (i.e. units in the storage
8+
that directly contain samples and cannot contain other units).
99

10-
Storage items can be of the following types: Physical Location, Freezer, Shelf, Rack, Canister, Storage Unit Type, or
11-
Terminal Storage Location.
10+
Storage items can be of the following types: Physical Location, Freezer, Primary Storage, Shelf, Rack, Canister,
11+
Storage Unit Type, or Terminal Storage Location.
1212

1313
The specific set of props will differ for each storage item type:
1414
- Physical Location: name, description, locationId (rowId of the parent Physical Location)
1515
- Freezer: name, description, locationId (rowId of the parent Physical Location), manufacturer, freezerModel, temperature, temperatureUnits, serialNumber, sensorName, lossRate, status
16-
- Shelf/Rack/Canister: name, description, locationId (rowId of the parent freezer or Shelf/Rack/Canister)
16+
- Primary Storage: name, description, locationId (rowId of the parent Physical Location), temperatureControlled (boolean)
17+
- Shelf/Rack/Canister: name, description, locationId (rowId of the parent freezer, primary storage, or Shelf/Rack/Canister)
1718
- Storage Unit Type: name, description, unitType (one of the following: "Box", "Plate", "Bag", "Cane", "Tube Rack"), rows, cols (required if positionFormat is not "Num"), positionFormat (one of the following: "Num", "AlphaNum", "AlphaAlpha", "NumAlpha", "NumNum"), positionOrder (one of the following: "RowColumn", "ColumnRow")
18-
- Terminal Storage Location: name, description, typeId (rowId of the Storage Unit Type), locationId (rowId of the parent freezer or Shelf/Rack/Canister)
19+
- Terminal Storage Location: name, description, typeId (rowId of the Storage Unit Type), locationId (rowId of the parent freezer, primary storage, or Shelf/Rack/Canister)
1920

2021
### Installation and Setup for the LabKey Python API:
2122
- https://github.com/LabKey/labkey-api-python/blob/master/README.md

labkey/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@
1414
# limitations under the License.
1515
#
1616
__title__ = "labkey"
17-
__version__ = "2.4.0"
17+
__version__ = "2.4.1"
1818
__author__ = "LabKey"
1919
__license__ = "Apache License 2.0"

labkey/storage.py

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,19 @@
2323
2424
DESCRIPTION:
2525
Create, update, or delete a LabKey Freezer Manager storage item. Storage items can be used in the creation of a
26-
freezer hierarchy. Freezer hierarchies consist of a top level Freezer, which can have any combination of child
27-
non-terminal storage locations (i.e. those that do not directly contain samples but can contain other units) and
28-
terminal storage locations (i.e. units in the freezer that directly contain samples and cannot contain other units).
26+
storage hierarchy. Storage hierarchies consist of a top level Freezer or Primary Storage location, which can have any
27+
combination of child non-terminal storage locations (i.e. those that do not directly contain samples but can contain
28+
other units) and terminal storage locations (i.e. units in the storage that directly contain samples and cannot contain
29+
other units).
2930
30-
Storage items can be of the following types: Physical Location, Freezer, Shelf, Rack, Canister, Storage Unit Type, or Terminal Storage Location.
31+
Storage items can be of the following types: Physical Location, Freezer, Primary Storage, Shelf, Rack, Canister, Storage Unit Type, or Terminal Storage Location.
3132
The specific set of props will differ for each storage item type:
3233
- Physical Location: name, description, locationId (rowId of the parent Physical Location)
3334
- Freezer: name, description, locationId (rowId of the parent Physical Location), manufacturer, freezerModel, temperature, temperatureUnits, serialNumber, sensorName, lossRate, status
34-
- Shelf/Rack/Canister: name, description, locationId (rowId of the parent freezer or Shelf/Rack/Canister)
35+
- Primary Storage: name, description, locationId (rowId of the parent Physical Location), temperatureControlled (boolean)
36+
- Shelf/Rack/Canister: name, description, locationId (rowId of the parent freezer, primary storage, or Shelf/Rack/Canister)
3537
- Storage Unit Type: name, description, unitType (one of the following: "Box", "Plate", "Bag", "Cane", "Tube Rack"), rows, cols (required if positionFormat is not "Num"), positionFormat (one of the following: "Num", "AlphaNum", "AlphaAlpha", "NumAlpha", "NumNum"), positionOrder (one of the following: "RowColumn", "ColumnRow")
36-
- Terminal Storage Location: name, description, typeId (rowId of the Storage Unit Type), locationId (rowId of the parent freezer or Shelf/Rack/Canister)
38+
- Terminal Storage Location: name, description, typeId (rowId of the Storage Unit Type), locationId (rowId of the parent freezer, primary storage, or Shelf/Rack/Canister)
3739
3840
Installation and Setup for the LabKey Python API:
3941
https://github.com/LabKey/labkey-api-python/blob/master/README.md
@@ -58,7 +60,7 @@ def create_storage_item(
5860
server_context: ServerContext, type: str, props: dict, container_path: str = None
5961
):
6062
"""
61-
Create a new LabKey Freezer Manager storage item that can be used in the creation of a freezer hierarchy.
63+
Create a new LabKey Freezer Manager storage item that can be used in the creation of a storage hierarchy.
6264
:param server_context: A LabKey server context. See utils.create_server_context.
6365
:param type:
6466
:param props:
@@ -75,7 +77,7 @@ def update_storage_item(
7577
server_context: ServerContext, type: str, props: dict, container_path: str = None
7678
):
7779
"""
78-
Update an existing LabKey Freezer Manager storage item to change its properties or location within the freezer hierarchy.
80+
Update an existing LabKey Freezer Manager storage item to change its properties or location within the storage hierarchy.
7981
For update_storage_item, the "rowId" primary key value is required to be set within the props.
8082
:param server_context: A LabKey server context. See utils.create_server_context.
8183
:param type:
@@ -93,9 +95,9 @@ def delete_storage_item(
9395
server_context: ServerContext, type: str, row_id: int, container_path: str = None
9496
):
9597
"""
96-
Delete an existing LabKey Freezer Manager storage item. Note that deletion of freezers or locations within the
97-
freezer hierarchy will cascade the delete down the hierarchy to remove child locations and terminal storage locations.
98-
Samples in the deleted freezer location(s) will not be deleted but will be removed from storage.
98+
Delete an existing LabKey Freezer Manager storage item. Note that deletion of freezers, primary storage, or locations
99+
within the storage hierarchy will cascade the delete down the hierarchy to remove child locations and terminal
100+
storage locations. Samples in the deleted storage location(s) will not be deleted but will be removed from storage.
99101
:param server_context: A LabKey server context. See utils.create_server_context.
100102
:param type:
101103
:param row_id:

0 commit comments

Comments
 (0)