Skip to content

ImageSetProperties

Source code in docs_src/capo_medical_imaging/types/image_set_properties.py
class ImageSetProperties(TypedDict, closed=True):
    image_set_id: "capo_medical_imaging.types.image_set_id.ImageSetId"
    """<p>The image set identifier.</p>"""
    version_id: "capo_medical_imaging.types.image_set_external_version_id.ImageSetExternalVersionId"
    """<p>The image set version identifier.</p>"""
    image_set_state: "capo_medical_imaging.types.image_set_state.ImageSetState"
    """<p>The image set state.</p>"""
    image_set_workflow_status: NotRequired[
        "capo_medical_imaging.types.image_set_workflow_status.ImageSetWorkflowStatus"
    ]
    """<p>The image set workflow status.</p>"""
    created_at: NotRequired["capo_medical_imaging.types.date.Date"]
    """<p>The timestamp when the image set properties were created.</p>"""
    updated_at: NotRequired["capo_medical_imaging.types.date.Date"]
    """<p>The timestamp when the image set properties were updated.</p>"""
    deleted_at: NotRequired["capo_medical_imaging.types.date.Date"]
    """<p>The timestamp when the image set properties were deleted.</p>"""
    message: NotRequired["capo_medical_imaging.types.message.Message"]
    """<p>The error message thrown if an image set action fails.</p>"""
    overrides: NotRequired["capo_medical_imaging.types.overrides.Overrides"]
    """<p>Contains details on overrides used when creating the returned version of an image set. For example, if <code>forced</code> exists, the <code>forced</code> flag was used when creating the image set.</p>"""
    is_primary: NotRequired["bool"]
    """<p>The flag to determine whether the image set is primary or not.</p>"""

created_at instance-attribute

created_at: NotRequired[Date]

The timestamp when the image set properties were created.

deleted_at instance-attribute

deleted_at: NotRequired[Date]

The timestamp when the image set properties were deleted.

image_set_id instance-attribute

image_set_id: ImageSetId

The image set identifier.

image_set_state instance-attribute

image_set_state: ImageSetState

The image set state.

image_set_workflow_status instance-attribute

image_set_workflow_status: NotRequired[ImageSetWorkflowStatus]

The image set workflow status.

is_primary instance-attribute

is_primary: NotRequired[bool]

The flag to determine whether the image set is primary or not.

message instance-attribute

message: NotRequired[Message]

The error message thrown if an image set action fails.

overrides instance-attribute

overrides: NotRequired[Overrides]

Contains details on overrides used when creating the returned version of an image set. For example, if forced exists, the forced flag was used when creating the image set.

updated_at instance-attribute

updated_at: NotRequired[Date]

The timestamp when the image set properties were updated.

version_id instance-attribute

The image set version identifier.