JavaScript
JSON
rest
ServiceNow
inbound

ServiceNowのInbound REST Messageを作成して動作確認する

概要

ServiceNowではバッチ処理などを定期的にキックする仕組みがあるが、ServiceNowのスケジュール処理を使用せずに、JP1などの外部のタスクスケジュール管理ソフトから起動したい場合に、ServiceNowのInboud REST Messageを使う。例えばJP1からシェルを実行し、シェルからcurlなどのコマンドで、ServieNowのInbound REST Messageを起動するような使い方を想定する。
また、1つのURLで複数の異なる処理を呼び出し可能とするため、クエリーパラメーターのfunctionnameで処理名を設定し、POSTメッセージにその処理に渡す引数をJSONにより設定する仕様とした。

なお、準備として下記の「Sales」Table作成と、「updateProductPrice」Scrip Includeを作成しておく。

ServiceNowでTableを作成する
ServiceNowのScript IncludeでGlideRecordを使ってレコード一括更新を行う

手順

Inbound IntegrationsのScripted REST APIを追加

Studioを使ってCreate Application FileでInbound IntegrationsのScripted REST APIを追加する。

AddInboundRestAPI.png

一旦、Nameを入力してSubmitで保存すると、Resourcesのレコードリストが表示される。
なお、このときAPP IDの値を使って、REST APIを起動時のURLのパスが生成される。生成されたURLはBASE Api pathに表示されている。

ScriptedRestService.png

Query Paremeterの追加

Query Parametersタブに切り替えて、「New」をクリックで次の通りQuery Parameterを追加する。

QueryParameterRecordList.png

今回は、functionnameをクエリーパラメーターとして追加している。

QueryParameterSetting.png

Scripted REST Resourceを追加

ResourcesのレコードリストのNewをクリックしてScripted REST Resourceを追加する。

次の通り入力する。

項目
Name callsalesapi
HTTP Method POST
Relative Path /

また、こちらにもQuery Parameterを追加する。

queryparameter_at_resource.png

これで、functionnameをクエリパラメーターとしてスクリプトで受け取ることが可能となる。

次にScriptに次の通り入力する。

(function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) {

    var queryParams = request.queryParams; 
    var functionName = queryParams.functionname;
    var requestBody = request.body;
    var requestData = requestBody.data;

    gs.info('functionname = ' + functionName);


    if ( functionName == 'updateproductprice' ) {
        var updateProductPriceObj = new updateProductPrice();       
        updateProductPriceObj.update(requestData);
    }


})(request, response);

クエリーパラメーターのfunctionnameで分岐して呼び出す処理を決めることを想定している。
ここで、Script Includeで作成した、updateProductPrice.updateを起動している。
updateの引数には、POSTで次のようなJSONメッセージのオブジェクトを渡すことを想定している。

{"product":"PPP","unitprice":"500"}

updateProductPrice.updateは引数の情報を元にSalesテーブルを一括更新する処理を実行する。

ここまでで、Inbound REST Messageの作成は完了だ。
次に作成したメッセージを実際に試して動作確認してみる。

動作確認手順

動作確認画面の起動

Script Resourceの設定画面の中段の「Related Links」の「Explorer REST API」をクリックする。

ClickExplorerApi.png

この画面から作成したREST APIを起動できる。

Explorer REST APIの設定

functionnameに「updateproductprice」を入力する。
Request Bodyの「Add a field」をクリックして次の通りPOSTメッセージを生成する。

RequestBody.png

名称と値を入力していくと、自動的にPOSTするJSONメッセージが作成される。

いよいよ実行

ここまでExplorer REST APIの設定ができたら、Sendをクリックして実行する。
確認メッセージが表示されるので、「OK」をクリックするとREST APIを起動してその応答結果が画面に表示される。
成功すれば、「200」が表示されているはずだ。失敗の場合の「500」でエラーメッセージが表示される。
下記は呼び出し成功の場合の例だ。

LOG1.png

LOG2.png

クエリーパラメーターのfunctionnameが設定されていること。
POSTメッセージにJSONメッセージが送信されていることが画面から分かる。

最後に

複数のREST APIを用意したい場合に、URLのパスで起動するAPIを分けるか、URLは同じで、今回のようにクエリーパラメーターで呼び分けるか、もしくは他にもっとスマートな方法がないか検討している。
今回のやり方では、APIを追加するたびに、if elseif の分岐処理を追加していく必要がある。

Javaであれば、クラス名を文字列で受け取りリフレクションを使ってクラスのインスタンスを生成することで、if文を追加せずに、起動するクラスを呼び分けることが可能だが、JavaScriptもしくはServiceNowの仕組みで同等の事が出来ないかを調べていく予定だ。