Qodex.ai

Convert Images Service.

POST {{baseUrl}}/session/services/convertimages

The Convert Images Real-Time Service provides image conversion capability as defined by an image conversion profile.

Capture Services currently only supports using system provided image conversion profiles named:

  • SplitPDFProfile,
  • SplitPDFtoPDFs, and
  • CombineSearchablePDFs”. SplitPDFProfile profile supports splitting PDF documents including colored documents resulting into tiff images of 300 DPI resolution. SplitPDFtoPDFs profile supports splitting multipage PDF document into single page PDF documents. “CombineSearchablePDFs” profile supports merging multipage PDF documents into a single mutltipage PDF document.

Service Properties

  • Env - Metadata environment identifier. Value must be S since SplitPDFProfile is system provided profile.

  • Profile - Required String. The Image conversion profile name to use for the conversion. Currently only system provided profiles name are “SplitPDFProfile”, “SplitPDFtoPDFs” and “CombineSearchablePDFs”.

  • ReturnFileDataInline - Boolean. If true, then the resulting file is returned inline in the result item as a base64 encoded file. If omitted or false, then the resulting file is returned as a fileId and can be retrieved through the Files resource. File ID referncing the resulting file is returned as part of URI in src property of File object of Result Item.

Number of Request Items

This Real-Time Service supports one or more items.

Values Per Request Item

No values are necessary or used.

Files Per Request Item

Each item can have one or more files. It can either be an embedded file or a reference to a file ID previously posted to the Files Resource.

The File Type property for the file must specify the file extension for the file, such as tif, png, jpg, pdf, etc. This is used by the Convert Images Real-Time Service for further typing of the file.

Request Body

{"serviceProps"=>[{"name"=>"Env", "value"=>"S"}, {"name"=>"Profile", "value"=>"SplitPDFProfile"}, {"name"=>"ReturnFileDataInline", "value"=>false}], "requestItems"=>[{"nodeId"=>1, "values"=>nil, "files"=>[{"name"=>"9PageSequencedPdf-G4", "value"=>"F_d327d432cdaf4ed5895cf72ee7b229bbPDF", "contentType"=>"application/pdf", "fileType"=>"pdf"}]}]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{"returnStatus":{"status":200,"code":"OK0000","message":"","server":"WS-S82d58e52200c4b85a2756dc5816ec639IS"},"licenseUsedPercent":0,"id":"ReqIMGCONV_378_0021007","serviceName":"convertimages","executionMilliSeconds":7731,"licensePagesUsed":0,"licensePagesUsed2":0,"resultItems":[{"nodeId":1,"errorCode":"","errorMessage":"","values":[],"files":[{"name":"9PageSequencedPdf-G4","value":"F_7dd9c7d28f134ddb82036b7bc444513fTIF","contentType":"image/tiff","src":"https://{host}/cp-rest/v2/session/files/F_7dd9c7d28f134ddb82036b7bc444513fTIF","fileType":"tif"},{"name":"9PageSequencedPdf-G41","value":"F_1d4d4a313a1546fb9235831431924008TIF","contentType":"image/tiff","src":"https://{host}/cp-rest/v2/session/files/F_1d4d4a313a1546fb9235831431924008TIF","fileType":"tif"},{"name":"9PageSequencedPdf-G42","value":"F_183640cd3e664c75a4fcaff3a357e725TIF","contentType":"image/tiff","src":"https://{host}/cp-rest/v2/session/files/F_183640cd3e664c75a4fcaff3a357e725TIF","fileType":"tif"},{"name":"9PageSequencedPdf-G43","value":"F_e8bdfa99296244bfab13f8a504ac915bTIF","contentType":"image/tiff","src":"https://{host}/cp-rest/v2/session/files/F_e8bdfa99296244bfab13f8a504ac915bTIF","fileType":"tif"},{"name":"9PageSequencedPdf-G44","value":"F_684447f71bfd4f43adcaa6aeec1dd793TIF","contentType":"image/tiff","src":"https://{host}/cp-rest/v2/session/files/F_684447f71bfd4f43adcaa6aeec1dd793TIF","fileType":"tif"},{"name":"9PageSequencedPdf-G45","value":"F_e2f6290908c2427a84a2d9fa0b43c539TIF","contentType":"image/tiff","src":"https://{host}/cp-rest/v2/session/files/F_e2f6290908c2427a84a2d9fa0b43c539TIF","fileType":"tif"},{"name":"9PageSequencedPdf-G46","value":"F_74660038bd374328b87c62b59f5fc041TIF","contentType":"image/tiff","src":"https://{host}/cp-rest/v2/session/files/F_74660038bd374328b87c62b59f5fc041TIF","fileType":"tif"},{"name":"9PageSequencedPdf-G47","value":"F_c0cf5674ac4648bc99073e7c9cb80219TIF","contentType":"image/tiff","src":"https://{host}/cp-rest/v2/session/files/F_c0cf5674ac4648bc99073e7c9cb80219TIF","fileType":"tif"},{"name":"9PageSequencedPdf-G48","value":"F_1d2049ff41024cbea2e8499fc323a19aTIF","contentType":"image/tiff","src":"https://{host}/cp-rest/v2/session/files/F_1d2049ff41024cbea2e8499fc323a19aTIF","fileType":"tif"}]}]}