開発者向けサポート

メソッド - customページ処理(ファイル有)(userweb/ext/proc_with_file/{name})

customページ処理(ファイル有)

userweb/ext/proc_with_file/{name}

/custom/で始まるページへのアクセスに対して、固有のカスタマイズ処理を行います。

必要権限

system

引数

path

string

処理中のファイル名

リクエストパラメーター

ブラウザから送付されたリクエストパラメーターがrequestParamsに格納されて送られてきます。

返り値

ExtCustomizeResultオブジェクト

遷移先画面情報。テンプレートファイルのパス、もしくはリダイレクト先パスを指定します。次のいずれかの形式のオブジェクトを返してください

  • {"template": "foo"} : "/custom"以下のテンプレートパスを指定してください。
    対応している拡張子は .htm .xhtml .jsp .txt となります。
    また、同名で拡張子が異なるファイルを配置した場合、上記の順番で優先されます。
    例えば、{"template": "foo"}を返し、/custom配下にfoo.htmとfoo.xhtmlが存在した場合、foo.htmが利用されます。
  • {"redirect": "item/ITEM1.html"} : 任意の内部パスへリダイレクト（トップページ起点の相対パス。トップページ自体は"/"）
  • {"special": "common_error"} : エラーページ。メッセージは別途セット済みにしておいてください。
  • {"external_redirect": "http://xxxx.co.jp"} : 外部サイトへのリダイレクト
  • {"is_https_redirect": "common_error"} : 内部パスへリダイレクトする際にHTTPSでリダイレクトします。※設定したパスによっては画像等が表示出来なくなる場合がありますので動作検証の上、ご使用ください。
なお、本APIはリトライ機能に対応しておりません。