MultipartFormDataRequest - ABBYY Documentation

multipart/form-data コンテンツタイプの HTTP リクエスト。

プロパティ

Name	Type	Description
Url	string	リソースのURL。
Method	string	リクエストの種類 (例：GET または POST) 。
AuthToken	string	認証トークン (外部サービスの認証が必要な場合) 。
AuthScheme	string	認証方式。
ThrowExceptionOnFailed	boolean	外部サービスが HTTP レスポンスのステータスとしてエラーコードを返した場合に例外を発生させるかどうかを指定します。False に設定すると例外は発生せず、HTTP ステータスコードは Status プロパティに保存されます。既定値は True です。
Timeout	number	応答のタイムアウト (分) 。既定値は 1 分です。
ResponseText	string, 読み取り専用	レスポンス結果 (Text 形式) 。
ResponseType	string, 読み取り専用	サービスが返すリクエスト応答の種類 (例：“application/json”) 。
Status	number	外部サービスの HTTP レスポンスステータスコード。ThrowExceptionOnFailed が True に設定されている場合、エラーコードで例外が発生し、トランザクションは中断されます。エラーメッセージのテキストは Skill Monitor で確認できます。

Timeout の値はスクリプトの実行時間制限 (600 秒) を超えることはできません。

メソッド

Name	Description
AppendStringContent(string data, string contentName);	リクエスト本文に multipart/form-data の文字列を追加します (既定では、コンテンツタイプは UTF-8 エンコードの application/json に設定されます) 。contentName パラメーターは、送信されるフォームの field 名を指定します。
AppendStringContent(string data, string contentName, ContentEncoding contentEncoding, string mediaType?);	リクエスト本文に multipart/form-data の文字列を追加します。加えて、エンコードを指定できます。コンテンツタイプが指定されていない場合は、既定で「application/json」に設定されます。
AppendFileContent(DocumentExportResult documentExportResult, string contentName, string mediaType?);	リクエスト本文に multipart/form-data のバイナリデータを追加します。コンテンツタイプは、渡されるファイルの拡張子に基づいて自動的に設定されます。必要に応じて、オプションパラメーター mediaType を使用して事前にコンテンツタイプを設定できます。
AppendFileContent(BinaryFile binaryFile, string contentName, string mediaType?);	次のバイナリデータをリクエスト本文に追加します：トランザクションにインポートされたソース画像、または Picture タイプの field に含まれる画像。コンテンツタイプは、インポートされるファイルの拡張子に基づいて自動的に設定されます。必要に応じて、オプションパラメーター mediaType を使用して事前にコンテンツタイプを設定できます。
AppendSourceFileContent(string contentName, string mediaType?);	トランザクションにインポートされたソース画像のバイナリデータをリクエスト本文に追加します。コンテンツタイプは、インポートされるファイルの拡張子に基づいて自動的に設定されます。必要に応じて、オプションパラメーター mediaType を使用して事前にコンテンツタイプを設定できます。
SetHeader(string name, string value);	リクエストに追加の HTTP ヘッダーを設定します。ヘッダー名ごとにこのメソッドを呼び出してください。
Send();	HTTP リクエストを送信します。

AppendSourceFileContent は非推奨です。トランザクション内の最初のファイルにしかアクセスできません。代わりに AppendFileContent を使用してください。