メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt

Use this file to discover all available pages before exploring further.

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

プロパティ

NameTypeDescription
UrlstringリソースのURL。
Methodstringリクエストの種類 (例:GET または POST) 。
AuthTokenstring認証トークン (外部サービスの認証が必要な場合) 。
AuthSchemestring認証方式。
ThrowExceptionOnFailedboolean外部サービスが HTTP レスポンスのステータスとしてエラーコードを返した場合に例外を発生させるかどうかを指定します。False に設定すると例外は発生せず、HTTP ステータスコードは Status プロパティに保存されます。既定値は True です。
Timeoutnumber応答のタイムアウト (分) 。既定値は 1 分です。重要: リクエストのタイムアウト値はスクリプトの実行時間制限 (600 秒) を超えることはできません。
ResponseTextstring, 読み取り専用レスポンス結果 (Text 形式) 。
ResponseTypestring, 読み取り専用サービスが返すリクエスト応答の種類 (例:“application/json”) 。
Statusnumber外部サービスの HTTP レスポンスステータスコード。ThrowExceptionOnFailed が True に設定されている場合、エラーコードで例外が発生し、トランザクションは中断されます。エラーメッセージのテキストは Skill Monitor で確認できます。

メソッド

NameDescription
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 を使用して事前にコンテンツ タイプを設定できます。重要: このメソッドは非推奨です。トランザクション内の最初のファイルにしかアクセスできません。代わりに AppendFileContent() メソッドを使用してください。
SetHeader(string name, string value);リクエストに追加の HTTP ヘッダーを設定します。ヘッダー名ごとにこのメソッドを呼び出してください。
Send();HTTP リクエストを送信します。

HttpRequest

スクリプトからマルチパート以外の呼び出しを行うための標準的な HTTP request 型です。

BinaryFile

リクエスト本文 に追加できるバイナリ コンテンツ (元の画像など) 。

DocumentExportResult

リクエスト本文 に追加できる、エクスポート済みのファイル コンテンツ。

ContentEncoding

request に追加される string コンテンツのエンコード オプションです。

オブジェクト モデル

カスタム アクティビティ スクリプト用の完全な JavaScript オブジェクト リファレンスです。