- 新着としてマーク
- ブックマーク
- 購読
- ミュート
- RSS フィードを購読する
- ハイライト
- 印刷
- 不適切なコンテンツを報告
02-14-2024 06:40 PM
コミュニティの皆様
いつもお世話になっております。
私はプログラム初心者でServiceNowの歴も浅く、日々勉強中の状況となります。
詳細な経緯は省きますが、お客様の要望で、
REST APIがどのような機能が教えてほしいと依頼されております。
REST APIを使用した経験がないため、初歩的な質問になるのですが、
下記3点について、認識に相違や不明点を教えて頂けないでしょうか。
①REST APIを使用する目的:Third Party Application(外部機能)との連携で使用される?
②REST APIのトリガー:不明(どのようにして、REST APIが実行されるかイメージできない)
③Business RuleやScript Include等、他のサーバーサイドの処理でダメな理由がわからない
(※REST API内で、Script Includeを呼び出すみたいことはあると思いますが、
なぜ外部機能との連携で、REST APIを使用するのかあまり理解ができていないです。。)
よろしくお願いいたします。
解決済! 解決策の投稿を見る。
- ラベル:
-
rest API
- 新着としてマーク
- ブックマーク
- 購読
- ミュート
- RSS フィードを購読する
- ハイライト
- 印刷
- 不適切なコンテンツを報告
02-15-2024 06:56 AM
はい、パラメーターはHTTPリクエストに含まれますので、外部機能の方で設定します。
ServiceNow インスタンスはそのHTTPリクエストをトリガーとして処理を実行し、応答を返します。
- 新着としてマーク
- ブックマーク
- 購読
- ミュート
- RSS フィードを購読する
- ハイライト
- 印刷
- 不適切なコンテンツを報告
02-14-2024 08:21 PM
こんにちは、
まず初めになのですが、REST APIというのはServiceNow固有の機能名ではなく、
一般的にシステム間で情報を問い合わせたり何らかの変更をHTTP(s)プロトロルを使って実施するための、RESTという設計思想にのっとったAPIつまりインターフェース、入り口です。
ServiceNowのインスタンスにもありますが、他のアプリケーションにもそれぞれ用意されているAPIになります。
REST APIはHTTPを使った比較的軽量で使いやすいとされており、システム間連携でも多く使用されるAPIの形式になります。
以上を踏まえた上で、
① ServiceNowインスタンスに対するREST APIの使用目的は、外部の別のアプリケーションとの連携手法の一つになります。
② RESTAPIのトリガーは、ServiceNowインスタンスに対しての物であれば、必ずREST APIが呼ばれたタイミング、つまりHTTPリクエストがなされたタイミングになります。
REST APIは決められたURLに対して、必要なパラメーターをセットして、決められたHTTPメソッド(何をしたいかの種類)でHTTPリクエストを投げると、受けた側が内部でリクエストを処理して結果を返します。
以下URLに掲載されているものに関しては既に内部で動作が決められており、仕様通りの結果が返されるように設計されています。
https://docs.servicenow.com/ja-JP/bundle/vancouver-api-reference/page/build/applications/concept/api...
APIはFlow Designerのトリガーにも設定することが可能ですが、その場合は内部処理をFlow Designerで記述していただく必要があります。
③Business RuleやScript Includeはサーバーサイドの中での処理が主になります。
REST APIを通してきたリクエストを処理する、あるいは処理の結果を他のシステムのREST APIにリクエストする、は記述できます。
- 新着としてマーク
- ブックマーク
- 購読
- ミュート
- RSS フィードを購読する
- ハイライト
- 印刷
- 不適切なコンテンツを報告
02-15-2024 03:06 AM
Yusuke Miayke様、ご回答ありがとうございます。
前提及び①について、理解しました。
②の「決められたURLに対して、必要なパラメーターをセットして、決められたHTTPメソッド(何をしたいかの種類)でHTTPリクエストを投げる」について、このパラメータのセットというのは、
外部機能の方で設定するイメージでしょうか。(つまりServiceNow側にトリガーは存在しない)
- 新着としてマーク
- ブックマーク
- 購読
- ミュート
- RSS フィードを購読する
- ハイライト
- 印刷
- 不適切なコンテンツを報告
02-15-2024 06:56 AM
はい、パラメーターはHTTPリクエストに含まれますので、外部機能の方で設定します。
ServiceNow インスタンスはそのHTTPリクエストをトリガーとして処理を実行し、応答を返します。
- 新着としてマーク
- ブックマーク
- 購読
- ミュート
- RSS フィードを購読する
- ハイライト
- 印刷
- 不適切なコンテンツを報告
02-19-2024 04:31 PM
追加のQAが発生しましたので、ご存知でしたら、ご教示頂けないでしょうか。
QA:
APIのリクエストについて、例としてAアプリケーションにAPIのパス(URL)を設定して、
リクエスト送受信を可能にしたいという要件があったとします。
ただし、ServiceNowのIP Address Access Conrtrol機能で、
全範囲で、Inbound+Denyに設定し、特定のアプリケーション(Aアプリケーション以外)で、
Inbound+Allowに設定している場合、
Aアプリケーションから→ServiceNowのリクエスト並びに、
ServiceNowからAアプリケーションへのレスポンスは通るのでしょうか。
※対象ドキュメントやKBがあれば、併せてご連携頂きたいです。