Class Index

Classes


Conversion

Submits assets to the preview system to be converted to another format/resolution/scale/etc...
Defined in: conversion.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Conversion(data, verbose, fields)
For every object in "data", this endpoint converts the asset based on the conversion parameters.
Class Detail
Conversion(data, verbose, fields)
For every object in "data", this endpoint converts the asset based on the conversion parameters.
Parameters:
data
An array of objects. Note: directory parameter is required and must point to an existing path. [ { "id": 123456, "directory": "destination/path/", "format": "JPEG", "destinationColorspace": "RGB", "scale": "50%x50%", "resolution": "300dpi" }, ... ]
verbose Optional, Default: false
Setting this to true will collect a variety of default values for each asset.
fields Optional
An array of field id's to collect the values for each asset
Returns:
[{theConvertedAssetInfo}, ... ]
/wf/restapi/v2/conversion

Parameters:
data=[
         {"id":201623522,"directory":%20"destination/path/","format":%20"JPEG","destinationColorspace":%20"RGB","scale":%20"50%25x50%25","resolution":%20"300dpi"}
     ]

 Response:
 [
	 {
	   "id": 201629296,
	 }
 ]
/wf/restapi/v2/conversion

Parameters:
data=[
         {"id":201623522,"directory":%20"destination/path/","format":%20"JPEG","destinationColorspace":%20"RGB","scale":%20"50%25x50%25","resolution":%20"300dpi"},
         {"id":201628936,"directory":%20"destination/path/","format":%20"JPEG","resolution":%20"300dpi"}
     ]
verbose=true

 Response:
 [
	 {
	   "id": 201629296,
	   "name": "dreamstimemaximum_51640045_1.jpg",
	   "path": "destination/path/dreamstimemaximum_51640045_1.jpg",
	   "height": 1920,
	   "width": 2880,
	   "bytes": 2527904,
	   "lastModified": 1507829025000,
	   "mimeType": "image/jpeg",
	   "previews": {
		 "thumbnail": "../servlet/jb.view?table=thumbnails&col=thumbnails&id=pe_323031363239323936",
		 "viewex": "../servlet/jb.view?table=viewex&col=viewex&id=pe_323031363239323936",
		 "downloadUrl": "../servlet/dload?id=pe_323031363239323936"
	   }
	 },
	 {
	   "id": 201629295,
	   "name": "NYC.jpg",
	   "path": "destination/path/NYC.jpg",
	   "height": 752,
	   "width": 1280,
	   "bytes": 157371,
	   "lastModified": 1507827210000,
	   "mimeType": "image/jpeg",
	   "previews": {
		 "thumbnail": "../servlet/jb.view?table=thumbnails&col=thumbnails&id=pe_323031363239323935",
		 "viewex": "../servlet/jb.view?table=viewex&col=viewex&id=pe_323031363239323935",
		 "downloadUrl": "../servlet/dload?id=pe_323031363239323935"
	   }
	 }
 ]

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Dec 15 2023 01:44:01 GMT-0600 (CST)