Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CopyImageSet

Copy an image set.

Request Syntax


POST /datastore/datastoreId/imageSet/sourceImageSetId/copyImageSet?force=force HTTP/1.1
Content-type: application/json

{
   "destinationImageSet": { 
      "imageSetId": "string",
      "latestVersionId": "string"
   },
   "sourceImageSet": { 
      "DICOMCopies": { 
         "copiableAttributes": "string"
      },
      "latestVersionId": "string"
   }
}

URI Request Parameters

The request uses the following URI parameters.

datastoreId

The data store identifier.

Pattern: [0-9a-z]{32}

Required: Yes

force

Providing this parameter will force completion of the CopyImageSet operation, even if there are inconsistent Patient, Study, and/or Series level metadata elements between the sourceImageSet and destinationImageSet.

sourceImageSetId

The source image set identifier.

Pattern: [0-9a-z]{32}

Required: Yes

Request Body

The request accepts the following data in JSON format.

destinationImageSet

The destination image set.

Type: CopyDestinationImageSet object

Required: No

sourceImageSet

The source image set.

Type: CopySourceImageSetInformation object

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "datastoreId": "string",
   "destinationImageSetProperties": { 
      "createdAt": number,
      "imageSetArn": "string",
      "imageSetId": "string",
      "imageSetState": "string",
      "imageSetWorkflowStatus": "string",
      "latestVersionId": "string",
      "updatedAt": number
   },
   "sourceImageSetProperties": { 
      "createdAt": number,
      "imageSetArn": "string",
      "imageSetId": "string",
      "imageSetState": "string",
      "imageSetWorkflowStatus": "string",
      "latestVersionId": "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.

datastoreId

The data store identifier.

Type: String

Pattern: [0-9a-z]{32}

destinationImageSetProperties

The properties of the destination image set.

Type: CopyDestinationImageSetProperties object

sourceImageSetProperties

The properties of the source image set.

Type: CopySourceImageSetProperties object

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