SK VMS User Manual

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

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

HTTP リクエストを送信できる「HTTP(S) リクエスト送信」アクションと併用すると、SK VMS と他のソフトウェアシステムとの間で双方向API通信を作成できます。汎用イベントは、「HTTP(S) リクエスト送信」アクションで使用されるアクションパラメーターのプレースホルダーを、対応する (イベントで受け取った) パラメーターの値に自動的に置換することができます。

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

 

基本パラメーター

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

•ソース

•キャプション

•説明

•メタデータ – イベントに関連するデバイス (カメラ、I/O モジュール 等) を指定する、デバイス識別子を渡すために使用します。

デバイス識別子は、デバイスのコンテキストメニューから [デバイス設定 > 全般] タブを開くと「カメラ/デバイスID」として表示されます。デバイス識別子は「{"cameraRefs":["<id>"]}」のフォーマットで渡す必要があります。URLエンコーディングを行うと「{%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" フィールドが含まれない。

•「要確認」オプションが有効な通知アクションに紐づけされているが、HTTP リクエストにデバイスが指定されていない。

•このイベントのグローバル通知が無効化されている。