7. 主数据API
API列表
| 编号 | API名称 | 路径 | 版本 |
|---|---|---|---|
| 7.1 | 触发同步接口 | /open/sync/trigger | 1.0 |
| 7.2 | 数据写入（目标）接口 | /inner/sync/dest/command | 1.0 |
| 7.3 | 数据读取（源）接口 | /inner/sync/source/query | 1.0 |
| 7.4 | 同步组织机构接口 | /open/sync/organTree/trigger | 1.0 |
| 7.5 | 同步用户接口 | /open/sync/menber/trigger | 1.0 |
| 7.6 | 同步用户房屋接口 | /open/sync/organTree/trigger | 1.0 |
API调用
7.1: 主数据同步接口
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/open/sync/trigger
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| dataArea | BODY | INTEGER | 是 | 数据分类编码 |
| beginModifyTimestamp | BODY | STRING | 否 | 需要查询的数据的时间戳范围，格式为：yyyy-MM-dd HH:mm:ss |
| endModifyTimestamp | BODY | STRING | 否 | 需要查询的数据的时间戳范围，格式为：yyyy-MM-dd HH:mm:ss |
| communityId | BODy | STRING | 否 | 项目ID |
| isFull | BODY | INTEGER | 是 | 是否全量同步,0增量，1全量 |
请求Body描述(非Form表单数据)
{
"dataArea": 1,
"beginModifyTimestamp": "",
"endModifyTimestamp": "",
"isFull": 1,
"communityId": ""
}
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识 |
| message | 顶层 | STRING | 是 | 响应消息文本 |
| data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
7.2: 数据写入（目标）接口
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/inner/sync/dest/command
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| event | BODY | STRING | 是 | 同步类型：update/add/delete |
| dataArea | BODY | INTEGER | 是 | 数据分类编码 |
| entity | BODY | JSONObject | 是 | 同步数据 |
| entitys | BODY | JSONArray | 是 | 同步数组 |
| className | BODY | STRING | 是 | 同步数据对应实体类名 |
| syncType | BODY | STRING | 是 | 同步类型 |
请求Body描述(非Form表单数据)
{
"event":"",
"dataArea":"",
"entity":"",
"entitys":"",
"className":"",
"syncType":"",
}
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识 |
| message | 顶层 | STRING | 是 | 响应消息文本 |
| data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
7.3: 数据读取（源）接口
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/inner/sync/source/query
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| dataArea | BODY | INTEGER | 是 | 数据分类编码 |
| isFull | BODY | INTEGER | 是 | 是否全量 |
请求Body描述(非Form表单数据)
{
"":"",
}
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识 |
| message | 顶层 | STRING | 是 | 响应消息文本 |
| data | 顶层 | JSONObject | 是 | 响应数据对象 |
| event | data | STRING | 否 | 同步类型：update/add/delete |
| dataArea | data | INTEGER | 否 | 数据分类编码 |
| entitys | data | JSONArray | 否 | 同步数组 |
| className | data | STRING | 否 | 同步数据对应实体类名 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
7.4: 同步组织机构接口
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/open/sync/organTree/trigger
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| organId | BODY | INTEGER | 是 | 同步顶层组织ID |
| cascade | BODY | STRING | 否 | 级联同步 |
| env | BODY | STRING | 否 | 环境选择 |
请求Body描述(非Form表单数据)
{
"organId": "1",
"cascade": true,
"env": "sit"
}
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识 |
| message | 顶层 | STRING | 是 | 响应消息文本 |
| data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
异常返回示例
{"code":"1401","message":""}