image_set_metadatas

Creates, updates, deletes, gets or lists an image_set_metadatas resource.

Overview

Name	image_set_metadatas
Type	Resource
Id	aws.medical_imaging.image_set_metadatas

Fields

The following fields are returned by SELECT queries:

get_image_set_metadata

Name	Datatype	Description
content_encoding	string	The compression format in which image set metadata attributes are returned.
content_type	string	The format in which the study metadata is returned to the customer. Default is text/plain.
image_set_metadata_blob	string (byte)	The blob containing the aggregated metadata information for the image set.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_image_set_metadata	select	datastore_id, image_set_id, region	version	Get metadata attributes for an image set.
update_image_set_metadata	update	datastore_id, image_set_id, latestVersion, region, updateImageSetMetadataUpdates	force, includeStudyImageSets	Update image set metadata attributes.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
datastore_id	string	The data store identifier.
image_set_id	string	The image set identifier.
latestVersion	string	The latest image set version identifier.
region	string	AWS region (default: us-east-1)
force	boolean	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
includeStudyImageSets	boolean	Flag to apply the metadata updates to all image sets in the same Study as the requested image set ID.
version	string	The image set version identifier.

SELECT examples

get_image_set_metadata

Get metadata attributes for an image set.

SELECT
content_encoding,
content_type,
image_set_metadata_blob
FROM aws.medical_imaging.image_set_metadatas
WHERE datastore_id = '{{ datastore_id }}' -- required
AND image_set_id = '{{ image_set_id }}' -- required
AND region = '{{ region }}' -- required
AND version = '{{ version }}'
;

UPDATE examples

update_image_set_metadata

Update image set metadata attributes.

UPDATE aws.medical_imaging.image_set_metadatas
SET 
updateImageSetMetadataUpdates = '{{ updateImageSetMetadataUpdates }}'
WHERE 
datastore_id = '{{ datastore_id }}' --required
AND image_set_id = '{{ image_set_id }}' --required
AND latestVersion = '{{ latestVersion }}' --required
AND region = '{{ region }}' --required
AND updateImageSetMetadataUpdates = '{{ updateImageSetMetadataUpdates }}' --required
AND force = {{ force}}
AND includeStudyImageSets = {{ includeStudyImageSets}}
RETURNING
created_at,
datastore_id,
image_set_id,
image_set_state,
image_set_workflow_status,
latest_version_id,
message,
updated_at;