规则配置

POST

https://api2.hik-cloud.com/api/v1/open/collectors/local/rules/create

接口描述
配置采集规则。
*备注：*规则配置最好在采集前完成，如果在人员采集过程中改变了采集规则，会导致设备上已采集人员的数据变成脏数据。不影响已经通过消息上报的人员采集信息。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api2.hik-cloud.com/api/v1/open/collectors/local/rules/create' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{

             
        "deviceSerial": "X34289430",

             
        "reqAdminRights": true,

             
        "cardNoAdaptive": false,

             
        "rules": [

             
            {

             
                "dataType": "employeeNo",

             
                "enable": true,

             
                "length": 64

             
            },

             
            {

             
                "dataType": "name",

             
                "enable": true,

             
                "uniqueCheck": false,

             
                "length": 4

             
            },

             
            {

             
                "dataType": "fingprint",

             
                "enable": true,

             
                "number": 2,

             
                "fingerprintNos": [1, 2]

             
            },

             
            {

             
                "dataType": "card",

             
                "enable": true,

             
                "length": 4,

             
                "number": 1

             
            }

             
        ]

             
    }'

响应示例

{
  "code": 200,
  "message": "操作成功"
}

请求参数

Header 参数

Authorization

string

可选

默认值:

Bearer {{access_token}}

Body 参数application/json

deviceSerial

string

设备序列号

必需

reqAdminRights

boolean

是否需要管理员权限，取值：[true，false]。描述：管理员权限采集时需要输入密码进行采集，退出采集界面后需要重新输入密码

必需

cardNoAdaptive

boolean

卡号长度自适应，取值：[true，false]。描述：优先级高于length字段，该参数为true时，规则列表中的卡号规则数据长度无效

必需

rules

array [object {6}]

规则列表

必需

dataType

string

规则类型，取值：[name-姓名，employeeNo-工号，IDCardNo-身份证号，IDCardSerialNo-身份证物理卡号，IDCardDetails-身份证其它信息，card-卡片，fingprint-指纹，face-人脸]

必需

enable

boolean

是否开启采集及显示，取值：[true，false]

必需

length

integer

数据长度，**仅dataType为name、employeeNo、card时有效**。备注：为name时默认128个字符，如果有值，即便enable为false，设备仍会校验该参数；为employeeNo时默认为32个字符；为card时表示卡号占字节大小而不是字符数，其值仅能为4；

必需

uniqueCheck

boolean

唯一性校验，取值：[true，false]。**仅dataType为name时有效**，默认为false。

可选

number

integer

采集数量，**仅dataType为fingprint、card时必填**。

必需

fingerprintNos

array[integer]

需要采集的指纹编号列表，**仅dataType为fingerprint时有效**，数量必须和number的值一致。

可选

示例

返回响应

🟢200成功

application/json

Body

code

integer

返回码

必需

message

string

返回信息

必需

data

string

返回数据对象

可选

修改于 2022-05-25 07:07:43

获取人脸采集进度

获取规则配置