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

GetImageFrame

Get an image frame (pixel data) for an image set.

Request Syntax


POST /datastore/datastoreId/imageSet/imageSetId/getImageFrame HTTP/1.1
Content-type: application/json

{
   "imageFrameId": "string"
}

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

Request Body

The request accepts the following data in JSON format.

imageFrameId

The image frame (pixel data) identifier.

Type: String

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

Required: Yes

Response Syntax


HTTP/1.1 200
Content-Type: contentType

imageFrameBlob

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The response returns the following HTTP headers.

contentType

The format in which the image frame information is returned to the customer. Default is application/octet-stream.

Note

If the stored transfer syntax is 1.2.840.10008.1.2.1, the returned contentType is application/octet-stream.

If the stored transfer syntax is 1.2.840.10008.1.2.4.50, the returned contentType is image/jpeg.

If the stored transfer syntax is 1.2.840.10008.1.2.4.91, the returned contentType is image/j2c.

If the stored transfer syntax is MPEG2, 1.2.840.10008.1.2.4.100, 1.2.840.10008.1.2.4.100.1, 1.2.840.10008.1.2.4.101, or 1.2.840.10008.1.2.4.101.1, the returned contentType is video/mpeg.

If the stored transfer syntax is MPEG-4 AVC/H.264, UID 1.2.840.10008.1.2.4.102, 1.2.840.10008.1.2.4.102.1, 1.2.840.10008.1.2.4.103, 1.2.840.10008.1.2.4.103.1, 1.2.840.10008.1.2.4.104, 1.2.840.10008.1.2.4.104.1, 1.2.840.10008.1.2.4.105, 1.2.840.10008.1.2.4.105.1, 1.2.840.10008.1.2.4.106, or 1.2.840.10008.1.2.4.106.1, the returned contentType is video/mp4.

If the stored transfer syntax is HEVC/H.265, UID 1.2.840.10008.1.2.4.107 or 1.2.840.10008.1.2.4.108, the returned contentType is video/H256.

If the stored transfer syntax is 1.2.840.10008.1.2.4.202 or if the stored transfer syntax is missing, the returned contentType is image/jph.

If the stored transfer syntax is 1.2.840.10008.1.2.4.203, the returned contentType is image/jphc.

The response returns the following as the HTTP body.

imageFrameBlob: The blob containing the aggregated image frame information.

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

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