Process Image Service.

POST {{baseUrl}}/session/services/processimage

The Process Image Real-Time Service provides image processing capability as defined by an image processor profile defined in the Designer.

Service Properties

• Env - Metadata environment identifier. Value is one of D, T or P. Default value is P.

• Profile - Required String. The Image processor profile name to use.

• 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.

• Redact - Boolean. Image will be redacted using “Rectangles” property passed in Request Item. Redaction will be done before profile filter processing if profile name is passed in. “Profile” property is optional when “Redact” property is “True”.

Number of Request Items

This Real-Time Service supports one or more items.

Values Per Request Item

• Rectangles - Optional Object. Array of rectangles marking areas on image to be redacted. This parameter is used only when service property “Redact” is set to true. Rectangle identified by values in the order of Left, Top, Width, and Height. All values are Pixels with a resolution of 96 dpi in both X and Y direction. { left:, top:, width:, height: }

Files Per Request Item

There can only be one file per request item object. 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 is ignored for this service.

Body PARAM

HEADERS

Content-Type

RESPONSES

status OK