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

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.

HttpRequest は、application/x-www-form-urlencoded、テキスト、またはバイナリ データを含む HTTP リクエストを外部サービスに送信します。

​
プロパティ

NameTypeAccessDescription
Urlstring読み取り/書き込みリソース URL。
Methodstring読み取り/書き込みリクエストの種類 (たとえば GET または POST) 。
AuthTokenstring読み取り/書き込み外部サービスで認証が必要な場合の認証トークン。
AuthSchemestring読み取り/書き込み認証スキーム。
ThrowExceptionOnFailedboolean読み取り/書き込みtrue (既定値) の場合、200～299 の範囲外の HTTP レスポンスステータスコードで例外が発生します。以下の注記を参照してください。
Timeoutnumber読み取り/書き込みリクエストのタイムアウト時間 (分単位) 。既定値は 1 分です。
ResponseTextstring読み取り専用テキスト形式のレスポンス本文。
ResponseTypestring読み取り専用レスポンスのコンテンツタイプ (たとえば application/json) 。
Statusnumber読み取り専用外部サービスから返される HTTP レスポンスステータスコード。
ThrowExceptionOnFailed が false の場合、4xx/5xx のレスポンスでは例外は発生しません。HTTP ステータスコードは Status を確認してください。エラーコードのレスポンスは、外部サービスに到達できており、応答も返していることを意味します。一方、サービスの可用性や接続失敗に関するエラーでは、このプロパティの設定に関係なく常にプログラム例外が発生し、その場合は HTTP ステータスコードを取得できません。
ThrowExceptionOnFailed が true で、レスポンスがエラーコードの場合、トランザクションは中断され、エラーメッセージが Skill Monitor に表示されます。
Timeout の値は、スクリプトのランタイム制限 (600 秒) を超えることはできません。

​
メソッド

​
SetHeader

void SetHeader(string name, string value);
リクエストに追加の HTTP ヘッダーを設定します。ヘッダーごとにこのメソッドを呼び出してください。

​
Send

void Send();
HTTP リクエストを送信します。

​
SetFileContent

void SetFileContent(DocumentExportResult documentExportResult, string mediaType?);
void SetFileContent(BinaryFile binaryFile, string mediaType?);
ファイルベースの HTTP リクエスト本文を初期化します。コンテンツタイプはファイル拡張子から判定されます (例: application/json、application/pdf) 。これを明示的に指定するには、mediaType を渡します。
  • 1 つ目のオーバーロードは、エクスポートされたデータ (Document.Exports のデータ) をファイルとして送信します。
  • 2 つ目のオーバーロードは、バイナリデータを送信します。これは、トランザクション作成時の元の画像、または型 Picture の field に含まれる画像のいずれかです。

​
SetSourceFileContent

void SetSourceFileContent(string mediaType?);
トランザクションの作成時にインポートされた元の画像を使用して、バイナリデータのリクエストを初期化します。コンテンツタイプはファイル拡張子から自動的に判別されます。必要に応じて、mediaType で上書きできます。
SetSourceFileContent は非推奨です。トランザクション内の最初のファイルにしかアクセスできません。代わりに SetFileContent を使用してください。

​
SetStringContent

void SetStringContent(string content, ContentEncoding contentEncoding?, string mediaType?);
string ベースの HTTP リクエスト本文を初期化します。既定では Content-Type: application/json と UTF-8 エンコーディングが使用されます。オプション パラメーターを使用して、いずれかを上書きできます。

​
SetUrlFormEncodedContent

void SetUrlFormEncodedContent(any content);
JavaScript オブジェクトからリクエスト本文を初期化し、application/x-www-form-urlencoded としてエンコードします。オブジェクトは、単純なプロパティ/値のペアのセットにしてください: 
var form = {};
form.grant_type = "password";
form.scope = "openid permissions";
form.client_id = "value of client_id";
form.client_secret = "value of client_secret";
form.password = "Password";
form.username = "User Name";
request.SetUrlFormEncodedContent(form);

Context

トランザクション データ、HTTP リクエスト、シークレットを扱うグローバル オブジェクト。

MultipartFormDataRequest

カスタム アクティビティ スクリプトから multipart/form-data の HTTP リクエストを送信します。

BinaryFile

バイナリ形式のファイル データ。通常は前処理前の元の画像です。

DocumentExportResult

スクリプトからエクスポートされたドキュメント ファイル (JSON、PDF、画像) にアクセスします。

ContentEncoding

string ベースの HTTP リクエストで使用できるエンコードの種類。

オブジェクト モデル

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