概要
REST API ExplorerとはServiceNowのAPIを使うプログラムを作成する場合に利用できるツールです。
REST API Explorerを使うと次の利点があります。
- ページからServiceNowのAPI設定を行えます
- 実際にそのAPIを呼び出しでデータを取得することができる
- 設定したパラメータを含むソースコートを生成することができる
(ServiceNowスクリプト、cURL、Python、Ruby、JavaScript、Perl、Powershell)
REST APIを利用してインシデントデータを取得するスクリプトを作成する手順
1.アプリケーションナビゲータから「REST」を検索して、「システムWebサービス」下の「REST API Explorer」を選択
2.今回はServiceNowインシデントを取得するため「Retrive records from a table (GET)」を利用。tableNameを「インシデント」に指定。
3.先ず試しにデータを取得して見る。
ページの下の方にある「送信」ボタンを押下。
4.ページの下に結果が表示される。試しなので1レコードのみ取得される。
5.取得条件を絞る。Webブラウザで別タブを開いてServiceNowページを表示する。
アプリケーションナビゲータから「インシデント」を検索して、「インシデント」下の「すべて」を選択。
6.漏斗アイコンをクリックして条件を入力する
7.更に列ヘッダの検索フィールドに文字列を入力して結果を絞る
8.ブレッドクラムを右クリックして「クエリのコピー」を選択
9.元のREST API Explorerに戻り、「sysparam_query」フィールドを右クリックして「貼り付け」を選択
10.検索条件が入力される。
最大10件のレコードを取得するようにする。「sysparam_list」を「10(テストでは、結果は10件に制限されています)」を選択。
取得するフィールドも制限する。「sysparam_fields」右の鉛筆アイコンを選択
11.取得するフィールド名を選択した後に「保存」ボタンを押下
12.再び試す。
「送信」ボタンを押下
13.指定した条件のデータが取得されたことを確認
14.ページ中央にある「コードサンプル」へ移動
今回はJavaScriptのソースコートを生成して見る。「JavaScript」リンクを選択
15.JavaScriptのソースコードが表示さる。「スニペットの選択」ボタンを押下するとコードはコピーされる。