UpdateImageSetMetadata
Update image set metadata attributes.
Request Syntax
POST /datastore/datastoreId
/imageSet/imageSetId
/updateImageSetMetadata?latestVersion=latestVersionId
HTTP/1.1
Content-type: application/json
{
"DICOMUpdates": {
"removableAttributes": blob
,
"updatableAttributes": blob
}
}
URI Request Parameters
The request uses the following URI parameters.
- datastoreId
-
The data store identifier.
Pattern:
[0-9a-z]{32}
Required: Yes
- imageSetId
-
The image set identifier.
Pattern:
[0-9a-z]{32}
Required: Yes
- latestVersionId
-
The latest image set version identifier.
Pattern:
\d+
Required: Yes
Request Body
The request accepts the following data in JSON format.
- DICOMUpdates
-
The object containing
removableAttributes
andupdatableAttributes
.Type: DICOMUpdates object
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"createdAt": number,
"datastoreId": "string",
"imageSetId": "string",
"imageSetState": "string",
"imageSetWorkflowStatus": "string",
"latestVersionId": "string",
"message": "string",
"updatedAt": number
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- createdAt
-
The timestamp when image set metadata was created.
Type: Timestamp
- datastoreId
-
The data store identifier.
Type: String
Pattern:
[0-9a-z]{32}
- imageSetId
-
The image set identifier.
Type: String
Pattern:
[0-9a-z]{32}
- imageSetState
-
The image set state.
Type: String
Valid Values:
ACTIVE | LOCKED | DELETED
- imageSetWorkflowStatus
-
The image set workflow status.
Type: String
Valid Values:
CREATED | COPIED | COPYING | COPYING_WITH_READ_ONLY_ACCESS | COPY_FAILED | UPDATING | UPDATED | UPDATE_FAILED | DELETING | DELETED
- latestVersionId
-
The latest image set version identifier.
Type: String
Pattern:
\d+
- message
-
The error message thrown if an update image set metadata action fails.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
[\w -:]+
- updatedAt
-
The timestamp when image set metadata was updated.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The user does not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
Updating or deleting a resource can cause an inconsistent state.
HTTP Status Code: 409
- InternalServerException
-
An unexpected error occurred during processing of the request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The request references a resource which does not exist.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
The request caused a service quota to be exceeded.
HTTP Status Code: 402
- ThrottlingException
-
The request was denied due to throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints set by the service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: