StorageItem
StorageItem Objects
uuid
UUID: The unique identifier of the storage item.
parent_folder_uuid
UUID: The UUID of the parent folder.
parent_folder
Retrieve the parent folder of the storage item.
Returns:
StorageFolder
- The parent folder.
item_type
StorageItemType: The type of the storage item.
name
str: The name of the storage item.
description
str: The description of the storage item.
client_metadata
Optional[Dict[str, Any]]: The client metadata of the storage item.
created_at
datetime: The creation time of the storage item.
last_edited_at
datetime: The last edited time of the storage item.
backed_data_units_count
int: The number of backed data units.
storage_location
StorageLocationName: The storage location name.
integration_hash
Optional[UUID]: The integration hash.
url
Optional[str]: The URL of the storage item.
file_size
Optional[int]: The file size of the storage item.
mime_type
Optional[str]: The MIME type of the storage item.
duration
Optional[float]: The duration of the storage item.
fps
Optional[float]: The frames per second of the storage item.
height
Optional[int]: The height of the storage item.
width
Optional[int]: The width of the storage item.
dicom_instance_uid
Optional[str]: The DICOM instance UID of the storage item.
dicom_study_uid
Optional[str]: The DICOM study UID of the storage item.
dicom_series_uid
Optional[str]: The DICOM series UID of the storage item.
frame_count
Optional[int]: The frame count of the storage item.
audio_sample_rate
Optional[int]: The number of samples taken per second (in Hz).
audio_bit_depth
Optional[int]: The number of bits used to record each audio sample.
audio_codec
Optional[int]: The codec of the audio file (e.g., mp3 or flac).
audio_num_channels
Optional[int]: The number of channels.
get_signed_url
Get a signed URL for downloading the item.
Returns None
if the item is a synthetic entity (e.g., image group or DICOM series).
Arguments:
refetch
- IfTrue
, forces fetching a new signed URL even if one is cached.
Returns:
Optional[str]
- Signed URL for downloading the item, orNone
if not supported.
Raises:
ValueError
- If the item type is DICOM series or image group (unsupported for signed URLs).
get_summary
Retrieve a summary of the item, including linked datasets and other information.
Returns:
StorageItemSummary
- Object containing summary information about the item.
get_child_items
Get child items of the item, such as frames of an image group or files of DICOM series.
Arguments:
get_signed_urls
- IfTrue
, include signed URLs for child items.
Returns:
Iterable[StorageItem]
- List of child items accessible to the user.
update
Update modifiable properties of the item.
Arguments:
name
- New item name.description
- New item description.client_metadata
- New client metadata.bundle
- Optional bundle to use for bundling operations.
Returns:
None
Notes:
If no parameters are provided, the function does nothing.
If bundle
is provided, the operation is bundled into a single server call with other item updates
using the same bundle.
delete
Delete the item from the storage.
Arguments:
remove_unused_frames
- IfTrue
(default), remove individual images or DICOM files not used elsewhere.
Returns:
None
move_to_folder
Move the item to another folder.
Arguments:
target_folder
- Target folder to move the item to. Can be aStorageFolder
object or a UUID.allow_mirror_dataset_changes
- IfTrue
, allows moving items linked to a mirror dataset. Default isFalse
, which prohibits such moves to prevent data loss.
Returns:
None
Notes:
This method updates the item’s parent folder and refetches item data after the move.
refetch_data
Refetches data for the item, updating its attributes.
Arguments:
get_signed_url
- IfTrue
, refetches the signed URL for downloading the item.
Returns:
None
Was this page helpful?