睿智云平台导出导出统一API

注:所有的导入模板的标准请参考:

https://confluence.mideazy.com/pages/resumedraft.action?draftId=241303556&draftShareId=ce4adcfd-9d48-4750-b33e-cfb94defb754

脱离以上格式的Excel模板平台将不支持。

工单交互原型 :

https://lanhuapp.com/web/#/item/project/stage?pid=b6805f00-c82c-416d-b239-2a7f1263e5d3&tid=d8e600c0-9df5-4f27-8f41-939c1674f43e&see=all

主数据批量更新和查询API列表

1 业务层接口

描述: 业务接口是暴露给前端(如:H5、小程序 )调用的接口。所有的Excel导入导出操作都将使用同一个接口。根据

参数module 来具体调用是哪种业务类型的导入、导出。参数变量固定为: module, file , org_id和其他参数。

1.1 API列表

批量导入API列表 URL Method 说明
1.1. 批量导入 /v1/stream/import?module=业务类型变量 POST
1.2. 批量导出 /v1/stream/export?module=业务类型变量 POST

参数变量:

(1) module

module 业务变量字典

module取值 代表业务 说明
ORG 业务或行政 业务或行政导入、导出的变量
ADMIN 员工
DEVICE 设备设施
DEVICE_TASK 台帐任务
QUALITY_CATEGORY 品质分类
QUALITY_CEHCKINDEX 品检指标
COMMUNITY 项目
CUSTOMER 客户
SPACE 空间

(2) file

字段 字段类型 是否必填 说明
file multipart/form-data 字段 上传的excel 文件 , mideaType: multipart/form-data

(3) org_id

字段 字段类型 是否必填 说明
org_id Long 全局切换业务组织ID; 由平台自动识别顶级行政和顶级业务组织ID, 顶级行政和顶级业务组织ID将作务本次批量导入的业务或行政组织集合所作用对象的主键ID(顶级业务或行政组织主键ID)。

以上为各业务的公共参数,除有特殊说明,均保持以上三个参数。

业务层统一返回 :

{"code":"200","message":"success","key": "存储用户上传Excelkey"}

2 平台层接口

POST 接口

批量导入API列表 URL 说明
2.1. 批量导入 /v1/iot/main/batch/import?module=%module%
2.2. 批量导出 /v1/iot/main/batch/export?module=%module%

module 业务变量字典

module取值 代表业务 说明
ORG 业务或行政 业务或行政导入、导出的变量
ADMIN 员工
DEVICE 设备设施
DEVICE_TASK 台帐任务
QUALITY_CATEGORY 品质分类
QUALITY_CEHCKINDEX 品检指标
COMMUNITY 项目
CUSTOMER 客户
SPACE 空间

2.1 批量导入

说明: 所有业务数据的导入导出均使用同一个接口

描述 : 批量请求每次最多50条

请求信息

URL:/v1/iot/main/batch/import?module=%module%

METHOD: POST

参数:

body: JSON格式约定

2.1.1 业务组织、行政组织

字段 字段类型 是否必填 说明
list JSONArray 业务或行政组织集合, JSON Array 其中的对象,请见Org对象属性
org_id Long 全局切换业务组织ID; 由平台自动识别顶级行政和顶级业务组织ID, 顶级行政和顶级业务组织ID将作务本次批量导入的业务或行政组织集合所作用对象的主键ID(顶级业务或行政组织主键ID)。

Org 对象属性:

字段 字段类型 是否必填 说明
org_type int 业务组织类型,1: 行政组织,2:业务组织
org_name String 组织名称。 同一级业务或行政组织org_name为唯一 。
parent_org_name String 父组织名称
sub_type int 组织分类:A:行政组织可分为: 1: 内部行政组织工, 2: 内部临时组织, 3:应用帐号组织,4:职能帐号组织, 5: 外部帐号组织,6: 公共通讯录组织, B:业务组织可分为: 1: 项目类型, 2:非项目类型

请求示例:

{"org_id": 1109,  "list":[{"org_type":1, "org_name":XX, "parent_org_name":XX, "sub_type":1}, ....]  }

返回示例:

 {"code":"200","message":"success","erroList":[{"org_name":"美的一级部门","sub_type_ch":"内部行政组织","parent_org_name":"美的置业顶级业务组织","org_type_ch":null,"org_type":0, "exception":"XX"},{"org_name":"美的二级部门","sub_type_ch":"内部行政组织","parent_org_name":"美的一级部门","org_type_ch":null,"org_type":0, , "exception":"XX"},{"org_name":"美的三级部门","sub_type_ch":"内部行政组织","parent_org_name":"美的二级部门","org_type_ch":null,"org_type":0},{"org_name":"美的四级部门","sub_type_ch":"内部行政组织","parent_org_name":"美的三级部门","org_type_ch":null,"org_type":0, , "exception":"XX"}]}

