構成を行うには次の手順を実行します。

Web サービス

このリストで、次のいずれかを選択します。

事前構成された RESTful Web API

選択した RESTful サービスに応じて、事前構成されたベース URL が表示されます。 RESTful Web API で定義されたカスタム ヘッダーが、カスタム ヘッダーの下に表示されます。 Web サービス レファレンスをホワイトリストに登録できます。システム設定で「すべて許可」が選択されていない場合は、ホワイトリストに登録された Web サービス レファレンスのみを使用できます。サーバー URL とデータベース接続文字列の構成を参照してください。

事前構成された RESTful Open API Web サービス。「Web サービス参照の作成」を参照してください。

RESTful サービスで定義されたカスタム ヘッダーが、カスタム ヘッダーの下に表示されます。 パラメータの「構成」リンクが使用可能になります。 [構成] をクリックします。選択した RESTful サービスの統合で事前構成されたベース URL が表示されます。 [クラス] リストでクラスを選択します。選択したクラスで使用できるメソッドが表示されます。 [メソッド] リストで、メソッドを選択します。パラメータのリストがパラメータのタイプとともに表示されます。 インライン値または変数を使用してパラメータをマッピングします。 ドキュメントのバイナリ コンテンツを (ドキュメント インスタンス ID の代わりに) オプションで使用できるようにするには、ドキュメント変数を入力または出力としてバイナリ ストリームまたはバイト配列型パラメータにマップし、MIME の種類を指定します。ドキュメントのバイナリ データは、さまざまな MIME の種類 (PDF、TIFF、または JPEG など) にすることができます。したがって、バイナリ データの MIME の種類を指定して、実行時にキャプチャ ドキュメント コンテンツで正しく取得または更新する必要があります。 ドキュメント変数が文字列変数タイプにマップされている場合、バイナリ データをインスタンス ID の代わりに base64 文字列として指定することで、ドキュメントを取得または更新できます。「base64 文字列形式のデータ」または「インスタンス ID」オプションは、ドキュメント変数が入力または出力として文字列変数にマッピングされている場合に使用できます。デフォルトでは、「インスタンス ID」がマッピング タイプとして選択されています。データが base64 文字列として設定されている場合は、MIME タイプを指定する必要があります。指定された MIME の種類がドキュメントで使用できない場合、システムは実行時にエラーを報告します。 TotalAgility でサポートされている MIME の種類を参照してください。「XLT」MIME タイプは、RESTful サービス アクティビティには適用できません。 RESTful サービス アクティビティを実行すると、入力パラメータの場合、ドキュメント データが読み取られ、マップされた API パラメータに byte[] またはバイナリ ストリームとして渡されます。出力パラメータの場合、ドキュメント データは指定された byte[] またはストリームから設定されます。ドキュメント変数が既存のキャプチャ ドキュメントを指している場合、古いドキュメント データを更新する代わりに、新しいドキュメントが作成されます。

ベース URL

選択した RESTful サービスに応じて、事前構成されたベース URL が表示されます。

URL パラメータ

この項目は任意です。次のいずれかの操作を実行して、URL パラメータ (返される結果に影響を与える文字列型のパラメータ) を指定します。

• 静的なパラメータを指定するには、必要なテキストを入力します。

• 実行時に情報を動的に取得し、その情報をユーザーに対して表示するには、URL パラメータ ルール エディタを右クリックし、プロセス変数またはサーバー変数を選択します。

• 固定テキストと動的な値の組み合わせを使用します。

ベース URL パラメータをコピーして別の RESTful サービスのベース URL パラメータに貼り付けると、ベース URL パラメータを再利用できます。

メソッド

次のいずれかのオプションを選択します。

• [GET]: データを取得するには、このオプションを選択します。「データを取得するための RESTful サービス アクティビティの構成」を参照してください。

• [POST]: データを挿入するには、このオプションを選択します。「データを挿入するための RESTful サービス アクティビティの構成」を参照してください。

• [PUT]: データを更新するには、このオプションを選択します。「データを更新するための RESTful サービス アクティビティの構成」を参照してください。

• [DELETE]: データを削除するには、このオプションを選択します。「データを削除するための RESTful サービス アクティビティの構成」を参照してください。

タイプ

返される応答のコンテンツ タイプを選択します。

• XML (デフォルト)

• JSON

Web サービス参照の作成時に定義したカスタム ヘッダーとそのデフォルト値は、該当する Web サービスを選択すると [カスタム ヘッダー] の下に表示されます。

カスタム ヘッダーのデフォルト値を編集できます。

REST サービスから返されたステータス コードに基づいて Web サービスからの応答を処理したり、必要に応じて別の方法で応答を処理したりすることができます。

HTTP 応答ステータス コードは、特定の HTTP 要求が完了したかどうかを示します。

さまざまなステータス コード、説明、および応答マッピングを (変数または式を使用して) 定義できます。たとえば、100 ～ 399 の範囲および説明を「OK」と定義し、変数 A をマッピングしてから、2 番目の範囲 400 ～ 599および説明を「問題」と定義し、式をマッピングしてエラー メッセージを抽出することができます。

RESTful サービスによって返される応答ヘッダーにアクセスし、必要に応じてこれらの値を使用できます。

サーバーやコンテンツ タイプなどの標準ヘッダーがありますが、サービスに固有のカスタム ヘッダーが存在する可能性もあります。たとえば、Microsoft Forms Recognizer サービスは、ドキュメントからデータを抽出するために必要な値を持つ Operation-Location ヘッダーを返します。

名前 (インライン テキスト) と戻り値を保持する文字列変数を指定することで、応答ヘッダーのリストをキーと値のペアとして定義できます。

[エラー処理] で、返されたステータス コードの処理方法を指定します。

エラー時にジョブを一時停止

エラー時にジョブが一時停止されるようにするには、このチェック ボックスをオンにします。