このセクションでは、REST (Representational State Transfer)を使用して、URLをフォーマットし、ドキュメントの1ページのレンディションをリクエストする方法を説明します。RESTリクエストを使用して、IMGタグのSRC属性にREST URLを組み込めるようにすることにより、ドキュメントのHTML表示を簡略化できます。これにより、ネイティブ・アプリケーションやブラウザのサポートに関係なくドキュメントのページを表示できるようになるので便利です。
REST URLは次の形式で記述します。使用するパラメータについては、表11-1にまとめます。また、後述のサンプルURLも参照してください。
http[s]://<hostname:port>/imaging/renderimage[/#pct][/#deg][/fitmode][/crop#T#L#H#W][/annotations[true|false]][/page#][/download][/version#]/<documentId>.<format>
注意:
パラメータ名は、REST URL形式での指定と同じ位置(前または後)に入力します。たとえば、pctおよびdegパラメータでは、名前の前に数字がつきますが、pageパラメータでは名前の後につきます。
REST URLの例
URLの例 | 説明 |
---|---|
http://myserver:16000/imaging/renderimage/IPM7_170001.JPEG |
IDがIPM7_170001のドキュメントの1ページ目にあるJPEGを取得します |
http://myserver:16000/imaging/renderimage/50pct/page2/IPM7_170001.PNG |
ドキュメントの2ページ目にあるPNGを50%に縮小して取得します |
http://myserver:16000/imaging/renderimage/fitbest/crop0T0L100H100W/page5/IPM7_170001.JPEG |
ドキュメントの5ページ目を100ピクセル四方の正方形に合わせて表示します |
http://myserver:16000/imaging/renderimage/page5/download/IPM7_170001.GIF |
ドキュメントの5ページ目をGIFとしてダウンロードします |
http://myserver:16000/imaging/renderimage/180deg/IPM7_170001.JPEG |
ドキュメントの1ページ目を180度回転させて表示します |
http://myserver:16000/imaging/renderimage/20pct/270deg/annotationsfalse/page3/download/version2/IPM7_170001.JPEG |
あるドキュメントの2つ目のバージョンの3ページ目を元の高さの20%で、270度回転させて、注釈をオフにしてダウンロードします |
表11-1 REST URLパラメータ
パラメータ | 説明 |
---|---|
pct |
ドキュメントの表示スケールを表すパーセント(整数)を指定します。たとえば、100ならばドキュメントのサイズはそのままで、スケールが50だと元のサイズの50%で表示されます。 |
deg |
ドキュメントの回転角度を度単位で指定します。指定できる回転角度は0、90、180、および270です。 |
fitmode |
ページをトリミングするには、このパラメータにfitモード(fitwidth、fitheightまたはfitbest)を指定し、cropパラメータを使用してトリミング矩形を指定します。ページは、指定されたトリミング寸法に基づき、fitモードに従って表示されます。 (ただし、cropパラメータが指定されていない場合、このパラメータは無視されます) |
crop |
ページをトリミングするには、crop矩形の寸法を指定します。ページは、指定されたトリミング矩形の寸法に基づき、fitモード(fitwidth、fitheightまたはfitbest)に従って表示されます。 形式は#T#L#H#Wを使用しますが、これはjava.awt.Rectangleのtop、left、heightおよびwidthプロパティに相当します。たとえば、top=10、left=20、height=100およびwidth=200の長方形の場合は、次のように指定します。 crop10T20L100H200W (fitmodeパラメータが指定されていない場合、またはfitmodeがfitscaleとして指定されている場合、このパラメータは無視されることに注意してください。) |
annotations |
レンダリングしたページに注釈を適用する場合はtrue、省略する場合はfalseを指定します。 |
page |
表示するページを指定します。たとえば、複数ページにわたるTIFFファイルの2ページ目を表示するには2を指定します。 ページはコール側に未加工のページ・データとして返されます。これには適切なmimeタイプと推奨ファイル名を指定するヘッダー情報が含まれます。 |
download |
このパラメータが含まれている場合、クライアントによりブラウザの「開く」/「保存」/「キャンセル」ダイアログ・ボックスにファイルがダウンロードされます。その後、レンディションが圧縮され、コール側に戻されます。 含まれていない場合、ページのレンダリングのみが行われます。 |
version |
レンダリングするドキュメントのバージョンを指定します。 |
documentId |
レンダリングするドキュメントのID(たとえば、Webインタフェースから提供されたもの)を指定します。 |
format |
レンダリングするドキュメントのバージョンを指定します。サポートされているフォーマットは、TIFF、PNG、GIF、およびJPEGです。 |