Web サービス API を使用した MID サーバー へのイベントのプッシュ

  • リリースバージョン: Zurich
  • 更新日 2025年07月31日
  • 所要時間：5分

    • MID Web サービスイベントコレクターを設定して、イベントメッセージを MID サーバー にプッシュするための URL メソッドを提供します。

    デフォルトでは、MID Web サービスイベントコレクターを使用すると、イベントジェネレーターにコネクトし、次の形式の URL を使用して、MID サーバー 経由でイベントメッセージを送信できます：http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/jsonv2

    JSON v2 形式は、クライアントがインスタンスにイベントメッセージを送信するために使用する形式と同じです。この URL は良好なパフォーマンスで動作します。

    詳細については、「MID Web サービスイベントコレクターコンテキストの設定」を参照してください。
    注:
    イベント管理 は、リスナーからのイベントメッセージ送信時に経由した MID サーバー のタイムゾーンでイベントを受け入れます。別のタイムゾーンが必要な場合は、必要に応じてスクリプトを設定できます。「プッシュコネクタとの統合」を参照してください。

    カスタムペイロードをプッシュするための URL

    MID サーバー は、JSON、XML、またはプレーンテキストの形式でカスタムペイロードを受信することもできます。この場合、MID サーバー は、提供されたスクリプトインクルードを使用してイベントメッセージを変換してから、そのイベントをインスタンスに送信します。この場合の URL は、次のとおりです。

    http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/inbound_event?Transform={Transform_script_name} スクリプトインクルードの例については、デフォルトの TransformEvents_xmlSample スクリプトインクルードを参照してください。

    MID Web サービスイベントコレクターが JSON 形式のイベントメッセージを変換する方法の例については、「」を参照してください。

    汎用の JSON 形式でイベントを送信する場合は、次の形式の URL を使用できます。

    http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/inbound_event?Transform=TransformEvents_MidJsonGeneric

    この場合、ベースインスタンスに指定されている TransformEvents_MidJsonGeneric MID スクリプトインクルードによってイベントメッセージがイベントフィールドに変換されます。すべてのフィールドは、生成された ServiceNow イベントに [追加情報] フィールドとして追加されます。

    注:
    http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/{transform_script_name} 形式の URL もサポートされています。

    接続を検証するための REST API URL：http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/ping

    収集されたイベントを変換するためのスクリプトインクルード

    収集されたイベントメッセージを変換 (解析) し、マッピングされたイベントフィールドに入力するには、必要な MID サーバー スクリプトインクルードを使用します。MID サーバー スクリプトインクルード名は、プリフィックスとサフィックスで構成されます。プリフィックスは必須のテキスト TransformEvents_ で、サフィックスは URL の変換名 (http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/xmlSample など) です。したがって、作成されたスクリプト名は TransformEvents_xmlSample となります。

    イベントメッセージをテキスト変数で受け取るスクリプトインクルードを指定する必要があります。スクリプトには、変換を実行し、イベントオブジェクトのリターンアレイを準備する transform() 関数が含まれている必要があります。イベント管理 プラグインが有効になると、XML 形式のイベントを変換する TransformEvents_xmlSample サンプルインクルードスクリプトが提供されます。

    注:
    イベントテーブルのフィールドと異なるイベントフィールドは、[追加情報] フィールドに保存されます。

    イベントメッセージヘッダー

    イベントメッセージの形式に従って、[コンテンツタイプ] フィールドの関連する要求ヘッダー値を指定します。

    表 : 1. コンテンツタイプの要求ヘッダー値
    メッセージ形式 コンテンツタイプ値
    JSON application/json
    XML application/xml
    テキスト text/plain

    認証およびデータセキュリティのオプション

    認証およびデータセキュリティのオプション：
    • 認証タイプ。 API キー、 mTLS、 基本のいずれかに設定できます。
    • セキュア接続：送信時に送受信データを保護するかどうかを選択できます。詳細なセキュアオプションを選択した場合は、既知の認証局から証明書を取得し、[キーストア証明書の別名] および [キーストアパスワード] に入力する必要があります。
    • MID 統一キーストアを使用：暗号化保護を提供し、カスタム証明書を MID サーバー 統一キーストアにインストールできます。詳細については、「MID Server 統一キーストアにカスタム証明書をインストールする」を参照してください。
    • ユーザーは、JSON、XML、またはテキスト形式のイベントメッセージをテキスト変数で受け取るスクリプトを指定する必要があります。スクリプトには、変換を実行し、イベントオブジェクトのリターンアレイを準備する transform() 関数が含まれている必要があります。イベント管理 プラグインが有効になると、XML 形式からイベントを変換する TransformEvents_xmlSample インクルードスクリプトがサンプルとして提供されます。
    認証とデータセキュリティの詳細については、「MID Web サーバー 拡張の設定」を参照してください。