I/F事後処理設定を定義しよう
クエスト概要
アウトプットの連携方式にAPIを選択し、アウトプット基本情報を定義しようで「I/F事後処理の利用有無」を「定義する」とした場合にこのクエストは解放されます。
I/F事後処理とは、連携で呼び出すAPIの後に、任意のAPIを呼び出したり、ステータス監視をする処理のことです。
主に、連携で呼び出すAPIが非同期実行、かつ、その実行結果をtaias上の実行履歴にも反映したい場合に利用します。
用語一覧
このクエストで登場する用語を解説します。
アウトプットのレスポンス項目一覧
アウトプットのレスポンス項目一覧を作成しようのクエストで作成した項目一覧が表示されます。
ポーリング設定
事後処理で実行したAPIの結果を定期的に監視して、実行結果を取得するために設定します。
URL
事後処理として実際に実行したいバッチ等のAPIのURLを定義します。 リクエストメソッドをGET/POST/PUT/DELETEの中から選択した後、ホスト名以降のURL情報を定義して下さい。 ホスト名は接続情報で定義された情報をもとに実行されるので、ここでは指定する必要はありません。 URLには、アウトプットのレスポンス項目一覧で定義した項目を利用することができます。 アウトプットのレスポンス項目を指定した場合は、実際に出力APIを実行したレスポンスの値が実行時に解決されて指定されます。 アウトプットのレスポンス項目の値は、{item:【アウトプットのレスポンス項目のプロパティ名】}で表現されます。
クエリパラメータ
クエリパラメータには、アウトプットのレスポンス項目一覧で定義した項目を利用することができます。アウトプットのレスポンス項目を指定した場合は、実際に出力APIを実行したレスポンスの値が実行時に解決されて指定されます。アウトプットのレスポンス項目の値は、{item:【アウトプットのレスポンス項目のプロパティ名】}で表現されます。
リクエストヘッダパラメータ
リクエストヘッダは、WebAPIにリクエストを送る際に、HTTPリクエストに含める情報のことです。 ブラウザの種類やバージョン、言語、リクエストがどのページから来たか、クッキー情報などが含まれます。 ここではAPI毎にHTTPリクエストを投げる際のリクエストヘッダパラメータを定義します。 リクエストヘッダは、トークンの指定が必要なケースがありますが、トークン自体はテスト環境と本番環境など、接続する環境毎に異なる値になります。ですので、I/F定義で定義するリクエストヘッダは、APIリファレンスに記載されている指定が必要なリクエストヘッダパラメータから、環境に依存せずに決められるものだけを定義するようにしてください。
ポーリングAPIレスポンス
ポーリングAPIで返却されるAPIの値を定義します。 これを定義することで、どういった時に正常/異常終了とするのか、ということを条件に指定します。 このポーリングAPIとして定義する値は、jsonを取り込んで定義します。APIのリファレンスに記載されているサンプルリファレンスを利用するか、APIの担当者に確認の後、jsonファイルを作成して取り込んでください。
異常終了条件
事後処理で実行するAPIの実行結果を異常終了とする条件を定義します。条件はポーリングAPIレスポンスで指定した項目に対して定義して下さい。ここで指定した条件に合致する場合、I/Fの実行結果は異常終了となります。
正常終了条件
事後処理で実行するAPIの実行結果を正常終了とする条件を定義します。 条件はポーリングAPIレスポンスで指定した項目に対して定義して下さい。ここで指定した条件に合致する場合、I/Fの実行結果は正常終了となります。
繰り返しの間隔（秒）
ポーリングのAPIをどの間隔で実行するのか、秒を指定して定義します。
タイムアウト（分）
ポーリングのAPIを繰り返し実行した結果、最初のポーリングから何分経過したらタイムアウトとするのか定義します。