Description

Returns binary data content interpreted as an image, and optionally transformed in various ways.

Parameters

DataId

integer: Id of the binary data content containing the image to retrieve.

FN

string: Optional file name to associate to the returned image.

Crop

comma-separated integers: Optional image crop rectangle - in the format x1,y1,x2,y2[,width,height], where 'width' and 'height' are the size of the original image the crop coordinates refer to.

See the note about changes of this command since 2.0.2117

ShowCrop

string: Show the cropping rectangle using a dashes line (='Dashes') or a grayed frame (='Grayed'), instead than executing the crop.

Rotation

integer: Optional rotation to apply to the image in tenth of degrees counterclockwise. Only multiples of 90 degrees are supported.

Flip

Flip the image horizontally.

Note

Since build 2.0.2117 the GN4 'Image' REST command is able to crop photos as required by VirtualCom web previews. The parameters are pix width, pix height and maximize (0/1). Examples:

http://localhost/GN4/do.ashx?Cmd=Image&DataId=XXX&crop=400,300,1

http://localhost/GN4/do.ashx?Cmd=Image&DataId=XXX&crop=250,-1,1

The value of -1 means that the dimension is free and depends on original image aspect ratio and the other specified size.