GET - resources/{resourceType}/download

Download an Asset from the server

URI

resources/{resourceType}/download

HTTP Method

Get

Request parameters

Name	Location	Type	Description

Name	Location	Type	Description
resourceType	uri	string	The type of the resource
id	query	string	The resource's id
path	query	string	The path to the resource
name	query	string	The name of the resource
type	query	string	The (quality) type
page	query	int	The number of the page
client_app	query	string	The name of the client application
colorType	query	string	The type of the color
noContentHeader	query	bool	Boolean flag indicating if a content-disposition header should be added
taskId	query	string	The id of the download task
docId	query	string	The document's id
scale	query	int	The scale of the page preview
ipadItemPath	query	string	The path for the asset download on ipad
transformationID	query	string	Image transformation's id
transformationName	query	string	The name of the image transformation
async	query	bool	Boolean flag indicating if a font preview generation task should be run asynchronously
taskPriority	query	int	The priority (1-10) of the font's preview generation task

Quality Types

Whether you use the REST endpoint or the ASPX one, the usage is the same. Both endpoints allow you to define a type parameter. We have a few built-in types. These built-in types do not count as a render.

Type	Description

Type	Description
thumbnail	proportionally scaled image so one side is 100px, 72dpi, RGB png
low	same a thumbnail
medium	proportionally scaled image so one side is 250px, 72dpi, RGB png
high	proportionally scaled image so one side is 600px, 72dpi, RGB png
highest	proportionally scaled image so one side is 2000px, 72dpi, RGB png. This is true until the document reaches 2000px in actual size (72dpi conversion), and then the size matches pixel conversion size. So an A1 document 594 x 841 mm will end up being a 1684 x 2384 px image. The conversion rate fluctuates by a few pixels.
full	original file size as RGB png or same as highest
original	original file

HTTP Return Status

Ok

Returns

taskXML

An XML string describing the created task, containing its ID and other information.

GraFx Publisher Documentation