转租预警API

更新时间：2019-09-03 17:53:48

概述

转租预警服务提供了一组接口，对分析任务进行增删改查，并查询分析任务的执行历史。

接口列表

接口名 简介
创建通行记录分析任务 录入配置参数，创建通行记录分析任务
更新通行记录分析任务 更新配置参数，包括任务开关等
删除通行记录分析任务 删除通行记录分析任务
获取通行记录分析任务 根据任务名称查看任务的配置参数
查询通行记录分析任务 根据条件查询任务列表
查询分析任务执行历史 查询分析任务执行历史

数据定义

用户角色

使用整型枚举值作为用户角色，在上传人脸数据和配置任务参数时传入，用于界定分析服务的用户范围。

数值 用户角色
1 业主
2 业主家属
3 租客
4 租客家属
5 访客
6 物业
99 其他

接口定义

创建通行记录分析任务

/entrance/pass/record/analysis/job/create
  • 当前版本：1.0.0

入参

参数 类型 长度限制 是否必填 备注
jobName String 64 是 任务名称，作为任务唯一标识，不支持修改
jobDescription String 128 否 任务描述，可修改
rootSpaceId String 64 是 根空间ID
exeTime String 8 是 执行时间HH:MM，精确到分钟
analyseDays Integer 是 分析天数（分析过去N天的记录），N≤180
analyseDaysMin Integer 是 最小分析天数，用户信息录入天数小于此值的不做分析
passThreshold Integer 是 最小通行次数，小于此值的用户作为结果输出
userRoleList JSONArray 是 需要分析的用户角色列表
enabled Boolean 是 是否启用

出参

返回结果使用通用结果类型，不使用data域。

示例

入参示例：创建并启动任务

{
  "jobName": "数据分析服务A",
  "rootSpaceId": "xxxx",
  "exeTime": "09:00",
  "analyseDays": 30,
  "analyseDaysMin": 10,
  "passThreshold": 3,
  "userRoleList": [1,3],
  "enabled": true
}

更新通行记录分析任务

/entrance/pass/record/analysis/job/update
  • 当前版本：1.0.0

入参

参数 类型 长度限制 是否必填 备注
jobName String 64 是 任务名称
jobDescription String 128 否 任务描述
rootSpaceId String 64 否 根空间ID
exeTime String 8 否 执行时间HH:MM，精确到分钟
analyseDays Integer 否 分析天数（分析过去N天的记录），N≤180
analyseDaysMin Integer 否 最小分析天数，用户信息录入天数小于此值的不做分析
passThreshold Integer 否 最小通行次数，小于此值的用户作为结果输出
userRoleList JSONArray 否 需要分析的用户角色列表
enabled Boolean 否 是否启用

出参

返回结果使用通用结果类型，不使用data域。

示例

入参示例：暂停任务

{
  "jobName": "数据分析服务A",
  "enabled": false
}

删除通行记录分析任务

/entrance/pass/record/analysis/job/delete
  • 当前版本：1.0.0

入参

参数 类型 长度限制 是否必填 备注
jobName String 64 是 任务名称

出参

返回结果使用通用结果类型，不使用data域。

示例

入参示例：删除任务

{
  "jobName": "数据分析服务A"
}

获取通行记录分析任务

/entrance/pass/record/analysis/job/get
  • 当前版本：1.0.0

入参

参数 类型 长度限制 是否必填 备注
jobName String 64 是 任务名称

出参

返回结果使用通用结果类型，data域为JSON对象。

参数 类型 备注
jobName String 任务名称
jobDescription String 任务描述
rootSpaceId String 根空间ID
exeTime String 执行时间HH:MM，精确到分钟
analyseDays Integer 分析天数（分析过去N天的记录）
analyseDaysMin Integer 最小分析天数，用户信息录入天数小于此值的不做分析
passThreshold Integer 最小通行次数，小于此值的用户作为结果输出
userRoleList JSONArray 需要分析的用户角色列表
enabled Boolean 是否启用

示例

入参示例

{
  "jobName": "数据分析服务A"
}

出参示例：返回任务配置

{
  "code": 200,
  "message": "success",
  "data": {
    "jobName": "数据分析服务A",
    "rootSpaceId": "xxxx",
    "exeTime": "09:00",
    "analyseDays": 30,
    "analyseDaysMin": 10,
    "passThreshold": 3,
    "userRoleList": [
      1,
      3
    ],
    "enabled": false
  }
}

查询通行记录分析任务

/entrance/pass/record/analysis/job/list
  • 当前版本：1.0.0

入参

参数 类型 长度限制 是否必填 备注
rootSpaceId String 64 否 根空间ID，有值则查询该空间下的任务列表，无值则查询租户的所有任务列表

出参

返回结果使用通用结果类型，data域为JSON数组，表示已创建的任务列表。

参数 类型 备注
jobName String 任务名称
jobDescription String 任务描述
rootSpaceId String 根空间ID
exeTime String 执行时间HH:MM，精确到分钟
analyseDays Integer 分析天数（分析过去N天的记录）
analyseDaysMin Integer 最小分析天数，用户信息录入天数小于此值的不做分析
passThreshold Integer 最小通行次数，小于此值的用户作为结果输出
userRoleList JSONArray 需要分析的用户角色列表
enabled Boolean 是否启用

示例

出参示例：返回任务配置列表

{
  "code": 200,
  "message": "success",
  "data": [
    {
      "jobName": "数据分析服务A",
      "rootSpaceId": "xxxx",
      "exeTime": "09:00",
      "analyseDays": 30,
      "analyseDaysMin": 10,
      "passThreshold": 3,
      "userRoleList": [
        1,
        3
      ],
      "enabled": false
    }
  ]
}

查询分析任务执行历史

/entrance/pass/record/analysis/job/exe/list
  • 当前版本：1.0.0

入参

参数 类型 长度限制 是否必填 备注
jobName String 64 是 任务名称
startDate String 8 是 查询开始日期，格式YYYYMMDD
endDate String 8 是 查询结束日期，格式YYYYMMDD

注：仅支持查询过去30天的执行历史。

出参

返回结果使用通用结果类型，data域为JSON数组。

参数 类型 备注
jobName String 任务名称
jobDate String 执行日期，格式YYYYMMDD
finishTime Long 任务执行完成时间戳
status String 任务执行状态
errorMessage String 错误信息
resultModelId String 分析结果的数据模型ID
resultCount Integer 分析结果的条数

示例

入参示例

{
  "jobName": "数据分析服务A",
  "startDate": "20190801",
  "endDate": "20190831"
}

出参示例

{
  "code": 200,
  "message": "success",
  "data": [
    {
      "jobName": "数据分析服务A",
      "jobDate": "20190801",
      "finishTime": 1564621200000,
      "status": "success",
      "resultModelId": "userPassStat",
      "resultCount": 2
    }
  ]
}

results matching ""

    No results matching ""