v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141813585.8 KB

Update image set metadata attributes.

post/datastore/{datastoreId}/imageSet/{imageSetId}/updateImageSetMetadata#latestVersion

Path parameters

datastoreIdstring required

The data store identifier.

imageSetIdstring required

The image set identifier.

Query parameters

latestVersionstring required

The latest image set version identifier.

forceboolean
<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>
includeStudyImageSetsboolean

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

Request body

Response

Success

datastoreIdstring required

The data store identifier.

imageSetIdstring required

The image set identifier.

latestVersionIdstring required

The latest image set version identifier.

imageSetState'ACTIVE' | 'LOCKED' | 'DELETED' required

The image set state.

imageSetWorkflowStatus'CREATED' | 'COPIED' | 'COPYING' | 'COPYING_WITH_READ_ONLY_ACCESS' | 'COPY_FAILED' | 'UPDATING' | 'UPDATING_FOR_STUDY_CONSISTENCY' | 'UPDATED' | 'UPDATE_FAILED' | 'DELETING' | 'DELETED' | 'IMPORTING' | 'IMPORTED' | 'IMPORT_FAILED'

The image set workflow status.

createdAtstring date-time

The timestamp when image set metadata was created.

updatedAtstring date-time

The timestamp when image set metadata was updated.

messagestring

The error message thrown if an update image set metadata action fails.