Documentation Dynamic Media Image Serving and Rendering API

Image Serving HTTP protocol basic syntax image-serving-http-protocol-basic-syntax

Last update: Tue Aug 31 2021 00:00:00 GMT+0000 (Coordinated Universal Time)

Topics:
Dynamic Media Classic,SDK/API

CREATED FOR:

Developer
User

The HTTP protocol basic syntax is as follows:

request

http:// server/is/image[/ object][? modifiers]

server

server_address[: port]

object

Source object specifier (image path or image catalog entry).

modifiers

modifier*[& modifier]

modifier

command|{$ macro$}|{. comment}

command

{ cmdName|{$ var}}[= value]

macro

Name of a command macro.

comment

Comment string (ignored by server).

cmdName

One of the supported command or attribute names.

var

Name of a custom variable.

value

Command or variable value.

server_address, cmdName, macro, and var are case-insensitive. The server preserves the case of all other string values.

value is command-specific and can consist of one or more values separated by commas. Refer to the description of the individual commands for details.

Server identifier section-926ae55ddba14b8d952147a5fd701e14

The /is/image root context is required for all HTTP requests to Image Serving.

HTTP decoding section-20922baccd804d2d986b44ce9a183a7d

Image Serving first extracts object and modifiers from the incoming request. object is then separated into path elements which are individually HTTP-decoded. The modifiers string is separated into command= value pairs, and value is then HTTP-decoded before command-specific processing.

NOTE

Unless otherwise noted in the documentation, all unsafe characters must be encoded per the HTTP standard. Refer to the HTTP specification for details.

Comments section-69ef0be0f17a418c87a0eba21c2ddb00

Comments can be embedded into request strings anywhere and are identified by a period(.) immediately following the command separator(&). The comment is terminated by the next occurrence of an (unencoded) command separator. This feature can be used to add information to the request which is not for Image Serving use, such as time stamps, and database IDs.

Image Serving HTTP protocol basic syntax image-serving-http-protocol-basic-syntax

Server identifier section-926ae55ddba14b8d952147a5fd701e14

HTTP decoding section-20922baccd804d2d986b44ce9a183a7d

Comments section-69ef0be0f17a418c87a0eba21c2ddb00

See also section-d0b836568c31454b8dbeb136e6bbe0f0