Adapter - NeoFace Watch REST
This page describes version 2.0.1 of the adapter.
Overview
This adapter interfaces with a NeoFace Watch system to get or process images and manage watchlists, persons and their photos.
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 REST-API service (e.g. 'https://neoface.api.nec.com:7437') |
string |
https://:7437 |
|
|
1024 |
1 |
| username |
User Name |
True |
The user account for the Neoface Watch REST-API service. |
string |
|
|
|
1024 |
1 |
| password |
Password |
True |
The password for the Neoface Watch REST-API service. |
password |
|
|
|
1024 |
1 |
Commands
Add photo to Subject (addPhotoToSubject)
Add a photo to an existing subject.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| image |
Input Image |
Photo that needs to be added to the subject. |
True |
string |
| subjectid |
SubjectId |
SubjectId to which photo needs to be added. |
True |
string |
| allowDuplicateSubject |
Allow Duplicate Subject Photo |
Allow import of photo even if the system detects that it is the same subject. Otherwise, a duplicate subject photo error will occur. Default: false |
False |
boolean |
Response Properties
| Name |
Description |
Type |
| status |
Result of operation. |
string |
| photoId |
The photoId for the added photo. |
string |
| errors |
Detailed errors for update operation. |
array |
| errors.code |
The error detail code for the update operation. |
string |
| errors.message |
The error detail message for the update operation. |
string |
| errors.path |
The error detail path for the update operation. |
string |
Detect Face Age (detectFaceAge)
Returns the estimated age for a single face in an image.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| image |
Image |
The image to use to detect a face and return the estimated age. |
True |
string |
| algorithm |
Detection Algorithm |
Overrides the system default extraction profile's detection algorithm. valid values: d08, d09, d10, d11, hD5 |
False |
string |
| eyesMaxDistance |
Eyes Maximum Distance |
Overrides the system default extraction profile's maximum eye width distance. (0-2500 pixels) |
False |
string |
| eyesMinDistance |
Eyes Minimum Distance |
Overrides the system default extraction profile's minimum eye width distance. (0-500 pixels) |
False |
string |
| faceFrontalScore |
Face Frontal Score Threshold |
Overrides the system default extraction profile's face frontal score threshold setting. |
False |
string |
| faceQualityScore |
Face Quality Score Threshold |
Overrides the system default extraction profile's face quality score threshold setting. |
False |
string |
| faceReliability |
Face Reliability Score Threshold |
Overrides the system default extraction profile face reliability score threshold setting. |
False |
string |
| faceRoll |
Face Roll Threshold |
Overrides the system default extraction profile's face roll threshold setting. (0-90 degrees) |
False |
string |
Response Properties
| Name |
Description |
Type |
| age |
The estimated age for the detected face. |
string |
Detect Faces (detectFaces)
Detects all faces in an image and returns attributes for each face.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| image |
Image |
The image to detect faces in. |
True |
string |
| maxFaces |
Maximum Faces |
Overrides the system default extraction profile's detection algorithm. |
False |
string |
| algorithm |
Detection Algorithm |
Overrides the system default extraction profile's detection algorithm. valid values: d08, d09, d10, d11, hD5 |
False |
string |
| extractFeatures |
Extract Features |
Include binary face features in response? Default: false |
False |
boolean |
| eyesMaxDistance |
Eyes Maximum Distance |
Overrides the system default extraction profile's maximum eye width distance. (0-2500 pixels) |
False |
string |
| eyesMinDistance |
Eyes Minimum Distance |
Overrides the system default extraction profile's minimum eye width distance. (0-500 pixels) |
False |
string |
| faceFrontalScore |
Face Frontal Score Threshold |
Overrides the system default extraction profile's face frontal score threshold setting. |
False |
string |
| faceQualityScore |
Face Quality Score Threshold |
Overrides the system default extraction profile's face quality score threshold setting. |
False |
string |
| faceReliability |
Face Reliability Score Threshold |
Overrides the system default extraction profile face reliability score threshold setting. |
False |
string |
| faceRoll |
Face Roll |
Overrides the system default extraction profile's face roll threshold setting. (0-90 degrees) |
False |
string |
Response Properties
| Name |
Description |
Type |
| faces |
The faces found in the image. |
array |
| faces.count |
The number faces found in the image. |
string |
| faces.age |
The estimated age for the face. |
string |
| faces.genderScore |
Gender score - 0 to 1 (male) |
string |
| faces.faceQualityScore |
Face quality score |
string |
| faces.faceReliabilityScore |
Face reliability score |
string |
| faces.features |
Binary features encoded as base64 string. |
string |
Enroll Subject (enrollSubject)
Enroll a subject.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| image |
Image Frame |
Image frame bytes. |
True |
string |
| firstname |
First Name |
First Name for subject to be enrolled. |
True |
string |
| lastname |
Last Name |
Last Name for subject to be enrolled. |
True |
string |
| watchlist |
Watchlist |
Watchlist in which subject should be enrolled. |
True |
string |
| customfield1 |
Custom Field 1 |
Custom Field 1. |
False |
string |
| customfield2 |
Custom Field 2 |
Custom Field 2. |
False |
string |
| customfield3 |
Custom Field 3 |
Custom Field 3. |
False |
string |
| customfield4 |
Custom Field 4 |
Custom Field 4. |
False |
string |
| customfield5 |
Custom Field 5 |
Custom Field 5. |
False |
string |
| customfield6 |
Custom Field 6 |
Custom Field 6. |
False |
string |
| customfield7 |
Custom Field 7 |
Custom Field 7. |
False |
string |
| customfield8 |
Custom Field 8 |
Custom Field 8. |
False |
string |
| customfield9 |
Custom Field 9 |
Custom Field 9. |
False |
string |
| customfield10 |
Custom Field 10 |
Custom Field 10. |
False |
string |
| customfield11 |
Custom Field 11 |
Custom Field 11. |
False |
string |
| customfield12 |
Custom Field 12 |
Custom Field 12. |
False |
string |
Response Properties
| Name |
Description |
Type |
| status |
0/1 - Update Status. |
string |
| subjectid |
SubjectId of Enrolled Person. |
string |
| message |
Error message for update operation. |
string |
| errors |
Detailed errors for update operation. |
array |
| errors.code |
The error detail code for the update operation. |
string |
| errors.message |
The error detail message for the update operation. |
string |
| errors.path |
The error detail path for the update operation. |
string |
Find Or Create Watchlist (findOrCreateWatchlist)
Find or create a watchlist by name.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| watchlistName |
Watchlist Name |
Watchlist name to look for. Create one if it does not exist. |
True |
string |
Response Properties
| Name |
Description |
Type |
| watchlistid |
The watchlist Id of the watchlist found. |
string |
Find Subject by Features (findSubjectByFeatures)
Find a subject using image features.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| features |
Image Features |
Features of an image to find. |
True |
string |
| scoreThreshold |
Match Score Threshold |
Faces with a match score less than the match score threshold will not be returned. |
False |
string |
Response Properties
| Name |
Description |
Type |
| matches |
The subject matches found in the in the system. |
array |
| matches.count |
The number matches found in the system. |
string |
| matches.rank |
The rank number of subject candidate. |
string |
| matches.matchId |
MatchId of Person found. |
string |
| matches.subjectId |
SubjectId of Person found. |
string |
| matches.subjectPhotoId |
Subject photoId of Person found. |
string |
| matches.firstName |
First Name of Person found. |
string |
| matches.lastName |
Last Name of Person found. |
string |
| matches.watchlist |
Watchlist in which the Person is enrolled. |
string |
| matches.enrollmentDate |
The date the person was enrolled. |
string |
| matches.matchScore |
The matching score of the subject. |
string |
| matches.custom1 |
Custom Field 1. |
string |
| matches.custom2 |
Custom Field 2. |
string |
| matches.custom3 |
Custom Field 3. |
string |
| matches.custom4 |
Custom Field 4. |
string |
| matches.custom5 |
Custom Field 5. |
string |
| matches.custom6 |
Custom Field 6. |
string |
| matches.custom7 |
Custom Field 7. |
string |
| matches.custom8 |
Custom Field 8. |
string |
| matches.custom9 |
Custom Field 9. |
string |
| matches.custom10 |
Custom Field 10. |
string |
| matches.custom11 |
Custom Field 11. |
string |
| matches.custom12 |
Custom Field 12. |
string |
Find Person (findSubjectByImage)
Find a subject or person using an image.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| image |
Image |
Input image. |
True |
string |
| scoreThreshold |
Match Score Threshold |
Faces with a match score less than the match score threshold will not be returned. |
False |
string |
Response Properties
| Name |
Description |
Type |
| matches |
The subject matches found in the in the system. |
array |
| matches.count |
The number matches found in the system. |
string |
| matches.rank |
The rank number of subject candidate. |
string |
| matches.matchId |
MatchId of Person found. |
string |
| matches.subjectId |
SubjectId of Person found. |
string |
| matches.subjectPhotoId |
Subject photoId of Person found. |
string |
| matches.firstName |
First Name of Person found. |
string |
| matches.lastName |
Last Name of Person found. |
string |
| matches.watchlist |
Watchlist in which the Person is enrolled. |
string |
| matches.enrollmentDate |
The date the person was enrolled. |
string |
| matches.matchScore |
The matching score of the subject. |
string |
| matches.custom1 |
Custom Field 1. |
string |
| matches.custom2 |
Custom Field 2. |
string |
| matches.custom3 |
Custom Field 3. |
string |
| matches.custom4 |
Custom Field 4. |
string |
| matches.custom5 |
Custom Field 5. |
string |
| matches.custom6 |
Custom Field 6. |
string |
| matches.custom7 |
Custom Field 7. |
string |
| matches.custom8 |
Custom Field 8. |
string |
| matches.custom9 |
Custom Field 9. |
string |
| matches.custom10 |
Custom Field 10. |
string |
| matches.custom11 |
Custom Field 11. |
string |
| matches.custom12 |
Custom Field 12. |
string |
Find WatchList (findWatchlist)
Find a watchlist by name.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| watchlistName |
Watchlist Name |
Watchlist name to search for |
True |
string |
Response Properties
| Name |
Description |
Type |
| watchlistid |
The watchlist Id of the watchlist found. |
string |
Get Enrolled Image by Subject Id (getEnrolledImageBySubjectId)
Find enrolled image for a given Subject ID.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| subjectId |
SubjectID |
Subject ID to look for. |
True |
string |
Response Properties
| Name |
Description |
Type |
| image |
The enrolled image for given SubjectId. |
string |
| status |
Status of request. |
string |
Get Face Image (getFaceImage)
Get face image from a match.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| matchId |
Match ID |
The match id to get the image for. |
True |
string |
Response Properties
| Name |
Description |
Type |
| matchId |
The match id for the image. |
string |
| image |
The base64 encoded image string. |
string |
Get Frame Image (getFrameImage)
Get the frame image from a match.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| matchId |
Match Id |
The match id to get the image for. |
True |
string |
Response Properties
| Name |
Description |
Type |
| matchId |
The match id. |
string |
| image |
The base64 encoded image string. |
string |
Returns all subject information for a given Subject ID.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| subjectId |
Subject Id |
Subject ID to look for. |
True |
string |
Response Properties
| Name |
Description |
Type |
| firstName |
First Name of Person found. |
string |
| lastName |
Last Name of Person found. |
string |
| subjectId |
SubjectId of Person found. |
string |
| watchlist.id |
The Watchlist ID in which the Person is enrolled. |
string |
| watchlist.name |
The Watchlist Name in which the Person is enrolled. |
string |
| enrollmentDate |
The date person was enrolled. |
string |
| custom1 |
Custom Field 1. |
string |
| custom2 |
Custom Field 2. |
string |
| custom3 |
Custom Field 3. |
string |
| custom4 |
Custom Field 4. |
string |
| custom5 |
Custom Field 5. |
string |
| custom6 |
Custom Field 6. |
string |
| custom7 |
Custom Field 7. |
string |
| custom8 |
Custom Field 8. |
string |
| custom9 |
Custom Field 9. |
string |
| custom10 |
Custom Field 10. |
string |
| custom11 |
Custom Field 11. |
string |
| custom12 |
Custom Field 12. |
string |
Get Subject Image (getSubjectImage)
Get the image for the specified subject ID.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| subjectId |
Subject ID |
The subject ID for the subject image stored in the Neoface Watch system. |
True |
string |
| subjectPhotoId |
Photo ID |
The photo Id for a subject image. The photo Id will be the same as the subject Id, if only one photo is associated with the subject. |
False |
string |
Response Properties
| Name |
Description |
Type |
| imageId |
The image identifier of the image. |
string |
| image |
The base64 encoded image string. |
string |
Get Subject Image Count (getSubjectImageCount)
Return the number of images for the specified subject.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| subjectId |
Subject Id |
The subject id to look for. |
True |
string |
Response Properties
| Name |
Description |
Type |
| imageCount |
The number of images the subject has. |
string |
| status |
The status of the request. |
string |
Match Existing Subject (matchExistingSubject)
Find if a given image belongs to a particular subject (subjectId).
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| inputImage |
Input Image |
The image to match. |
True |
string |
| subjectId |
Subject Id |
Subject Id to match against. |
True |
string |
Response Properties
| Name |
Description |
Type |
| photos |
The photos for a subject Id |
array |
| photos.count |
The number photos for a subject. |
string |
| photos.score |
Match Score (0-1). |
string |
| subjectId |
Subject Id of the matched subject. |
string |
| photos.subjectPhotoId |
Subject Photo Id of the matched subject. |
string |
| status |
Error / success details of the operation. |
string |
Match Features (matchFeatures)
Compare face features of two images to see if they match the same face.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| features1 |
Face 1 Features |
The first face features to match. |
True |
string |
| features2 |
Face 2 Features |
The second face features to match. |
True |
string |
Response Properties
| Name |
Description |
Type |
| score |
Image match score (0-1). |
string |
| face |
Face features from face 2 features. |
string |
| subjectId |
The Subject ID for the person found. |
string |
| subjectPhotoId |
The Subject Photo ID for the person found. |
string |
Match Image to Features (matchImageAndFeature)
Compare face image to features of another face to see if they match.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| image |
Image |
The image to match with features. |
True |
string |
| features |
Features |
The features of an image to match. |
True |
string |
Response Properties
| Name |
Description |
Type |
| score |
Image match score (0-1). |
string |
| face |
Face features from the features. |
string |
| subjectId |
The Subject ID for the person found. |
string |
| subjectPhotoId |
The Subject Photo ID for the person found. |
string |
Match Images (matchImages)
Compare two images to see if they match the same face.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| scannedimage |
Scanned Image |
First image to match. |
True |
string |
| cameraimage |
Camera Image |
Second image to match. |
True |
string |
Response Properties
| Name |
Description |
Type |
| score |
Face match score (0-1). |
string |
| face |
The face features from the camera image. |
string |
| subjectId |
The Subject ID for the person found. |
string |
| subjectPhotoId |
The Subject Photo ID for the person found. |
string |
Match Results (matchResults)
Returns the match results for a match event.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| matchId |
Match ID |
The match id for the match event. |
True |
string |
Response Properties
| Name |
Description |
Type |
| subjectId |
The subject id. |
string |
| subjectName |
The name of the subject. |
string |
| watchlistId |
The id of the watchlist that matched. |
string |
| watchlistName |
The name of the watchlist that matched. |
string |
| cameraId |
The id of the camera. |
string |
| cameraName |
The name of the camera. |
string |
| locationId |
The id of the location. |
string |
| locationName |
The name of the location. |
string |
| matchTime |
local time of when match was made |
string |
| matchTimeUTC |
UTC time of when match was made. |
string |
| matchScore |
The score of the match. |
string |
| capturedFaceId |
The id of the captured face image on the server. |
string |
| capturedFrameId |
The id of the captured frame image on the server. |
string |
| enrolledPhotoId |
The id of the subject image the match was made against. |
string |
Search Subject (searchSubject)
Search for a subject.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| firstName |
First Name |
First Name of the subject. |
False |
string |
| lastName |
Last Name |
Last Name of the subject. |
False |
string |
| middleName |
Middle Name |
Middle Name of the subject. |
False |
string |
| title |
Title |
Title of the subject. |
False |
string |
| watchlistName |
Watchlist Filter |
Only returns subjects in the specified watchlist. |
False |
string |
Response Properties
| Name |
Description |
Type |
| numberOfSubjects |
Number of subjects found. |
string |
| subjectIds |
Comma separated list of subject ids found. |
string |
Update Person (updateSubject)
Updates a person (subject).
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| subjectid |
Subject Id |
SubjectID of person to update |
True |
string |
| firstname |
First Name |
First Name for subject to be updated. |
False |
string |
| lastname |
Last Name |
Last Name for subject to be updated. |
False |
string |
| notes |
Notes |
Notes for subject to be updated. |
False |
string |
| watchlist |
Watch List |
Watch list in which subject should be updated. |
False |
string |
| customfield1 |
Custom Field 1 |
Custom Field 1. |
False |
string |
| customfield2 |
Custom Field 2 |
Custom Field 2. |
False |
string |
| customfield3 |
Custom Field 3 |
Custom Field 3. |
False |
string |
| customfield4 |
Custom Field 4 |
Custom Field 4. |
False |
string |
| customfield5 |
Custom Field 5 |
Custom Field 5. |
False |
string |
| customfield6 |
Custom Field 6 |
Custom Field 6. |
False |
string |
| customfield7 |
Custom Field 7 |
Custom Field 7. |
False |
string |
| customfield8 |
Custom Field 8 |
Custom Field 8. |
False |
string |
| customfield9 |
Custom Field 9 |
Custom Field 9. |
False |
string |
| customfield10 |
Custom Field 10 |
Custom Field 10. |
False |
string |
| customfield11 |
Custom Field 11 |
Custom Field 11. |
False |
string |
| customfield12 |
Custom Field 12 |
Custom Field 12. |
False |
string |
Response Properties
| Name |
Description |
Type |
| status |
0/1 - Update Status. |
string |
| message |
Error message for update operation. |
string |
| errors |
Detailed errors for update operation. |
array |
| errors.code |
The error detail code for the update operation. |
string |
| errors.message |
The error detail message for the update operation. |
string |
| errors.path |
The error detail path for the update operation. |
string |
Release History
| Version |
Type |
Description |
Tracking # |
Date |
| 2.0.1 |
Initial |
First release in the Adapter Type store. |
NAP-24583 |
2022-03-02 |
Categories