所有的失败的记录都会以 errorList 集合返回 。errorList中的对象为行政或业务组织对象, 见Org对象属性:

Org 对象属性:

字段 字段类型 是否必返 说明
org_type Int 业务组织类型,1: 行政组织,2:业务组织
org_name String 组织名称。 同一级业务或行政组织org_name为唯一
parent_org_name Long 父组织名称
sub_type String 组织分类:A:行政组织可分为: 1: 内部行政组织工, 2: 内部临时组织, 3:应用帐号组织,4:职能帐号组织, 5: 外部帐号组织,6: 公共通讯录组织, B:业务组织可分为: 1: 项目类型, 2:非项目类型
exception String 异常原因

2.1.2 品质检查标准

字段 字段类型 是否必填 说明
list JSONArray 业务或行政组织集合, JSON Array 其中的对象,请见Org对象属性
org_id Long 全局切换业务组织ID; 由平台自动识别顶级行政和顶级业务组织ID, 顶级行政和顶级业务组织ID将作务本次批量导入的业务或行政组织集合所作用对象的主键ID(顶级业务或行政组织主键ID)。

Org 对象属性:

字段 字段类型 是否必填 说明
first_node_name String 一级
second_node_name String 二级
third_node_name String 三级
fourth_node_name String 四级
check_standard String 检查标准
check_method String 检查方法
total_score String 分值
score_standard String 评分标准

请求示例:

{"org_id": 1109,  "list":[{}]  }

返回示例:

 {"code":"200","message":"success","erroList":[]}

所有的失败的记录都会以 errorList 集合返回 。errorList中的对象为行政或业务组织对象, 见Org对象属性:

Org 对象属性:

字段 字段类型 是否必返 说明
first_node_name String 一级
second_node_name String 二级
third_node_name String 三级
fourth_node_name String 四级
check_standard String 检查标准
check_method String 检查方法
total_score String 分值
score_standard String 评分标准
exception String 异常原因

2.1.3 专业目录

字段 字段类型 是否必填 说明
list JSONArray 专业目录集合, JSON Array 其中的对象,请见Org对象属性
org_id Long 全局切换业务组织ID; 由平台自动识别顶级行政和顶级业务组织ID, 顶级行政和顶级业务组织ID将作务本次批量导入的业务或行政组织集合所作用对象的主键ID(顶级业务或行政组织主键ID)。

Org 对象属性:

字段 字段类型 是否必填 说明
first_node_name String 一级
second_node_name String 二级
third_node_name String 三级
fourth_node_name String 四级

请求示例:

{"org_id": 1109,  "list":[{}]  }

返回示例:

 {"code":"200","message":"success","erroList":[]}

所有的失败的记录都会以 errorList 集合返回 。errorList中的对象为行政或业务组织对象, 见Org对象属性:

Org 对象属性:

字段 字段类型 是否必返 说明
first_node_name String 一级
second_node_name String 二级
third_node_name String 三级
fourth_node_name String 四级
exception String 异常原因

2.1.4 员工

字段 字段类型 是否必填 说明
list JSONArray 业务或行政组织集合, JSON Array 其中的对象,请见Org对象属性
org_id Long 全局切换业务组织ID; 由平台自动识别顶级行政和顶级业务组织ID, 顶级行政和顶级业务组织ID将作务本次批量导入的业务或行政组织集合所作用对象的主键ID(顶级业务或行政组织主键ID)。

Org 对象属性:

字段 字段类型 是否必填 说明
org_id String 行政组织
name String 姓名
user_id String 账号
job_number/staff_no String 工号
position String 职位
mobile String 手机号
identity String 身份证号
email String 邮箱
position_level String 组织职级

请求示例:

{"org_id": 1109,  "list":[{}]  }

返回示例:

 {"code":"200","message":"success","erroList":[]}

所有的失败的记录都会以 errorList 集合返回 。errorList中的对象为行政或业务组织对象, 见Org对象属性:

Org 对象属性:

字段 字段类型 是否必返 说明
org_id String 行政组织
name String 姓名
user_id String 账号
job_number/staff_no String 工号
position String 职位
mobile String 手机号
identity String 身份证号
email String 邮箱
position_level String 组织职级

results matching ""

    No results matching ""