Rasterize File

Converts a PDF, PS, AFP or PCL file into a bitmap. The conversion can be done for a single page or for multiple pages.

Request takes JSON Bitmap Parameters JSON Bitmap Parameters as content, and on success returns the converted page as a PNG or JPEG file, or returns a ZIP file with the converted images (PNG/JPEG) if rasterization is requested for more than one page.

Request

Method Type:

POST

URI:

/rest/serverengine /workflow/rasterize/{dataFileID}

Content: JSON Bitmap Parameters
Content Type:

application/json

Add. Headers:

If server security settings are enabled, then one of the following:

  • Authorization – Basic Authentication (Username and Password) credentials (Base64 encoded)
  • auth_token – Authorization Token

Parameters

Path

Name Required Type Default Value Description

dataFileId

Yes Number –

The Managed File ID (or Name) of a PDF, PS, AFP or PCL file in the File Store

Response

Success

The following lists status codes indicative of a successful response:

Status Code Content Content-Type Add. Headers Description
200
OK		 A stream with a JPEG/PNG image or a ZIP file with JPEG/PNG images application/zip, image/jpeg, or image/png   Bitmap creation successful

Error

The following lists status codes indicative of a failed or error response:

Status Code Content Content-Type Add. Headers Description

401 Unauthorized

JSON Error specifying error message

application/json

WWW-Authenticate – BASIC (Basic Authentication credentials are accepted)

Server authentication has failed.

Response when either:

  • basic authentication credentials nor an authorization token have been specified in the request headers

  • the basic authentication credentials or the authorization token specified in the request headers are invalid

  • the authorization token specified in the request headers has now expired

403 Forbidden

JSON Error specifying error message

application/json

–

Server authentication has succeeded, but user authorization for this specific method has failed.

Response when authentication of the credentials or the authorization token specified in the request headers has succeeded, but the user associated with the credentials or the authorization token specified has insufficient role assignment/privileges.

404 Not Found

JSON Error specifying error message

application/json

 

ID of uploaded PDF, PS, PCL, or AFP data file cannot be found in filestore