下記のようなリクエスト文字列で、HTTPSでリクエストを行います。GETまたはPOSTに対応しています。リクエストを実行するフォームのサンプル
リクエストの例（PDFをダウンロードする場合）
後述のパラメータと共に、弊社からお伝えするOPROARTSのURLにリクエストを行なってください。
| パラメータ | 意味 | 説明 | 備考 |
|---|---|---|---|
| CID | 顧客ID | 弊社からお伝えするOPROARTSのCIDをセットしてください。 | ※必須パラメータ |
| UID | ユーザID | 弊社からお伝えするOPROARTSのUIDをセットしてください。 | ※必須パラメータ |
| UPW | ユーザパスワード | 弊社からお伝えするOPROARTSのUPWをセットしてください。 | ※必須パラメータ |
| OP | 操作指示 | 下記のいずれかを指定してください。 dlo : oprドキュメントのダウンロード dlp : pdfドキュメントのダウンロード mlo : oprドキュメントの添付されたメールを送信（「メール送信時のパラメータ」もご覧ください） mlp : pdfドキュメントの添付されたメールを送信（「メール送信時のパラメータ」もご覧ください） dp : クライアントPCでの直接印刷 dlxm : Excelドキュメントのダウンロード o.dlxm : Excelドキュメントのダウンロード（Officeアドイン利用） o.mlxm : Excelドキュメントの添付されたメールを送信（Officeアドイン利用）（「メール送信時のパラメータ」もご覧ください） o.dlwm : Wordドキュメントのダウンロード（Officeアドイン利用） o.mlwm : Wordドキュメントの添付されたメールを送信（Officeアドイン利用）（「メール送信時のパラメータ」もご覧ください） | ※必須パラメータ |
| TP | テンプレート名 | 弊社が作成するテンプレート（帳票デザインが定義されたファイル）の名前を指定してください。 マルチテンプレート（複数のテンプレートを指定する方法）の場合は、 TP(1), TP2, TP3, ・・・, TPn : のように複数指定してください。 ※ n: テンプレートのインデックス（1から始まる連番） （例）nouhin.oxtとseikyu.oxtを使ったマルチテンプレートの例 TP1=nouhin&TP2=seikyu&TP3=nouhin&TP4=seikyu
※ マルチテンプレートをしない場合は、テンプレートインデックスを省略し、「TP」というパラメータで問題ありません。 |
※必須パラメータ |
| TD | テキストデータセット | 帳票に表示するテキストデータ（CSV等）の内容を指定してください。 弊社で作成するテンプレートに対応する形式（区切り文字、フィールド数等）で指定する必要があります。形式については、弊社よりお伝えいたします。 TDの値としてデータの内容を指定するか、multipart/form-data形式でファイルをアップロードすることができます。 multipart/form-data形式でアップロードする場合のファイルのエンコードは、MS932としてください。 ＜TDの値としてCSVの内容を指定する場合の例＞ ・CSVデータの内容 field1-1,field2-1,field3-1 field1-2,field2-2,field3-2 field1-3,field2-3,field3-3 ・リクエスト内容 TD=field1-1%2Cfield2-1%2Cfield3-1%0D%0Afield1-2%2Cfield2-2%2Cfield3-2%0D%0Afield1-3%2Cfield2-3%2Cfield3-3
※ %2Cは、カンマ( , ) をURLエンコードした値です。※ %0D%0Aは、改行コードをURLエンコードした値です。 複数のテキストデータセットを指定する場合は、 TD1, TD2, TD3, ・・・, TDn : のように指定してください。 ※ n: テキストデータセットのインデックス（1から始まる連番） マルチテンプレートの場合は、 TD1_1, TD1_2, TD2_1, TD2_2, TD2_3, TD3_1, ・・・, TDn_m : のように複数指定してください。※ n: テンプレートインデックス, m: テキストデータセットインデックス 例えば、「TD2_1」は、「TP2で指定したテンプレートの、1番目のテキストデータセット」という意味になります。 |
|
| RF | リフレッシュ間隔 | OPROARTSから返されるHTMLの更新間隔（秒）を指定してください。 このパラメータは、主にWebブラウザのタイムアウト対策として使用します。指定すると、OPROARTS側のドキュメント生成が5秒以上かかった場合にHTMLがレスポンスされ、指定された秒数の間隔で自動更新を続けます。OPROARTS側でドキュメント（PDF等）の生成が完了した次の更新時に、ドキュメントをダウンロードすることができます。 |
|
| FE | PDFへのフォントの埋め込み | PDFにフォントを埋め込むは true、埋め込まない場合は false を指定してください。このパラメータを省略した場合、フォントは埋め込まれません。 | パラメータ「OP」の値に、「dlp」または「mlp」を指定した場合にのみ有効なパラメータです。 |
パラメータ「OP」の値に、「mlo」または「mlp」を指定した場合のパラメータです。
| パラメータ | 意味 | 説明 | 備考 |
|---|---|---|---|
| MT | メール送信先 | メールの送信先アドレスを指定してください。 複数の送信先を使用する場合、各メールアドレスをカンマ区切りで指定してください。 |
※必須パラメータ |
| MCC | メール送信先(CC) | メールの送信先アドレス(CC)を指定してください。 複数の送信先(CC)を使用する場合、各メールアドレスをカンマ区切りで指定してください。 |
|
| MBC | メール送信先(BCC) | メールの送信先アドレス(BCC)を指定してください。 複数の送信先(BCC)を指定する場合、各メールアドレスをカンマ区切りで指定してください。 |
|
| MF | メール送信元 | メールの送信元アドレスを指定してください。 | ※必須パラメータ |
| MSJ | メール件名 | メールの件名を指定してください。 | |
| MB | メール本文 | メールの本文を指定してください。 | |
| MA | 添付ファイル名 | 添付ファイル名を指定してください。 生成されたドキュメントの添付ファイル名となります。 ※省略された場合、システムで管理されているファイル名がつけられます。 |
|
| MR | メール返信先 | メールの返信先アドレスを指定してください。 | |
| MEF | メールのEnvelope From | Envelope Fromに、MFで指定したメール送信元を使用する場合は、「true」または「1」を指定してください。 無指定も含めて「true」または「1」ではない場合は、サーバーの既定値が使用されます。 |
PDFの「文書のプロパティ」に文字列を指定する場合のパラメータです。
| パラメータ | 意味 | 説明 | 備考 |
|---|---|---|---|
| DIT | (PDF)文書のプロパティのタイトル | PDFの「文書のプロパティ」の「タイトル」に表示させたい文字列を指定します。 | 省略時は空になります。 |
| DIA | (PDF)文書のプロパティの作成者 | PDFの「文書のプロパティ」の「作成者」に表示させたい文字列を指定します。 | 省略時は空になります。 |
| DIS | (PDF)文書のプロパティのサブタイトル | PDFの「文書のプロパティ」の「サブタイトル」に表示させたい文字列を指定します。 | 省略時は空になります。 |
| DIK | (PDF)文書のプロパティのキーワード | PDFの「文書のプロパティ」の「キーワード」に表示させたい文字列を指定します。 | 省略時は空になります。 |
OPROARTSを使用する場合の、リクエスト-レスポンスの流れは以下のようになります。
レスポンスには、以下のような種類があります。