StorageItem Objects
uuid
parent_folder_uuid
parent_folder
StorageFolder
- The parent folder.
item_type
name
description
client_metadata
created_at
last_edited_at
backed_data_units_count
storage_location
integration_hash
url
file_size
mime_type
duration
fps
height
width
dicom_instance_uid
dicom_study_uid
dicom_series_uid
frame_count
audio_sample_rate
audio_bit_depth
audio_codec
audio_num_channels
get_signed_url
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.
Optional[str]
- Signed URL for downloading the item, orNone
if not supported.
ValueError
- If the item type is DICOM series or image group (unsupported for signed URLs).
get_summary
StorageItemSummary
- Object containing summary information about the item.
get_child_items
get_signed_urls
- IfTrue
, include signed URLs for child items.
Iterable[StorageItem]
- List of child items accessible to the user.
update
name
- New item name.description
- New item description.client_metadata
- New client metadata.bundle
- Optional bundle to use for bundling operations.
bundle
is provided, the operation is bundled into a single server call with other item updates
using the same bundle.
delete
remove_unused_frames
- IfTrue
(default), remove individual images or DICOM files not used elsewhere.
move_to_folder
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.
refetch_data
get_signed_url
- IfTrue
, refetches the signed URL for downloading the item.