Adapter - NeoFace Watch REST Event
This page describes version 2.0.1 of the adapter.
Overview
This adapter is used to receive events from a NeoFace Watch system.
Properties
| Name | Display | Is Required | Comments | Type | Default Value | Maximum Value | Minimum Value | Maximum Length | Minimum Length |
|---|---|---|---|---|---|---|---|---|---|
| baseURL | Base URL | True | The base URL for the Neoface Watch Event service (e.g. 'https://neoface.api.nec.com:7437') | string | https:// |
1024 | 1 | ||
| username | User Name | True | The user account for the Neoface Watch Event service. | string | 1024 | 1 | |||
| password | Password | True | The password for the Neoface Watch Event service. | password | 1024 | 1 | |||
| filterDelimiter | Filter Delimiter Character | False | The delimiter character to use to separate filter names. default: ',' | string | , | 1 | 1 | ||
| watchlistFilter | Watchlist Filter | False | A list of watchList names to filter match events. | string | 1024 | 1 | |||
| cameraFilter | Camera Filter | False | A list of camera names to filter match events (exclusively). If set, Location and Site filters can not be set. | string | 1024 | 1 | |||
| locationFilter | Location Filter | False | A list of location names to filter match events (exclusively). If set, Camera and Site filters can not be set. | string | 1024 | 1 | |||
| siteFilter | Site Filter | False | A list of site names to filter match events (exclusively). If set, Camera and Location filters can not be set. | string | 1024 | 1 |
Events
Match (match)
A subject has been matched.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| matchId | Match Id | The id of the match. | string |
| matchScore | Match Score | The score of the match. | string |
| subjectId | Subject Id | The subject id in Neoface. | string |
| name | Subject Name | The name of the subject. | string |
| watchlistId | Watchlist Id | The id of the watchlist that matched. | string |
| watchlistName | Watchlist Name | The name of the watchlist that matched. | string |
| faceReliabilityScore | Match Face Reliability Score | The face reliability score for the match. | string |
| faceQualityScore | Match Face Quality | The face reliability score for the match. | string |
| faceRoll | Face Roll | The face roll value for the match. | string |
| eyesWidth | Eyes Width | The eye width value for the match. | string |
Release History
| Version | Type | Description | Tracking # | Date |
|---|---|---|---|---|
| 2.0.1 | Initial | First release in the Adapter Type store. | NAP-24584 | 2022-03-02 |