You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/storage.md
+9-8Lines changed: 9 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -2,20 +2,21 @@
2
2
3
3
Create, update, or delete a LabKey Freezer Manager storage item.
4
4
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).
9
9
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.
12
12
13
13
The specific set of props will differ for each storage item type:
14
14
- Physical Location: name, description, locationId (rowId of the parent Physical Location)
15
15
- 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)
17
18
- 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)
19
20
20
21
### Installation and Setup for the LabKey Python API:
Copy file name to clipboardExpand all lines: labkey/storage.py
+13-11Lines changed: 13 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -23,17 +23,19 @@
23
23
24
24
DESCRIPTION:
25
25
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).
29
30
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.
31
32
The specific set of props will differ for each storage item type:
32
33
- Physical Location: name, description, locationId (rowId of the parent Physical Location)
33
34
- 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)
35
37
- 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)
0 commit comments