Skip to content

UpdateImageSetMetadataRequest

Source code in docs_src/capo_medical_imaging/types/update_image_set_metadata_request.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class UpdateImageSetMetadataRequest(TypedDict, closed=True):
    datastore_id: "capo_medical_imaging.types.datastore_id.DatastoreId"
    """<p>The data store identifier.</p>"""
    image_set_id: "capo_medical_imaging.types.image_set_id.ImageSetId"
    """<p>The image set identifier.</p>"""
    latest_version_id: "capo_medical_imaging.types.image_set_external_version_id.ImageSetExternalVersionId"
    """<p>The latest image set version identifier.</p>"""
    force: NotRequired["bool"]
    """<p>Setting this flag will force the <code>UpdateImageSetMetadata</code> operation for the following attributes:</p> <ul> <li> <p> <code>Tag.StudyInstanceUID</code>, <code>Tag.SeriesInstanceUID</code>, <code>Tag.SOPInstanceUID</code>, and <code>Tag.StudyID</code> </p> </li> <li> <p>Adding, removing, or updating private tags for an individual SOP Instance</p> </li> </ul>"""
    include_study_image_sets: NotRequired["bool"]
    """<p>Flag to apply the metadata updates to all image sets in the same Study as the requested image set ID.</p>"""
    update_image_set_metadata_updates: (
        "capo_medical_imaging.types.metadata_updates.MetadataUpdates"
    )
    """<p>Update image set metadata updates.</p>"""

datastore_id instance-attribute 

datastore_id: DatastoreId

The data store identifier.

force instance-attribute 

force: NotRequired[bool]

Setting this flag will force the UpdateImageSetMetadata operation for the following attributes:

  • Tag.StudyInstanceUID, Tag.SeriesInstanceUID, Tag.SOPInstanceUID, and Tag.StudyID

  • Adding, removing, or updating private tags for an individual SOP Instance

image_set_id instance-attribute 

image_set_id: ImageSetId

The image set identifier.

include_study_image_sets instance-attribute 

include_study_image_sets: NotRequired[bool]

Flag to apply the metadata updates to all image sets in the same Study as the requested image set ID.

latest_version_id instance-attribute 

latest_version_id: ImageSetExternalVersionId

The latest image set version identifier.

update_image_set_metadata_updates instance-attribute 

update_image_set_metadata_updates: MetadataUpdates

Update image set metadata updates.