创建组织(批量)
一、接口URL
/umsopenapi/official/batch/organization/create
二、功能
创建组织(批量)(*注: 每次最多1000条)
三、请求参数
http header 请求参数
名称 | 类型 | 是否必传 | 传参方式 | 说明 |
---|---|---|---|---|
token | String | true | http header | 调用全时API的身份验证token |
http body 请求参数
名称 | 类型 | 是否必传 | 传参方式 | 说明 |
---|---|---|---|---|
parentId | Long | true | RequestBody | 父组织id |
callback | String | false | RequestBody | 回调地址,任务执行完成后回调,如果30分钟没收到回调,可以重复调用一次 |
data | Array | true | RequestBody | 组织数据 |
data结构
名称 | 类型 | 是否必传 | 传参方式 | 说明 |
---|---|---|---|---|
name | String | true | RequestBody | 组织名称,必填。 |
order | int | false | RequestBody | 排序值; 值大的在下,值小的在上,非必填。 |
customerOrgId | String | false | RequestBody | 客户组织id,非必填。 |
四、请求体
{
"parentId": 35234231,
"data":[
{
"name": "测试组织",
"order": 6
},
{
"name": "测试组织2",
"order": 1
}
],
"callback": "http://www.quanshi.com/api/callback",
}
五、返回参数
名称 | 类型 | 说明 |
---|---|---|
code | Integer | 结果码,0: 成功, 非0:失败 (具体描述见错误码表) |
data | json | 返回数据,部门id |
message | String | 错误描述 |
requestId | String | 请求唯一ID。查询接口日志时需要,建议打印日志 |
data参数说明
名称 | 类型 | 说明 |
---|---|---|
batchId | String | 本次请求的批次号, 后续使用此参数查询批量创建结果 |
六、返回体
{
"code": 0,
"data":{
"batchId":"9c5e5441cdf6b0955493ca479d50d72e"
},
"message": "success",
"requestId": "openapi-ums-165-17e9061a-adc5-4392-b160-0305fb65a0f5"
}
回调callback结构
名称 | 类型 | 说明 |
---|---|---|
batchId | String | 本次请求的批次号, 后续使用此参数查询批量创建结果 |
status | int | //执行状态 1:已结束-全部成功,2:已结束-部分成功 |
type | String | //回调类型 organization,user |
{
"batchId":"9c5e5441cdf6b0955493ca479d50d72e",
"status":2,
"type":"organization"
}