SK VMS User Manual

警報・監視システム、アクセス制御装置などの外部システムから、サーバーがHTTPリクエストを受信したときに発生します。これはデフォルトのイベントです。

SK VMS では、サードパーティーのシステムやデバイスが "createEvent" APIコールとしてHTTP文字列を送信できる仕組みを持ちます。サーバーが "createEvent" リクエストを読み取るためには、リクエストが適切な形式である必要があります。また、イベントルールで設定したイベントフィールドと、リクエストの対応するフィールドが一致している必要があります。

HTTPリクエストを送信できる「HTTP(S) リクエストを実行」アクションと併用すると、SK VMS  と他のソフトウェアシステムとの間で双方向API通信を作成できます。汎用イベントは、「HTTP(S)リクエストを実行」アクションで使用されるアクションパラメーターのプレースホルダーを、対応する (イベントで受け取った) パラメーターの値に自動的に置換することができます。完全なサーバーAPIドキュメントは、インストールされているサーバーの https://<サーバーIPアドレス>:<ポート>/#/api-tool からアクセスできます。詳細については、「サーバーのWebインターフェースの利用」を参照してください。

注意: イベントフィールドの値は大文字と小文字を区別します。空欄の場合はワイルドカードとして機能し、あらゆる値と一致します。

 

基本パラメーター

各リクエストには以下のフィールドが含まれます:

•ソース

•キャプション

•説明

•メタデータ – イベントに関連するデバイス (カメラ、I/O モジュール 等) を指定する、デバイス識別子を渡すために使用します。デバイス識別子は、デバイスのコンテキストメニューから [デバイス設定 > 一般] タブを開くと [カメラ/デバイスID] として表示されます。デバイス識別子は「{"cameraRefs":["<id>"]}」のフォーマットで渡す必要があります。 HTMLエンコーディングを行うと「{%22cameraRefs%22:[%22<id>%22]}」のようになります。

重要: 汎用イベントが「要確認」オプションを使用した通知アクションにリンクされている場合、デバイスを指定する必要があります。 この場合、通知が確認されるとブックマークが作成され、指定されたデバイスにリンクされます。詳細は「デスクトップ通知を表示」を参照してください。

•発生時/開始時/停止時 - これは "State" パラメーターに対するオプションフィールドです。HTTPリクエストに "State" フィールドがない場合、即時イベントと見なされます。指定された場合、イベントは継続的と見なされ、ルールには State=Active (開始) または State=Inactive (停止) 属性が必要となります。State=Activeを含む汎用イベントを受信すると、State=Inactiveかつ他が同じパラメーターの汎用イベントをサーバーが受信するまで、イベントアクションが継続します。

注意: 「デバイス録画」や「サウンド繰返し」などの継続的アクションが、即時属性の汎用イベント ("State" フィールドのないもの) に紐づけされている場合、ルールは機能しません (継続的イベントと即時イベントの詳細については「イベントルールの構成」参照)。

 

例

http://127.0.0.1:7001/api/createEvent?source=%22Door%22&caption=%22Knock%20Knock%22&description=%22Visitor!%22&metadata={%22cameraRefs%22:[%22066fbf9c-2e11-a501-6e15-dfb0fb97c7cb%22]}

この HTTP リクエストは以下の動作を行います。

•IPアドレス 127.0.0.1 及び ポート 7001 のサーバーにデータを送信

•ソース – "Door"

•キャプション – "Knock Knock"

•説明 – "Visitor!"

•State – 指定されていないため、即時イベント

•デバイス識別子 – 066fbf9c-2e11-a501-6e15-dfb0fb97c7cb

汎用イベントの各フィールドは、対応するHTTPリクエストと一致する必要があり、大文字と小文字が区別されることに注意してください。たとえば、ソース 「foo」、キャプション 「bar」、説明 "" (空欄) として構成されたイベントの場合:

 

追加パラメーター

•ログ書込みを省略 – チェックを入れると、このルールの汎用イベントはイベントログに追加されません。このオプションにより、イベントログの汚染に繋がるデータベースの呼び出しや保存を避けつつ、連続または非常に高い頻度でトリガーされるアクションを実行することができます (「ログ書込みを省略」チェックボックスが有効になっていても、「ログ書込み」アクションを持つ汎用イベントはイベントログに表示されます)。

•イベントスケジュール

 

イベントが正しく動作しない理由

•HTTPリクエストが正しく記述されていない。サーバーAPIドキュメントを参照してください。

•リクエストがフィルタリングされている。すべてのフィールド (ソース、キャプション、説明) をクリアして、HTTPリクエストを再度トリガーしてみてください。

•継続タイプのアクションに紐づけされているが、HTTPリクエストに "State" フィールドが含まれない。

•「要確認」オプションを使った通知アクションに紐づけされているが、デバイスが指定されていない。

•このイベントのグローバル通知が無効になっている。