プロパティ
| 名前 | 型 | 説明 |
|---|---|---|
| Url | string | リソースのURL。 |
| Method | string | リクエストの種類(例: GET または POST)。 |
| AuthToken | string | 認証トークン(外部サービスの認証が必要な場合)。 |
| AuthScheme | string | 認証方式。 |
| ThrowExceptionOnFailed | boolean | 外部サービスがHTTPレスポンスのステータスとしてエラーコード(200〜299の範囲外)を返した場合に、例外を発生させるかどうかを指定します。False の場合、外部サービスがエラーコードを返しても例外は発生しません。HTTPレスポンスコードのステータスは Status プロパティの値を確認してください。デフォルトは True です。重要: レスポンスにエラーコードが含まれるのは、外部サービスが稼働しており要求に応答していることを意味します。HTTPリクエスト送信時にサービスの可用性やインターネット接続に起因するエラーが発生した場合は、このプロパティの値に関わらずプログラム例外が発生します。これは、その場合は外部サービスのHTTPステータスコードが提供されないためです。 |
| Timeout | number | リクエストのタイムアウト(分)。デフォルトは 1 分。重要: リクエストのタイムアウト値はスクリプトの実行時間制限(600秒)を超えることはできません。 |
| ResponseText | string, 読み取り専用 | レスポンス結果のテキスト形式。 |
| ResponseType | string, 読み取り専用 | サービスから返されるレスポンスの種類(例: “application/json”)。 |
| Status | number | 外部サービスのHTTPレスポンスステータスコード。ThrowExceptionOnFailed が True の場合、エラーコードで例外が発生し、トランザクションは中断されます。エラーメッセージのテキストは Skill Monitor で確認できます。 |
メソッド
| Name | Description |
|---|---|
| SetHeader(string name, string value); | リクエストに追加の HTTP ヘッダーを設定します。ヘッダー名ごとにこのメソッドを呼び出してください。 |
| Send(); | HTTP リクエストを送信します。 |
| SetFileContent(DocumentExportResult documentExportResult, string mediaType?); | フロー ベースの HTTP リクエストを初期化し、エクスポートされたデータをファイルとして渡せるようにします。渡すコンテンツの種類は、エクスポート ファイルの拡張子に基づいて自動的に設定されます(例: application/json、application/pdf)。必要に応じて、任意の mediaType オプション引数でコンテンツ タイプを事前に指定できます。 |
| SetFileContent(BinaryFile binaryFile, string mediaType?); | バイナリ データ ベースの HTTP リクエストを初期化し、トランザクション作成時にインポートされた元の画像ファイル、または Picture 型の field に含まれる画像のいずれかを渡します。渡すコンテンツの種類は、インポート ファイルの拡張子に基づいて自動的に設定されます。必要に応じて、任意の mediaType オプション引数でコンテンツ タイプを事前に指定できます。 |
| SetSourceFileContent(string mediaType?); | バイナリ データ ベースの HTTP リクエストを初期化し、トランザクション作成時にインポートされた元の画像ファイルを渡せるようにします。渡すコンテンツの種類は、インポート ファイルの拡張子に基づいて自動的に設定されます。必要に応じて、任意の mediaType オプション引数でコンテンツ タイプを事前に指定できます。重要: このメソッドは非推奨です。トランザクション内の最初のファイルにしかアクセスできません。代わりに SetFileContent() メソッドを使用してください。 |
| SetStringContent(string content, ContentEncoding contentEncoding?, string mediaType?); | string ベースの HTTP リクエストを初期化します。既定では Content-Type は UTF-8 エンコーディングの application/json に設定されます。必要に応じて、コンテンツ タイプとエンコーディングの両方を変更できます。 |
| SetUrlFormEncodedContent(any content); | JavaScript オブジェクト ベースのリクエスト用コンテンツを初期化し、application/x-www-form-urlencoded としてエンコードします。JavaScript オブジェクトは単純なプロパティ値の集合として初期化してください。例: 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); |
