Edition Flex demo

Edition Flex の連携用API一覧

本WebアプリケーションのURLの後に、/document/API を指定します。

getの例：
http://demo.reso.co.jp/flex5/document/jpeg?flexId=xxxxxxx&rasterDpi=50&pageList=1

postの例：

<form method="post" action="http://demo.reso.co.jp/flex5/document/layout">
	<input type="hidden" name="relayUserId " value="xxxx">
	:
	<input type="hidden" name="srcType" value="flexScript">
	<textarea name="flexScript">page</textarea>
	:
</form>

Flexの存在確認

API	説明	パラメータ
alive	flexの生存確認をします。生存していれば、"alive" という文字列が返ります。このAPIは呼び出し後にセッションを破棄します。	なし

編集開始（編集画面無しで、PDF生成、JPEG生成も同様）

（注意）セッションを破棄します。

API	説明	パラメータ
layout	テンプレートを指定して、編集を開始します。	認証： relayUserId : 連携ログイン用ユーザID dtime : 連携ログイン日時 clientId : 連携ログインクライアントID 呼び出し画面： prepareName : 編集開始画面ページ名（呼び出し画面）結果： resultType : 連携ログイン結果取得タイプ resultName : 編集終了画面ページ名（戻り画面） returnUserId : 呼び出し元に戻る場合の連携ログイン用ユーザID(省略時はrelayUserIdと同じ) returnURL : 連携ログイン後の戻りURL errorURL : エラー時の戻りURL 編集対象： resourceType : 取得するリソースのタイプ（*"template"/"document"/"cassette") srcType : テンプレート指定方法 └ "create" : 新規テンプレート作成 └ "trackingId" : テンプレート識別コード └ "templateName" : テンプレート名称 └ "flexScript" : flexScriptで指定 └ "remotefile" : URLで lla ファイルを指定 └ "flexId" : 既にFlexにドキュメントがある場合そのflexIdで指定 pageSize : srcTypeが "create" の場合のページサイズ(CSVで指定）省略時はA4縦余白無し　　幅, 高さ, 上余白, 右余白, 下余白, 左余白 trackingId : srcTypeが "trackingId" の場合のテンプレート識別コード templateName : srcTypeが "templateName" の場合のテンプレート名 flexScript : srcTypeが "flexScript" の場合のページ定義 remotefile : srcTypeが "remotefile" の場合のURL └remoteUser : remotefileのBasic認証ID └remotePasswd : remotefileのBasic認証パスワード編集画面： editorType : 編集タイプ forceLayout : 編集中の場合でも強制的に編集開始する（multiMode == false時） multiMode : 同一セッション複数編集モード purposeName : 編集画面の用途 pagePurposeNames : ページ毎の用途（カンマ区切り） pageNo : 編集開始ページ pageSaveURL : 編集画面で「保存」された場合の通知先（"svg","lla"のみ） pageSaveMode : pageSaveURLが指定された場合の通知方法（"svg","lla"） pageSavePath : 保存時の保存先パス pageSaveVpath : 保存時の仮想パス。CMSのproviderTagModeがtrueの場合、「folder/ 仮想パス」でタグが設定される pageSaveMode（拡張） : 編集時保存方法（"document"/"template"/"cassette"でプロバイダへ保存） pageSaveTrackingId : 保存時のtrackingId（指定されている場合は上書き、指定なしの場合は新規） savedAtEnd : 編集画面終了時自動保存し、returnURLに戻る（主にpageSaveModeが "document"） keepAlive : true を指定すると、savedAtEnd でreturnURLに戻る際にセッションを破棄しない purge : true を指定すると、savedAtEnd で戻る際に自動で remove API 呼び出しをする（通常はtrueを指定してください） forceSave : savedAtEnd の時に、無編集でも強制保存 autoTouch : 呼び出し元アプリに戻る前にドキュメントの一時保存状態を解除し正規保存とする(savedAtEndがtrue時のみ） editorLaml : editor.laml(テンプレートのeditor.lamlよりも優先します) editorMaterialBasePath : 編集画面での素材基準パス editorCassetteBasePath : 編集画面でのカセット基準パス editorTemplateBasePath : 編集画面でのテンプレート基準パスその他オプション： layoutId : 編集画面呼び出し時のID（任意、各プロバイダAPIでパラメータとして通知されます） checkMaterial : 素材・カセットの存在チェック injectionData : 差し込みデータ（先頭が"{"だとJSON形式と判断） disableUpdatingInjectionDataByParts : 差し込みデータにパーツの内容を上書きする処理を停止（injectionData を正とする） forceUpdateInjectiionData : injectionData の差し込み処理でカセットの trackingIdが変わらない場合でも差し込みを強制する editScript : 編集スクリプト enableIncludedEditScript : テンプレート同梱EditScriptの実行フラグ traceNoticeURL : EditScript 中の trace() の内容をPOSTするURLを指定します。 scriptTimeoutSec : スクリプト実行のタイムアウト（デフォルト60sec） pageList : 編集前に指定ページのみを残して他のページを削除する flex3dURL : プレビュー(type=3D)でFlex3Dを呼び出す時のURL（パラメータ付き） recordCSV : EditScript内で利用可能なCSVデータファイル（１行目がタイトルで２行目以降がデータ） recordCSVEncode : recordCSVの文字エンコード（SJIS/MS932/UTF-8など） UTF-8を推奨　※無指定の場合は自動判定を試み、自動判定に失敗した場合はMS932となります。 saveToProviderEventURL : 指定されている場合ドキュメント・テンプレート保存時に通知する。（trackingIdとlayoutIdをPOST） annotationManagerURL : 注釈マネージャー
wizard	テンプレートを指定して、ウイザード編集を開始します。	認証： relayUserId : 連携ログイン用ユーザID dtime : 連携ログイン日時 clientId : 連携ログインクライアントID 結果： returnURL : 連携ログイン後の戻りURL errorURL : エラー時の戻りURL 編集対象： productTrackingId : テンプレートから編集開始する場合のテンプレート documentTrackingId : ドキュメントを再編集する場合のドキュメント saveNew : ドキュメント再編集でtrueのときは、新規ドキュメントとして保存編集画面： forceLayout : 編集中の場合でも強制的に編集開始する（multiMode == false時） purposeName : 編集画面の用途その他オプション： injectionData : 編集前差し込み処理兼、デフォルトの編集データ disableUpdatingInjectionDataByParts : 差し込みデータにパーツの内容を上書きする処理を停止（injectionData を正とする） forceUpdateInjectiionData : injectionData の差し込み処理でカセットの trackingIdが変わらない場合でも差し込みを強制する editScript : 編集スクリプト enableIncludedEditScript : テンプレート同梱スクリプトの実行フラグ traceNoticeURL : EditScript 中の trace() の内容をPOSTするURLを指定します。 editorLaml : editor.laml(テンプレートのeditor.lamlよりも優先します) flex3dURL : プレビュー(type=3D)でFlex3Dを呼び出す時のURL（パラメータ付き） keepAlive : true を指定すると、戻る際にセッションを破棄しない（通常は指定しないでください） purge : true を指定すると、戻る際に自動で remove API 呼び出しをする（通常はtrueを指定してください）
layoutAgain	編集画面終了後、編集画面に戻る際に呼び出します。セッション中でのみ利用可能です。	なし
touch	新規ドキュメント作成時、編集画面から、trackingIdが戻った事をWebアプリから通知します。 savedAtEndがtrue で、autoTouchが無指定もしくはtrueの場合は不要です。 autoTouchが無効もしくはfalseの場合は、Flexを呼び出したアプリが、明示的にtouch APIを呼び出さないと、ドキュメントが一時保存の状態のままとなり、一定時間後に自動削除されます。	認証： relayUserId : 連携ログイン用ユーザID dtime : 連携ログイン日時 clientId : 連携ログインクライアントID 対象： trackingId :ドキュメントのtrackingId
produce	編集画面を開かずに、EditSriptで編集処理をして、PDFやJPEGを生成します EditScriptは layout API の呼び出しと同じものも指定できますが、本APIの目的はPDFやJPEGを生成することにありますので、差し込み等の処理をしながらPDFやJPEG出力処理をするようなEditScriptが期待されています。本APIの呼び出しでEditScriptを指定しない場合は、全ページを無加工で出力するEditScriptが自動で設定されます。データCSVファイルをアップロードする為には認証パラメータは使えず、relay で予めセッションを開始しておく必要があります。 background=trueを指定した場合には、バックグラウンド処理情報を返します。バックグラウンド処理は、queueIdを指定して、 bgprogress（進捗） / bgabort（中断） / bgdownload（結果取得）のAPIを利用して、操作します。 10分以内に処理が完了しない場合には、処理継続のために bgprogressを呼び出してください。 PDF生成時のパラメータは、pdfOptionSetNameで基本となるパラメータとして、 PDFOption設定ファイルののセット名を指定し、そのパラメータに対して、個別のパラメータ指定で上書き指定します。処理後は必ずremoveされます。連続して呼び出す場合で、ログイン状態を継続する場合は、purge=false 通常は、purge=true を指定して、セッションを自動破棄させてください。（注意）background=trueの場合は、セッションを破棄します。	認証： relayUserId : 連携ログイン用ユーザID dtime : 連携ログイン日時 clientId : 連携ログインクライアントID 編集対象： resourceType : 取得するリソースのタイプ（*"template"/"document"/"cassette") srcType : テンプレート指定方法 └ "create" : 新規テンプレート作成 └ "trackingId" : テンプレート識別コード └ "templateName" : テンプレート名称 └ "flexScript" : flexScriptで指定 └ "remotefile" : URLで lla ファイルを指定 └ "flexId" : 既にFlexにドキュメントがある場合そのflexIdで指定 pageSize : srcTypeが "create" の場合のページサイズ(CSVで指定）省略時はA4縦余白無し　　幅, 高さ, 上余白, 右余白, 下余白, 左余白 trackingId : srcTypeが "trackingId" の場合のテンプレート識別コード templateName : srcTypeが "templateName" の場合のテンプレート名 flexScript : srcTypeが "flexScript" の場合のページ定義 remotefile : srcTypeが "remotefile" の場合のURL └remoteUser : remotefileのBasic認証ID └remotePasswd : remotefileのBasic認証パスワードその他オプション： layoutId : 編集画面呼び出し時のID（任意） injectionData : 差し込みデータ disableUpdatingInjectionDataByParts : 差し込みデータにパーツの内容を上書きする処理を停止（injectionData を正とする） forceUpdateInjectiionData : injectionData の差し込み処理でカセットの trackingIdが変わらない場合でも差し込みを強制する editScript : 編集スクリプト enableIncludedEditScript : テンプレート同梱スクリプトの実行フラグ traceNoticeURL : EditScript 中の trace() の内容をPOSTするURLを指定します。 scriptTimeoutSec : スクリプト実行のタイムアウト（デフォルト60sec） pageList : 編集前に指定ページのみを残して他のページを削除する recordCSV : EditScript内で利用可能なCSVデータファイル（１行目がタイトルで２行目以降がデータ） recordCSVEncode : recordCSVの文字エンコード（SJIS/MS932/UTF-8など） UTF-8を推奨　※無指定の場合は自動判定を試み、自動判定に失敗した場合はMS932となります。出力オプション： pdfOptionSetName : PDFOption パラメータセット名（省略時"print"） highResolution : 高解像度指定ON/OFF sampleMark : 見本マークON/OFF sampleMarkStr : 見本マーク文字列 sampleMarkTrackingId : 見本マーク素材識別コード trimMargine : 余白トリミングON/OFF checkFont : フォントチェックON/OFF pdfVersion : PDFバージョン cmyk : CMYK出力ON/OFF pdfMasterPassword : PDFのマスターパスワード pdfUserPassword : PDFのユーザパスワード pdfPermissions : PDFの制限 background : バックグラウンド処理を開始　true/false 結果(background=trueの場合)： queueId : バックグラウンド処理識別子 documentName : ドキュメント名 cache : trueの場合、no-cacheヘッダを出力しない purge : trueの場合、PDF生成後セッションも破棄します
upload	テンプレートをアップロードします。 formで画面遷移をするためには、予め relay でセッションを開始しておく必要があります。アップロード編集の例あるいは、editorType=injection, resultType=textで、Webアプリから呼び出し、flexIdを結果として取得し、そのflexIdを layout API のパラメータで指定して編集を開始する事もできます。	基本的に layout API と同じです。（srcTypeは指定できません）ブラウザのファイルアップロード同様、 multipart/form-dataでPOSTします。 resourcefile : ファイルアップロードのパラメータ名

Flexが保存している編集結果の取得と削除

API	説明	パラメータ
relay	download, pdf, jpeg, remove, upload を呼び出す際に、予めログインしておく為に呼び出します。 Edition Flexに連携ログインし、セッションを開始します。	認証： relayUserId : 連携ログイン用ユーザID dtime : 連携ログイン日時 clientId : 連携ログインクライアントID 結果： resultType : 連携ログイン結果取得タイプ resultName : 編集終了画面ページ名（戻り画面） returnUserId : 呼び出し元に戻る場合の連携ログイン用ユーザID(省略時はrelayUserIdと同じ) returnURL : 連携ログイン後の戻りURL
download	編集結果を .lla ファイルでダウンロードします。	認証： relayUserId : 連携ログイン用ユーザID dtime : 連携ログイン日時 clientId : 連携ログインクライアントID 対象： flexId : 編集結果を示すID
pdf	編集結果を PDFファイルでダウンロードします。 PDF生成時のパラメータは、pdfOptionSetNameで基本となるパラメータとして、 PDFOption設定ファイルののセット名を指定し、そのパラメータに対して、個別のパラメータ指定で上書き指定します。	認証： relayUserId : 連携ログイン用ユーザID dtime : 連携ログイン日時 clientId : 連携ログインクライアントID 対象： flexId : 編集結果を示すID オプション： pdfOptionSetName : PDFOption パラメータセット名（省略時"print"） highResolution : 高解像度指定ON/OFF sampleMark : 見本マークON/OFF sampleMarkStr : 見本マーク文字列 sampleMarkTrackingId : 見本マーク素材識別コード trimMargine : 余白トリミングON/OFF checkFont : フォントチェックON/OFF pdfVersion : PDFバージョン cmyk : CMYK出力ON/OFF pdfMasterPassword : PDFのマスターパスワード pdfUserPassword : PDFのユーザパスワード pdfPermissions : PDFの制限 cache : trueの場合、no-cacheヘッダを出力しない purge : trueの場合、PDF生成後 remove 処理を行いセッションも破棄します
jpeg	編集結果を JPEGファイルでダウンロードします。生成時のパラメータは、pdfOptionSetNameで基本となるパラメータとして、 PDFOption設定ファイルののセット名を指定し、そのパラメータに対して、個別のパラメータ指定で上書き指定します。	認証： relayUserId : 連携ログイン用ユーザID dtime : 連携ログイン日時 clientId : 連携ログインクライアントID 対象： flexId : 編集結果を示すID オプション： pdfOptionSetName : PDFOption パラメータセット名（"省略時jpeg"） highResolution : 高解像度指定ON/OFF sampleMark : 見本マークON/OFF sampleMarkStr : 見本マーク文字列 sampleMarkTrackingId : 見本マーク素材識別コード trimMargine : 余白トリミングON/OFF checkFont : フォントチェックON/OFF rasterDpi : JPEGのDPI(Dot Per Inchi) rasterPxSize : JPEGの最大サイズ rasterSmoothing : スムージングON/OFF cache : trueの場合、no-cacheヘッダを出力しない purge : trueの場合、jpeg生成後 remove 処理を行いセッションも破棄します
png	編集結果を PNGファイルでダウンロードします。生成時のパラメータは、pdfOptionSetNameで基本となるパラメータとして、 PDFOption設定ファイルののセット名を指定し、そのパラメータに対して、個別のパラメータ指定で上書き指定します。	認証： relayUserId : 連携ログイン用ユーザID dtime : 連携ログイン日時 clientId : 連携ログインクライアントID 対象： flexId : 編集結果を示すID オプション： pdfOptionSetName : PDFOption パラメータセット名（"省略時png"） highResolution : 高解像度指定ON/OFF sampleMark : 見本マークON/OFF sampleMarkStr : 見本マーク文字列 sampleMarkTrackingId : 見本マーク素材識別コード trimMargine : 余白トリミングON/OFF checkFont : フォントチェックON/OFF rasterDpi : PNGのDPI(Dot Per Inchi) rasterPxSize : PNGの最大サイズ rasterSmoothing : スムージングON/OFF cache : trueの場合、no-cacheヘッダを出力しない purge : trueの場合、png生成後 remove 処理を行いセッションも破棄します
remove	flexId : 編集結果を示すID 編集結果を削除します。一定時間アクセスが無い場合も自動削除されますが、明示的に削除する場合に利用します。	認証： relayUserId : 連携ログイン用ユーザID dtime : 連携ログイン日時 clientId : 連携ログインクライアントID 対象： flexId : 編集結果を示すID

バックグラウンド処理の操作API

bgprogress	バックグラウンド処理の状況を取得します。バックグラウンド処理は、１０分（デフォルト）で、タイムアウト停止しますので、それ以上処理を継続する場合は、時間内にbgprogressを定期的に呼び出してください。（注意）セッションを破棄します。	認証： relayUserId : 連携ログイン用ユーザID dtime : 連携ログイン日時 clientId : 連携ログインクライアントID 対象： queueId : バックグラウンド処理を示すID 結果： status : 処理状態(queued\|started\|stopped\|abortRequested) statusString : 処理状態文字列(実行待\|実行中\|実行完了\|中断処理中) result : 処理結果(success\|error\|aborted) extra : 処理結果付加情報(文字列)
bgabort	バックグラウンド処理の中断を指示します。バックグラウンド処理の都合上、即時ではなく、直近の停止可能タイミングでの停止となります。（注意）セッションを破棄します。	認証： relayUserId : 連携ログイン用ユーザID dtime : 連携ログイン日時 clientId : 連携ログインクライアントID 対象： queueId : バックグラウンド処理を示すID 結果： abortresult : 中断依頼結果(abortRequested\|invalidStatus) status : 処理状態(queued\|started\|stopped\|abortRequested) statusString : 処理状態文字列(実行待\|実行中\|実行完了\|中断処理中) result : 処理結果(success\|error\|aborted) extra : 処理結果付加情報(文字列)
bgdownload	バックグラウンド処理処理結果を取得します。（注意）セッションを破棄します。	認証： relayUserId : 連携ログイン用ユーザID dtime : 連携ログイン日時 clientId : 連携ログインクライアントID 対象： queueId : バックグラウンド処理を示すID 結果：バックグラウンド処理が正常に終了していた場合には、バックグラウンド処理ではない場合と同じデータをダウンロードします。バックグラウンド処理が終了していない場合には、「400 Bad Request」を返します。 bgprogressにて状況を確認してから処理結果を取得してください。

以下のいずれかの方法でテンプレートを指定します。

指定方法	srcType	説明	テンプレート指定パラメータ
識別コード指定	trackingId	テンプレートプロバイダに登録済みのテンプレートを、識別コードで指定します。	trackingId : テンプレートの識別コード
テンプレート名称指定	templateName	テンプレートプロバイダに登録済みのテンプレートを、名称で指定します。	templateName : テンプレート名
URL指定	remotefile	Edition Flex からアクセス可能なURLでテンプレートのllaファイルを指定します。	remotefile : URL remoteUser : Basci/Digest認証ユーザID remotePasswd : Basci/Digest認証パスワード
Flexスクリプト指定	flexScript	Flexスクリプトでテンプレートを指定します。	flexScript : Flexスクリプト
アップロード	resourcefile	テンプレート（.llaファイル）をアップロードします。	resourcefile : テンプレートファイル

layout / upload APIで編集を開始する際に指定するパラメータです。

パラメータ	項目	必須	説明	値もしくは例	補足
relayUserId	編集時のユーザID	必須	編集時のユーザIDを指定します。	editOnly	Flexの利用アカウントを指定してください
dtime	ログイン情報を生成した時刻	必須	ログイン情報を生成した時刻をRFC1123形式で指定します。	Fri, 12 Nov 2010 08:28:00 GMT	flex呼び出し時に生成してください。認証情報有効期間が、0以外に設定されている場合、有効期間の範囲外では呼び出しエラーとなります
clientId	呼び出し元の正当性を示すID	必須	dtimeと共通鍵を連結した文字列のMD5の値を指定します。	32Byteの半角英数字	共通鍵は、Flexアカウント毎に設定されています。
flexId	編集結果を示すID	省略可	download, pdf, jpeg, remove で対象を指定します。	35Byteの半角英数字	layout API 呼び出しからの戻り時に取得できます。
resultType	結果表示方法	省略可	編集終了時やエラー時などの結果表示方法を指定します。	"html"：標準で用意されている画面を表示します。 "text"：テキストで返します。	無指定または、"text"以外を指定した場合は、"html"指定となります。 "text"指定時に返る文字列の内容 1行目：ステータス 2行目：flexId 3行目：メッセージ
resultName	編集終了画面ページ名	省略可	編集終了時やエラー時などに表示する戻り画面を指定します。	連携ユーザにてログインし、個人設定から戻り画面を作成してください。	無指定または、戻り画面が存在しない場合は、デフォルトの編集終了画面を表示します。resultTypeが"html"以外の場合には無視します。
pageNo	編集開始ページ番号	省略可	編集開始時に表示するページ番号を指定します。	最初のページが１です。	省略時には１ページ目を表示します。
pageSaveURL	ページ「保存」時通知先	省略可	編集画面での保存時に呼び出すURLです	pageSaveModeが"svg"/"lla"の時のみ有効 svgの場合はテキスト（カレントページのみ）、lla の場合はバイナリ（全ページ）を送ります。	URLにGETパラメータを含められます。通知内容は、pageSaveModeによります。
pageSaveMode	pageSaveURLへの通知内容	省略可	Flexから外部へ保存する際のモード指定	"svg"：保存されたページのSVGのみ "lla"：編集中ドキュメント全体のlla "template"：デフォルトテンプレートプロバイダへ保存 "cassette"：デフォルトカセットプロバイダへ保存 "document"：デフォルトドキュメントプロバイダへ保存	省略時には"flexId"です。
pageSaveTrackingId	プロバイダへ保存する際のtrackingId	省略可	指定されたtrackingIdのリソースを上書きします。	pageSaveModeが"template"/"document"/"cassette"の時のみ有効 srcTypeがtrackingIdの時、pageSaveMode と resourceType が等しい場合に、リソースのtrackingIdを自動設定無指定時編集画面中で保存した場合に新規作成され、以降、作成されたリソースのtrackingIdに設定される。	省略時は新規作成
pageSavePath	プロバイダへ新規保存する際のvpath	省略可	指定されたパスに保存されます。	pageSaveModeが"template"/"document"/"cassette"の時のみ有効 pageSaveTrackingIdが（自動設定含め）設定されている場合には、無効	省略時は"/"
savedAtEnd	編集画面終了時に自動で保存	省略可	true:結果画面を出さず、自動保存, false:無効	pageSaveModeが"template"/"document"/"cassette"の時のみ有効編集画面終了時に結果画面を表示せず、自動で保存し、trackingIdをパラメータとして、returnURLへ画面遷移します。	省略時false
keepAlive	savedAtEnd=true で戻る前にセッションを破棄しない	省略可	true:セッションを破棄しない。 false:無効	savedAtEndで戻る場合には、戻る直前にセッションを破棄します。戻った先で、flexIdを使って pdf/jpeg生成や編集結果のダウンロードを行いたい場合は、keepAliveをtrueにしてください。ただし、セッションが残りますので、必要な処理が終わったあとに、そのセッションの中で、alive API 、もしくは remove APIを呼び出しすようにしてください。	省略時false
purge	savedAtEnd=true で戻る際やpdf/jpeg/png API 呼び出し時にremoveする	省略可（通常はtrueを指定してください）	true:編集用一時ドキュメントを削除 false:何もしない	savedAtEndで戻った後に、flexId を使ってPDF生成等を行う場合はtrueを指定しなければ可能です。戻った後に、特に何もしないのであれば、trueを指定して、後処理をすべきです。trueを指定しなかった場合は、明示的にremove API を呼び出してクリーニングしてください。何もしなかった場合は、約1時間flexに編集用一時ドキュメントやセッションが残り続けます。 pdf / jpeg / png API の purge パラメータも同様に処理実行後にドキュメントを削除してセッションを破棄しますので、その後のremove API 呼び出しを省略可能です。これらのAPIを連続して呼び出すときは、一番最後の呼び出しだけ purge=trueにしてください。あるいはすべてpurge=falseとして明示的にremove API を呼び出してください。	省略時false
forceSave	savedAtEndがtrueの場合に、無編集でも強制保存	省略可	true:強制保存, false:通常保存（編集画面で編集されていない場合は保存されない）	forceSaveがtrueで有効な場合のみに有効 savedAtEndがtrueの場合に、無編集でも保存されるようにします。編集画面を使わない場合で、全く編集しない場合や、injectionData や EditScriptだけで編集する場合には、このフラグを true にしておかないと、保存されません。	省略時false
autoTouch	ドキュメント一時保存状態の解除	省略可	true:自動解除, false:呼び出し元WebAppから明示的なtouchを行う	savedAtEndがtrueの時のみ有効ドキュメントの新規作成時かつEdition CMSへの保存となる場合には、 Edition Flex呼び出し元にドキュメントのtrackingIdが返るまでは、管理責任はEdition側にあります。その為、なんらかの事情で、呼び出し元アプリに管理責任が映らなかったドキュメントをクリーニングする為に、 Edition CMS側ではドキュメントが一時保存状態となります。一時保存状態を解除するために、呼び出し元アプリでは、trackingIdを受け取った後、touch APIを呼び出すべきですが、 autoTouch=true の場合は、returnURLへリダイレクトする前に自動的にtouchします。従来のアプリとの互換性の為に、デフォルトは、true となります。	省略時true
returnUserId	呼び出し元に戻る場合の連携ログイン用ユーザID	省略可	編集時のユーザIDを指定します。		省略時はrelayUserIdと同じ値とします
returnURL	戻り先URL	省略可	編集終了時に戻るURLを指定します。編集結果をダウンロードするためのIDを付加して呼び出します。	http://...	指定しない場合は編集終了時に閉じるボタンのみの画面を表示します。
errorURL	エラー発生時戻り先URL	省略可	エラー発生時時に戻るURLを指定します。	http://...	指定しない場合は戻り先URLに戻ります。
editorType	エディタの形式	省略可	エディタの形式を選択します。	general（編集画面あり） injection（編集画面なし） none（編集画面も差込処理も無し）	指定しない場合は「general」を指定したものとします。
forceLayout	強制編集開始	省略可	通常（マルチモードでない場合）は一つのブラウザでは、同じFlexでは、呼び出し側アプリが異なっていたとしても、同時に一つの編集画面しか使えません。 forceLayoutが未設定もしくはfalseの場合は、flexはそのユーザセッションで編集中の場合にはエラー画面を表示します。trueにした場合は、エラーとせず、強制的に編集開始します。ただし、全く同時に編集を開始した場合など、開始時は別セッションだったものが、ブラウザによっては後で同じセッションになってしまう事があり、そのような場合には、falseでもエラーにならない場合があります。このフラグをtrueにして同時編集となった場合に、前の編集画面で編集操作が継続されていた場合には、編集データが混ざり、正しい編集が行われませんので、特に問題が無い限りtrueにはしないでください。	true\|false	指定しない場合は「false」を指定したものとします。
multiMode	複数画面同時編集	省略可	trueの場合、編集時情報を別々に管理することで、同一ユーザセッションで複数画面で同時編集を行う事が可能となります。いずれかの編集画面でFlexからログアウトすると、同時編集中の全画面のデータが失われますので、ログアウトはできません。	true\|false	指定しない場合は「false」を指定したものとします。
purposeName	用途	省略可	編集時の設定を選択します。編集設定ファイルのpurposeと合わせてください。	user designer	指定しない場合は「user」を指定したものとします。
pagePurposeNames	ページ毎の用途	省略可	ページ切り替え時の用途をカンマ区切りで指定します。定義されている場合はその用途に切り替わります	user,user2...	指定しない場合はページ切り替え時に用途は切り替わりません
layoutId	編集ID	省略可	編集画面呼び出し時に呼び出し側で設定する識別IDです。	呼び出し側アプリユーザIDなど	素材プロバイダの基準パスの中で${layoutId}として指定できます。
checkMaterial	素材チェック	省略可	素材・カセットの存在チェックをしますプロバイダから提供される素材が取得可能かどうかをチェックします取得できない場合は編集を開始しません。	true\|false	指定しない場合は「false」を指定したものとします。
injectionData	差し込みデータ	省略可	ラベル指定で、テキストパーツの文字列、イメージパーツのtrackingIdを指定します。	ラベル1[タブ]値1 ラベル2[タブ]値2	LAML形式（１階層）
disableUpdatingInjectionDataByParts	injectionData の差し込み処理でカセットの trackingIdが変わらない場合でも差し込みを強制する	省略可	カセットの洗い替え目的	true\|false	指定しない場合は「false」を指定したものとします。
forceUpdateInjectiionData	ウイザード編集後の自由編集の結果をinjectionData に反映させる処理を抑制する	省略可	通常はパーツの値でinjectionDataを上書きしますが、true だとその処理を行いません。	true\|false	指定しない場合は「false」を指定したものとします。
editScript	編集スクリプト	省略可	スクリプトでの編集処理を指定します。	別途資料参照	groovyスクリプト形式
enableIncludedEditScript	テンプレート同梱スクリプト実行フラグ	省略可	trueが指定されている場合、テンプレート同梱スクリプトがあれば実行します。 editScriptパラメータが指定されている場合、それと結合されて実行されます。	true\|false	指定しない場合は「false」を指定したものとします。
traceNoticeURL	編集スクリプト trace() 通知URL	省略可	スクリプトでの trace() の内容をPOSTします。		GETパラメータがある場合、POSTパラメータとしてそのまま送ります。
resourceType	編集対象のタイプ	srcTypeがtrackingIdで、pageSaveModeを指定する場合に必要	resourceTypeとpageSaveModeが等しい場合はtrackingIdで指定したリソースそのものを編集することを意味します。	template/document/cassette	pageSaveTrackingIdを参照してください
srcType	種別	必須	編集の元データとするテンプレートの指定方法を表します。	create trackingId templateName resourcefile remotefile flexScript	create:白紙 trackingId:識別コード templateName:テンプレート名 resourcefile:.lla/.zipファイルをアップロード remotefile:指定したURLからテンプレートをダウンロード flexScript:Flexスクリプト指定 flexId:flexId指定
trackingId	識別コード	srcType=trackingIdの場合に必須	編集の元にするテンプレートを指定します。		存在しない場合はエラー画面を表示します。
templateName	テンプレート名	srcType=templateNameの場合に必須	編集の元にするテンプレートを指定します。		存在しない場合はエラー画面を表示します。
flexScript	Flexスクリプト	srcType=flexScriptの場合に必須	編集の元にするテンプレートをFlexスクリプトで指定します。		Flexスクリプトが正しくない場合はエラー画面を表示します。
remotefile	テンプレートを取得するURL	srcType=remotefileの場合に必須	編集の元にするテンプレートを指定したURLから取得します。		存在しない場合はエラー画面を表示します。 JavaのKeyStoreで信頼されていない場合(オレオレ証明書など)、接続時にエラーが発生します。 keytool - 鍵と証明書の管理ツール Java環境に手動でグローバルサインのルート証明書をインストールする方法に従い証明書をインポートすれば使えるようになると思われます。
flexId	Flex上のドキュメント	srcType=flexIdの場合に必須	upload API などで既にflexに登録されているドキュメントを指定する場合		存在しない場合はエラー画面を表示します。
remoteUser	テンプレートを取得時のユーザ名	省略可	srcType=remotefileの場合に指定可能です。		Basic/Digest認証が必要な場合のユーザ名です。
remotePasswd	テンプレートを取得時のパスワード	省略可	srcType=remotefileの場合に指定可能です。		Basic/Digest認証が必要な場合のパスワードです。
editorMaterialBasePath	編集画面での素材基準パス	省略可	素材一覧の絞込		editor.lamlのbasePathが優先されます。
editorCassetteBasePath	編集画面でのカセット基準パス	省略可	カセット一覧の絞込		editor.lamlのbasePathが優先されます。
pageList	編集開始時のページソーティング＆ピックアップ	省略可	ページのピックアップとソーティング	2,1	カンマ区切りで指定指定された順にページをピックアップして一覧を更新（未指定のページは削除、複数回指定されている場合は無視）
productTrackingId	Wizard編集する場合のテンプレートのtrackingId	省略可	wizard編集時のみ		ドキュメント再編集時は指定しない
documentTrackingId	Wizard編集する場合のドキュメントのtrackingId	省略可	wizard編集時のみ		テンプレートから編集する場合は指定しない
saveNew	新規保存フラグ	省略可	編集結果を上書きではなく新規に保存します		編集対象がtrackingId指定で、pageSaveMode == resourceType の時のみ有効
flex3dURL	Flex3D呼び出しURL	省略可	編集画面でプレビュー（type:3D）時に呼び出されるFlex3DのURL		呼び出し時にflexIdがパラメータに追加されます。
recordCSV	CSVデータファイル	省略可	EditScript内で利用可能なCSVデータファイル		multipart/form-dataでPOST（ファイル添付/ファイルアップロード）でFlexに渡す１行目がタイトルで２行目以降がデータ
recordCSVEncode	Flex3D呼び出しURL	省略可	recordCSVの文字エンコード（SJIS/MS932/UTF-8など）		UTF-8を推奨　※無指定の場合は自動判定を試み、自動判定に失敗した場合はMS932となります。

PDF / JPEGで、結果を取得する際に指定するパラメータです。

PDF/JPEG共通設定
設定名	型	値	説明
pageList	String	1,2,3....	カンマ区切りで 1からの、取得したいページ番号
highResolution	boolean	true\|false	高解像度
sampleMark	boolean	true\|false	見本マーク有無
sampleMarkStr	String		見本マーク文字列
sampleMarkStrOption	int	1:左上 2:中央上 3:右上（デフォルト） 4:左中央 5:中央 6:右中央 7:左下 8:中央下 9:右下 10:斜め（右下がり） 11:斜め（右上がり）	見本マーク文字列の描画方法
sampleMarkTrackingId	String		見本マーク素材識別コード
sampleMarkPosition	String	upper-left 左上 upper-center 中央上 upper-right 右上 center-left 左中央 center-center 中央中央 center-right 中央右 lower-left 左下 lower-center 中央下 lower-right 右下	見本マーク素材の描画位置
trimMargine	boolean	true\|false	余白トリミング
checkFont	boolean	true\|false	フォントチェック
showLayer	String	1,2	表示するレイヤー番号（1~）をcsvで指定
hideLayer	String	1,2	非表示にするレイヤー番号（1~）をcsvで指定(showLayer指定時は無効)
hideErrorParts	boolean	true/false	true（無指定時デフォルト）：エラーを描画する。 false:エラーパーツを非表示にする

PDF専用設定
設定名	型	値	説明
pdfVersion	String	1.3\|1.4\|1.5 ...	PDFバージョン（1.3以上）
cmyk	boolean	true\|false	CMYK出力（falseの場合はRGB出力）
gray	boolean	true\|false	グレースケール出力（グレースケール出力できない場合にエラー）
bookmark	boolean	true\|false	ページ名をPDFのブックマークに設定する（デフォルトはtrue）
pdfMasterPassword	String		権限パスワード
pdfUserPassword	String		ユーザパスワード
pdfPermissions	String	noprint nomodify nocopy noannots	制限(複数ある時は、スペースで区切ります) マスターパスワード必須です。
pdfOverprintMode	String	"Off" / "CMYK" / "K100" / "K95"	オーバープリントモード指定
checkJpeg	boolean		JPEG画像カラープロファイルチェック
checkPng	boolean		PNG画像カラープロファイルチェック
pdfx1a2001	boolean		PDF/X-1a:2001 準拠
pdfx1a2003	boolean		PDF/X-1a:2003 準拠
compress	int	0:無圧縮 1:スピード優先 6:バランス 9:サイズ優先	PDF圧縮係数（0-9）
pagelayout	string	singlepage:一度に単一ページを表示(デフォルト) onecolumn:ページを連続縦一列に表示 twocolumnleft:ページを見開きで、奇数ページを左にして表示 twocolumnright:ページを見開きで、奇数ページを右にして表示	文書が開く時に用いられるページレイアウト
openaction	string	fitwindow: ページ全体をウィンドウに合わせる(初期値) fitwidth: ページの幅をウィンドウに合わせる fitheight: ページの高さをウィンドウに合わせる fitvisible: ページの描画領域(ArtBox)をウィンドウに合わせる fitvisiblewidth: ページの描画領域をウィンドウに合わせる fitvisibleheight:ページの描画領域をウィンドウに合わせる	PDFを開く時の動作
pdfx	String	"none" / "PDF/X-1a:2001" / "PDF/X-1a:2003" etc.	PDF/X準拠レベル
outputintent	String	"JC200103" 他	PDF/Xの出力インテント
defaultgray	String		PDF/Xのデフォルトのグレー色空間のICCカラープロファイル
defaultrgb	String		PDF/XのデフォルトのRGB色空間のICCカラープロファイル
defaultcmyk	String		PDF/XのデフォルトのCMYK色空間のICCカラープロファイル
iccprofile-jpeggray	String		グレー色色空間のJPEG画像に適用されるICCカラープロファイル
iccprofile-jpegrgb	String		RGB色空間のJPEG画像に適用されるICCカラープロファイル
iccprofile-jpegcmyk	String		CMYK色空間のJPEG画像に適用されるICCカラープロファイル
iccprofile-pnggray	String		グレー色空間のPNG画像に適用されるICCカラープロファイル
iccprofile-pngrgb	String		RGB色空間のPNG画像に適用されるICCカラープロファイル
Title	String	"no title"	文書のタイトル
Creator	String	"edition flex"	文書の作成に使用されたソフトウェア
Subject	String	"sub title"	文書のサブタイトル
Author	String	"auther"	文書の作成者
Keywords	String	"sample leaf"	文書の内容を記述したキーワード
honoriccprofile	boolean	false	画像内に埋め込まれているICCカラープロファイルを適用（デフォルトはfalse=推奨値）
linearize	boolean		Web用最適化
optimize	boolean		別工程で最適化
pdfInvisibleText	boolean	none:出力しない , acro:標準日本語フォント（CMAPフィル必要）, embed（フォント埋め込み）	不可視テキスト出力モード
pdfInvisibleTextParam	string	"" / none / both / only	不可視テキスト出力モードが none 以外の場合に強制的にパーツパラメータに設定する値
svgElementInvisibleText	string	none:パスのみ, both：パスと不可視テキスト両方, only:不可視テキストのみ	SVG中の text/tspan要素の不可視テキスト出力モード

JPEG/PNG用設定
設定名	型	値	説明
rasterDpi	int	dpi	ラスター出力時のDPI
rasterPxSize	int	pixel	ラスター出力時の最大ピクセルサイズ
rasterSmoothing	boolean	true\|false	ラスター出力時のスムージング処理の有無
rasterBitCount	int	ビット数	ラスター出力時のビット数（8/24/32）
rasterPaletter	String	MedianCut/MedianCutBW/WebSafe	ラスター出力時のパレット指定
rasterDither	String	None/FloydSteinberg	ラスター出力時のディザ処理
rasterJpegQuality	int	（低:0～高:100）	JPEG出力時のJPEG品質
rasterBackgroundColor	String	RGB色	ラスター出力時の背景色（デフォルトはnoneで白）
rasterBackgroundTransparent	boolean	true\|false	ラスター出力時の背景色を透過にするかどうかのオプション
rasterNoZip	boolean	true\|false	単ページの場合にZIPを使わない（複数ページ指定の場合は先頭ページのみ返す）

PNG専用設定
設定名	型	値	説明
rasterBackgroundTransparent	boolean	true/false	ラスター出力時の背景を透過にする

※各パラメータは、個別指定の他、LAML形式にまとめて、printSettings というキーで一括指定することもできます。

bgprogress	バックグラウンド処理の状況を取得します。バックグラウンド処理は、１０分（デフォルト）で、タイムアウト停止しますので、それ以上処理を継続する場合は、時間内にbgprogressを定期的に呼び出してください。（注意）セッションを破棄します。	認証： relayUserId : 連携ログイン用ユーザID dtime : 連携ログイン日時 clientId : 連携ログインクライアントID 対象： queueId : バックグラウンド処理を示すID 結果： status : 処理状態(queued\|started\|stopped\|abortRequested) statusString : 処理状態文字列(実行待\|実行中\|実行完了\|中断処理中) result : 処理結果(success\|error\|aborted) extra : 処理結果付加情報(文字列)
bgabort	バックグラウンド処理の中断を指示します。バックグラウンド処理の都合上、即時ではなく、直近の停止可能タイミングでの停止となります。（注意）セッションを破棄します。	認証： relayUserId : 連携ログイン用ユーザID dtime : 連携ログイン日時 clientId : 連携ログインクライアントID 対象： queueId : バックグラウンド処理を示すID 結果： abortresult : 中断依頼結果(abortRequested\|invalidStatus) status : 処理状態(queued\|started\|stopped\|abortRequested) statusString : 処理状態文字列(実行待\|実行中\|実行完了\|中断処理中) result : 処理結果(success\|error\|aborted) extra : 処理結果付加情報(文字列)
bgdownload	バックグラウンド処理処理結果を取得します。（注意）セッションを破棄します。	認証： relayUserId : 連携ログイン用ユーザID dtime : 連携ログイン日時 clientId : 連携ログインクライアントID 対象： queueId : バックグラウンド処理を示すID 結果：バックグラウンド処理が正常に終了していた場合には、バックグラウンド処理ではない場合と同じデータをダウンロードします。バックグラウンド処理が終了していない場合には、「400 Bad Request」を返します。 bgprogressにて状況を確認してから処理結果を取得してください。

テンプレートを指定して、ドキュメントを作成し、編集し、結果を取得します。