DocumentationDynamic Media Image Serving and Rendering API

Serving static (non-image) content serving-static-non-image-content

Last update: Fri Nov 03 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • User

Image Serving provides a mechanism to manage non-image contents in catalogs and serve it by way of a separate context /is/content. The mechanism allows for configuring the TTL for each item separately.

Basic syntax section-a986baaca8644d04bcd0ddf781ae916e

request
http:// server /is/content[/ catalog / item ][? modifiers ]
server
server_address [: port ]
catalog
Catalog identifier.
item
Static content item ID.
modifiers
command *[& command ]
command
cmdName = value
cmdName
One of the supported command names.
value
Command value.

Command overview section-61657a0141914053ab12038ad7e91500

Image Serving supports the following commands at /is/content:

type
Content type filter.
req
req=userdata , req=props , and req=exists only.
cache
Allows disabling client-side caching.

Static content catalogs section-b2b8f4860fe84e528493ed704c7c5141

Static content catalogs are similar to image catalogs, but support fewer data fields:

Attribute/Data
Notes
catalog::Id
The catalog record identifier for this static content item
catalog::Path
The file path for this content item
catalog::Expiration
The TTL for this content item; attribute::Expiration is used if not specified or if empty
catalog::TimeStamp
File modification time stamp; required when catalog-based validation is enabled with attribute::CacheValidationPolicy
catalog::UserData
Optional metadata associated with this static content item; available to the client with req=userdata
catalog::UserType
Optional data type; can be used to filter requests for static content with the type= command

Filtering static content section-896c37cf68bc446eb0766fb378898262

This mechanism can help ensure that clients receive only contents appropriate for their needs. Assuming that the static content is tagged with appropriate catalog::UserTypevalues, the client can add the type= command to the request. Image Serving compares the value provided with the type= command to the value of catalog::UserType and, in case of a mismatch, return an error instead of potentially inappropriate contents.

See also section-91c7b686aacf4d3ca974f35a3fe3d6ec

type= , req=, Image Catalog Reference

recommendation-more-help
a26166cd-f2f4-45ce-996d-96a0f0d6cf49