模块说明
2.0.0版本同步数据包API
一、查询组织关系定义数据
请求方式: POST(HTTPS或HTTP)
请求地址: https://{server}/center/api/app/data/conversion/public/relation/id/find/by/organization
请求头信息:
Content-Type: application/json; charset=utf-8
Authorization: Bearer xxxx
请求参数:
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
dataCode | String | 是 | 数据包code |
请求实例:
{
"dataCode": "数据包code"
}
响应参数:
参数 | 类型 | 说明 |
---|---|---|
relationshipTypeName | String | 关系定义类型名称 |
relationshipTypeItem | List | 关系定义 |
-relationShipId | String | 子关系定义id |
-relationShipName | String | 子关系定义名称 |
-relationShipCode | String | 子关系定义Code |
响应实例:
{
"code": 200,
"message": "OK",
"data": [
{
"relationshipTypeName": "部门-岗位",
"relationshipTypeItem": [
{
"relationshipName": "归属部门",
"relationshipId": "200000000000000000000011",
"relationshipCode": "1010"
},
{
"relationshipName": "下设岗位",
"relationshipId": "200000000000000000000012",
"relationshipCode": "1011"
}
]
}
]
}
二、查询SID授权的组织数据(Data-code)
功能介绍:
- 应用查询可以使用的数据包
请求方式: POST(HTTPS或HTTP)
请求地址: https://{selfServer}/center/api/app/data/conversion/public/all/find/appId
请求头信息:
Content-Type: application/json; charset=utf-8
Authorization: Bearer xxxx
请求参数:
无
响应参数:
参数 | 类型 | 说明 |
---|---|---|
id | String | 数据包id |
name | String | 数据包名称 |
dataCode | String | 数据包code |
organizationName | String | 组织名称 |
description | String | 数据包描述 |
state | String | 推送状态 |
lastPushTime | String | 最后一次推送时间 |
pushDb | Boolean | 是否推送数据库 |
响应实例:
{
"code": 200,
"message": "OK",
"data": [
{
"id": "xxx",
"name": "xxx",
"dataCode": "xxx",
"organizationName": "xxx",
"description": "xxx",
"state": "xxx",
"lastPushTime": null,
"pushDb": false
}
]
}
三、查询组织下的部门数据详情
功能介绍:
- 应用通过数据包code查询组织下的部门
请求方式: POST(HTTPS或HTTP)
请求地址: https://{selfServer}/center/api/app/data/conversion/public/findOrganization
请求头信息:
Content-Type: application/json; charset=utf-8
Authorization: Bearer xxxx
请求参数:
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
dataCode | String | 是 | 数据包code |
timestamp | long | 否 | 同步时间戳 |
NAME | String | 否 | 查询条件,组织部门名称 |
CODE | String | 否 | 查询条件,组织部门编码 |
paramOrRelation | List | 否 | 需要的查询条件,若这里没有值,则相应的查询条件不会失效 |
请求实例:
{
"currentPage": 1,
"pageSize": 10,
"paramOrRelation": ["CODE", "NAME"],
"reqParam": {
"timestamp": 0,
"dataCode": "数据包code",
"NAME":"",
"CODE":""
}
}
响应参数:
参数 | 类型 | 说明 |
---|---|---|
x1 | Object | 部门属性1 |
x2 | Object | 部门属性2 |
x3 | Object | 部门属性3 |
isDelete | Boolean | 是否删除 |
organizationRootId | String | 根组织id |
响应实例:
{
"code": 200,
"message": "OK",
"data": {
"metaData": {
"x1": "名称",
"x2": "类型",
"x3": "编码"
},
"currentPage": 1,
"pageSize": 10,
"totalAmount": 1,
"totalPages": 1,
"dataCode": "",
"organizationRootId": "",
"data": [
{
"x1": "xxx",
"x2": "xxx",
"x3": "xxx",
"isDelete": false
},
{
"x1": "xxx",
"x2": "xxx",
"x3": "xxx",
"isDelete": false
}
]
}
}
四、查询组织下的岗位信息详情
请求方式: POST(HTTPS或HTTP)
请求地址: https://{server}/center/api/app/data/conversion/public/findPost
请求头信息:
Content-Type: application/json; charset=utf-8
Authorization: Bearer xxxx
请求参数:
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
timestamp | long | 否 | 同步时间戳 |
dataCode | String | 是 | 数据包code |
NAME | String | 否 | 查询条件,岗位名称 |
CODE | String | 否 | 查询条件,岗位编码 |
paramOrRelation | List | 否 | 需要的查询条件,若这里没有值,则相应的查询条件不会失效 |
请求示例:
{
"currentPage": 1,
"pageSize": 10,
"paramOrRelation": ["CODE", "NAME"],
"reqParam": {
"timestamp": 0,
"dataCode": "数据包code",
"NAME":"",
"CODE":""
}
}
返回参数:
参数 | 类型 | 说明 |
---|---|---|
x1 | Object | 岗位属性1 |
x2 | Object | 岗位属性2 |
x3 | Object | 岗位属性3 |
isDelete | Boolean | 是否删除 |
organizationRootId | String | 根组织id |
返回示例:
{
"code": 200,
"message": "OK",
"data": {
"metaData": {
"x1": "名称",
"x2": "类型",
"x3": "编码"
},
"currentPage": 1,
"pageSize": 10,
"totalAmount": 1,
"totalPages": 1,
"dataCode": "",
"organizationRootId": "",
"data": [
{
"x1": "xxx",
"x2": "xxx",
"x3": "xxx",
"isDelete": false
},
{
"x1": "xxx",
"x2": "xxx",
"x3": "xxx",
"isDelete": false
}
]
}
}
五、查询组织下的身份数据
请求方式: POST(HTTPS或HTTP)
请求地址: https://{server}/center/api/app/data/conversion/public/findUser
请求头信息:
Content-Type: application/json; charset=utf-8
Authorization: Bearer xxxx
请求参数:
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
timestamp | long | 否 | 同步时间戳 |
dataCode | String | 是 | 数据包code |
NAME | String | 否 | 查询条件,用户名 |
XGH | String | 否 | 查询条件,账号 |
paramOrRelation | List | 否 | 需要的查询条件,若这里没有值,则相应的查询条件不会失效 |
请求实例:
{
"currentPage": 1,
"pageSize": 10,
"paramOrRelation": ["XGH", "NAME"],
"reqParam": {
"timestamp": 0,
"dataCode": "数据包code",
"NAME":"",
"XGH":""
}
}
响应参数:
参数 | 类型 | 说明 |
---|---|---|
x1 | Object | 身份属性1 |
x2 | Object | 身份属性2 |
x3 | Object | 身份属性3 |
isDelete | Boolean | 是否删除 |
organizationRootId | String | 根组织id |
响应实例:
{
"code": 200,
"message": "OK",
"data": {
"metaData": {
"x1": "名称",
"x2": "类型",
"x3": "编码"
},
"currentPage": 1,
"pageSize": 10,
"totalAmount": 1,
"totalPages": 1,
"dataCode": "",
"organizationRootId": "",
"data": [
{
"x1": "xxx",
"x2": "xxx",
"x3": "xxx",
"isDelete": false
},
{
"x1": "xxx",
"x2": "xxx",
"x3": "xxx",
"isDelete": false
}
]
}
}
六、查询部门与岗位关系
请求方式: POST(HTTPS或HTTP)
请求地址: https://{server}/center/api/app/data/conversion/public/findRelation
请求头信息:
Content-Type: application/json; charset=utf-8
Authorization: Bearer xxxx
请求参数:
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
code | String | 是 | 子关系定义code |
dataCode | String | 是 | 数据包code |
timestamp | long | 否 | 同步时间戳 |
请求实例:
{
"currentPage":1,
"pageSize":20,
"reqParam":{
"dataCode":"",
"timestamp": 0,
"code":""
}
}
响应参数:
参数 | 类型 | 说明 |
---|---|---|
xx1 | String | 关系字段1 |
xx2 | String | 关系字段2 |
xx3 | String | 关系映射字段 |
isDelete | Boolean | 是否删除 |
organizationRootId | String | 根组织id |
响应实例:
{
"code": 200,
"message": "OK",
"data": {
"metaData": {
"xx1": "",
"xx2": "",
"xx3": "关系定义名称"
},
"currentPage": 1,
"pageSize": 10,
"organizationRootId": "",
"data": [
{
"xx1": "T001",
"xx2": "T002",
"000000000003": {
"source": "T001",
"taget": "T002",
"xx3": "xxxx"
},
"isDelete": false
}
]
}
}
七、查询当前部门及下级部门
请求方式: POST(HTTPS或HTTP)
请求地址: https://{server}/center/api/app/data/conversion/public/getDepartment/get
请求头信息:
Content-Type: application/json; charset=utf-8
Authorization: Bearer xxxx
请求参数:
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
dataCode | String | 是 | 数据包code |
code | String | 是 | 组织部门code |
请求实例:
{
"dataCode":"",
"code" :""
}
响应参数:
参数 | 类型 | 说明 |
---|---|---|
id | String | 组织部门id |
isLeaf | String | 是否叶子 |
organizationIndex | String | 序号 |
parent | String | 父亲id |
xxx1 | String | 属性 |
xxx2 | String | 属性 |
xxx3 | String | 属性 |
dept | Object | 下级部门 |
响应实例:
{
"code": 200,
"message": "OK",
"data": {
"JJ": null,
"SLLX": "02",
"SJBM": "xxx",
"BMLX": "11000",
"FZRH": "200000000000000000000016",
"dept": [
{
"CODE": "xxx",
"SJBM": "200000000000000000000005",
"BMLX": "xxx",
"organizationIndex": 14023,
"BMZT": "01",
"id": "xxx",
"isLeaf": false,
"parentId": "xxx",
"NAME": "xxx"
}
],
"isLeaf": true,
"parentId": "xxx",
"NAME": "xxx",
"CODE": "xxx",
"JC": null,
"organizationIndex": 14022,
"BMZT": "01",
"id": "xxx"
}
}
八、组织或部门详情
请求方式: POST(HTTPS或HTTP)
请求地址: https://{server}/center/api/app/data/conversion/public/getOrganizationDetail
请求头信息:
Content-Type: application/json; charset=utf-8
Authorization: Bearer xxxx
请求参数:
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
dataCode | String | 是 | 数据包code |
code | String | 是 | 组织部门code |
请求实例:
{
"dataCode":"",
"code":""
}
响应参数:
参数 | 类型 | 说明 |
---|---|---|
id | String | 组织部门id |
index | String | 序号 |
parent | String | 父亲id |
xxx1 | String | 属性 |
xxx2 | String | 属性 |
响应实例:
{
"code": 200,
"message": "OK",
"data": {
"JJ": null,
"CODE": "xxx",
"SLLX": "02",
"SJBM": "200000000000000000000005",
"BMLX": "xxx",
"JC": null,
"organizationIndex": 14022,
"BMZT": "01",
"id": "xxx",
"FZRH": "200000000000000000000016",
"parentId": "xxx",
"NAME": "xxx"
}
}
九、岗位详情查询
请求方式: POST(HTTPS或HTTP)
请求地址: https://{server}/center/api/app/data/conversion/public/getPostDetail
请求头信息:
Content-Type: application/json; charset=utf-8
Authorization: Bearer xxxx
请求参数:
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
dataCode | String | 是 | 数据包code |
code | String | 是 | 岗位code |
请求实例:
{
"dataCode":"",
"code":""
}
响应参数:
参数 | 类型 | 说明 |
---|---|---|
id | String | 岗位id |
xxx1 | String | 属性 |
xxx2 | String | 属性 |
响应实例:
{
"code": 200,
"message": "OK",
"data": {
"SJGW": "200000000000000000000017",
"CODE": "xxx",
"GWSFZS": "xxx",
"SSZZ": "xxx",
"id": "xxx",
"GWLX": "xxx",
"NAME": "xxx"
}
}
十、身份详情查询
请求方式: POST(HTTPS或HTTP)
请求地址: https://{server}/center/api/app/data/conversion/public/getUserDetail
请求头信息:
Content-Type: application/json; charset=utf-8
Authorization: Bearer xxxx
请求参数:
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
dataCode | String | 是 | 数据包code |
code | String | 是 | 账号 |
请求实例:
{
"dataCode":"",
"code":""
}
响应参数:
参数 | 类型 | 说明 |
---|---|---|
id | String | 身份id |
personId | String | 人id |
xxx1 | String | 属性 |
xxx2 | String | 属性 |
响应实例:
{
"code": 200,
"message": "OK",
"data": {
"SFZJLXM": "A",
"GH": "xxx",
"SFLBDM": "01",
"IDCARD": "xxx",
"XM": "xxx",
"isDelete": false,
"personId": "xxx",
"JXRYZT": "01",
"id": "xxx"
}
}
十一、关系详情查询
请求方式: POST(HTTPS或HTTP)
请求地址: https://{server}/center/api/app/data/conversion/public/getRelationDetail
请求头信息:
Content-Type: application/json; charset=utf-8
Authorization: Bearer xxxx
请求参数:
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
dataCode | String | 是 | 数据包code |
code | String | 是 | 子关系定义code |
obj1 | String | 否 | 关系对象id或者编码,如岗位-身份关系对应部门的id或编码(具体取值对象参照关系对象映射表) |
obj2 | String | 否 | 关系对象id或者编码,如岗位-身份关系对应岗位的id或编码(具体取值对象参照关系对象映射表) |
obj3 | String | 否 | 关系对象id或者编码,如岗位-身份关系中对应用户的id、账号或组织终身id(具体取值对象参照关系对象映射表) |
obj4 | String | 否 | 关系对象id或者编码,如岗位-岗位关系中对应岗位的id或编码(具体取值对象参照关系对象映射表) |
extend | boolean | 否 | 是否展示其他字段,如编码、账号,true为显示,默认为false |
timestamp | Long | 否 | 同步时间戳 |
请求实例:
{
"dataCode":"",
"code":"",
"obj1":"",
"obj2":"",
"obj3":"",
"extend": true,
"timestamp": 0
}
响应参数:
参数 | 类型 | 说明 |
---|---|---|
id | String | 关系id |
obj1 | String | 关系对象id |
obj1Code | String | 若obj1为部门,则该字段为obj1DeptCode,对应部门编码 |
obj2 | String | 关系对象id |
obj2Code | String | 若obj2为岗位,则该字段为obj2PostCode,对应岗位编码 |
obj3 | String | 关系对象id |
obj3Code | String | 若obj3为用户,则该字段为obj3UserId,对应用户账号 |
obj4 | String | 关系对象id |
obj4Code | String | 若obj4为岗位,则该字段为obj1PostCode,对应岗位编码 |
source | String | source和target表示关系方向,source为源,target表示目标 |
target | String | source和target表示关系方向,source为源,target表示目标 |
响应实例:
{
"code": 200,
"message": "OK",
"data": [
{
"obj1DeptCode": "70700",
"updatedTime": 1685338728372,
"obj2PostCode": "10030320231001",
"isDelete": false,
"200000000000000000000019": "642949c42933820001ce1973",
"obj3UserId": "20180206",
"obj2": "642949c42933820001ce1973",
"obj1": "70700",
"source": "5ea7c2e08f2d6e0001e79588",
"id": "642949e52933820001ce1977",
"target": "642949c42933820001ce1973",
"obj3": "5ea7c2e08f2d6e0001e79588"
}
]
}
十二、获取二级部门或上级部门
请求方式: POST(HTTPS或HTTP)
请求地址: https://{server}/center/api/app/data/conversion/public/getParentOrSecondCode
请求头信息:
Content-Type: application/json; charset=utf-8
Authorization: Bearer xxxx
请求参数:
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
dataCode | String | 是 | 数据包code |
sszz | List | 是 | 需要查询上级部门或二级部门的部门code |
parentSszz | List | 否 | 上级部门code,checkSecond为false时从该字段查询sszz的上级部门code |
checkSecond | boolean | 否 | 是否获取二级部门,默认false,为true返回sszz中部门的二级部门,false返回sszz在parentSszz中的上级部门 |
请求实例:
{
"dataCode":"",
"sszz":["", ""],
"parentSszz":["", ""],
"checkSecond":false
}
响应参数:
参数 | 类型 | 说明 |
---|---|---|
x | String | sszz中的code |
y | String | 上级部门或二级部门code |
响应实例:
{
"code": 200,
"message": "OK",
"data": {
"x1": "y1",
"x2": "y2",
"x3": "y3"
}
}
十三、查询岗位身份关系以及二级部门
请求方式: POST(HTTPS或HTTP)
请求地址: https://{server}/center/api/app/data/conversion/public/getPostAndIdentityDetail
请求头信息:
Content-Type: application/json; charset=utf-8
Authorization: Bearer xxxx
请求参数:
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
code | String | 是 | 岗位身份子关系code |
dataCode | String | 是 | 数据包code |
userId | String | 否 | 用户id/账号 |
timestamp | Long | 否 | 同步时间戳 |
请求实例:
{
"currentPage": 1,
"pageSize": 20,
"reqParam": {
"dataCode": "",
"code": "",
"userId": "",
"timestamp": 0
}
}
响应参数:
参数 | 类型 | 说明 |
---|---|---|
metaData | Object | 关系属性说明 |
id | String | 关系id |
deptId | String | 部门id |
deptCode | String | 部门编码 |
deptName | String | 部门名称 |
secondDeptId | String | 二级部门部门id |
secondDeptCode | String | 二级部门部门编码 |
secondDeptName | String | 二级部门部门名称 |
postId | String | 岗位id |
postCode | String | 岗位编码 |
postName | String | 岗位名称 |
userId | String | 用户id |
GH | String | 用户账号 |
userName | String | 用户姓名 |
updatedTime | Long | 关系更新时间 |
xxx | String | 关系属性 |
响应实例:
{
"code": 200,
"message": "OK",
"data": {
"currentPage": 1,
"pageSize": 10,
"totalAmount": 1,
"totalPages": 1,
"dataCode": "",
"organizationRootId": "",
"metaData": {
"ZJQK": "在籍情况",
"RZLX": "任职类型",
"GZGX": "工作关系",
"SFZG": "是否主岗位",
"RZSJ": "任职时间",
"RZJZSJ": "任职截至时间",
"ZBQK": "在编情况"
},
"data": [
{
"id": "",
"deptId": "",
"deptCode": "",
"deptName": "",
"secondDeptId": "",
"secondDeptCode": "",
"secondDeptName": "",
"postId": "",
"postCode": "",
"postName": "",
"userId": "",
"GH": "",
"userName": "",
"updatedTime": "",
"xxx": ""
}
]
}
}
关系对象映射表
关系 | obj1 | obj2 | obj3 | obj4 |
---|---|---|---|---|
组织-身份 | 组织 | 用户 | ||
组织-部门 | 组织 | 部门 | ||
部门-部门 | 部门 | 部门 | ||
部门-岗位 | 部门 | 岗位 | ||
部门-身份 | 部门 | 用户 | ||
岗位-岗位 | 部门 | 岗位 | 部门 | 岗位 |
岗位-身份 | 部门 | 岗位 | 用户 | |
身份-身份 | 用户 | 用户 | ||
人-人 | 用户 | 用户 |
接口调用失败请查看开发指南-Token与Api调用失败须知