title: myApps.5.0trunk v1.0.0
language_tabs:

  • shell: Shell
  • http: HTTP
  • javascript: JavaScript
  • ruby: Ruby
  • python: Python
  • php: PHP
  • java: Java
  • go: Go
    toc_footers: []
    includes: []
    search: true
    code_clipboard: true
    highlight_theme: darkula
    headingLevel: 2
    generator: “@tarslib/widdershins v4.0.17”

myApps.5.0trunk

v1.0.0

Base URLs:

myApps用户中心/日历

POST 创建日历

POST /calendar/create

Body 请求参数

{
  "po": "",
  "id": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
body body object 否 none
» po body string 是 none
» id body string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

PUT 更新日历

PUT /calendar/update

Body 请求参数

{
  "po": "",
  "id": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
body body object 否 none
» po body string 是 none
» id body string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据ID查找日历

GET /calendar/find/{id}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
id path string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

DELETE 根据ID删除日历

DELETE /calendar/remove/{id}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
id path string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据日历的名称获取日历对象

GET /calendar/doViewByName/{domainId}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
domainId path string 是 none
name query string 否 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

PUT 保存日历

PUT /calendar/saveCalendar

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
id query string 否 none
name query string 否 none
remark query string 否 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据名字查询日历

GET /calendar/queryByNameAndDomain/{domainId}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
domainId path string 是 none
name query string 否 none
page query string 否 none
lines query string 否 none

返回示例

200 Response

"string"

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 string

myApps用户中心/部门

POST 创建部门

POST /department/create

Body 请求参数

{
  "departmentPo": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
body body object 否 none
» departmentPo body string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

PUT 更新部门

PUT /department/update

Body 请求参数

{
  "DepartmentPO": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
body body object 否 none
» DepartmentPO body string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 通过id查找部门

GET /department/find/{id}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
id path string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

DELETE 通过id删除部门

DELETE /department/remove/{id}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
id path string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据上级部门id查找部门

GET /department/getDatasByParent/{parentId}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
parentId path string 是 none

返回示例

200 Response

"string"

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 string

GET 根据部门等级和企业域查找部门

GET /department/getDepartmentByName/{domainId}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
domainId path string 是 none
name query string 否 none

返回示例

200 Response

"string"

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 string

GET 根据企业域查找根部门

GET /department/getRootDepartmentByDomainId/{domainId}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
domainId path string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据企业域父级部门id查找部门

GET /department/queryByDomainAndParent/{domainId}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
domainId path string 是 none
parent query string 否 none

返回示例

200 Response

"string"

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 string

GET 根据父级部门id获取子级部门数量

GET /department/getChildrenCount

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
parent query string 否 none

返回示例

200 Response

"string"

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 string

GET 根据父级部门id获取子级部门数量

GET /department/queryByDomain/{domainId}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
domainId path string 是 none
page query string 否 none
lines query string 否 none

返回示例

200 Response

"string"

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 string

GET 根据部门名字和层级获得部门对象

GET /department/getDepartmentByNameAndLevel/{domainId}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
domainId path string 是 none
name query string 否 none
level query string 否 none

返回示例

200 Response

"string"

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 string

GET 根据企业域和上级部门和名称查询部门集合

GET /department/queryByDoaminAndSuperiorAndName/{domainId}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
domainId path string 是 none
superiorId query string 否 none
name query string 否 none
order query string 否 none
page query integer 否 none
lines query string 否 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据用户查询部门集合

GET /department/queryByUser

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
userId query string 否 none

返回示例

200 Response

"string"

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 string

GET 根据蓝信查询部门集合

GET /department/queryByDomainAndLanxinDept/{domainId}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
domainId path string 是 none
lanxinDeptId query string 否 none

返回示例

200 Response

"string"

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 string

GET 根据微信查询部门集合

GET /department/queryByDomainAndWeixinDept/{domainId}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
domainId path string 是 none
weinxinDeptId query string 否 none

返回示例

200 Response

"string"

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 string

GET 根据钉钉查询部门集合

GET /department/queryByDomainAndDingdingDept/{domainId}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
domainId path string 是 none
dingdingDeptId query string 否 none

返回示例

200 Response

"string"

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 string

GET 根据企业域和名称模糊查询部门集合

GET /department/queryByDomainLikeName/{domainId}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
domainId path string 是 none
name query string 否 none

返回示例

200 Response

"string"

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 string

GET 根据企业域和是否有效查询部门集合

GET /department/queryByDomainAndValid/{domainId}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
domainId path string 是 none
valid query string 否 none

返回示例

200 Response

"string"

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 string

myApps用户中心/企业域

POST 创建企业域

POST /domain/create

Body 请求参数

{
  "DomainPO": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
body body object 否 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

PUT 更新企业域

PUT /domain/update

Body 请求参数

{
  "DomainPO": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
body body object 否 none
» DomainPO body string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据ID查找企业域

GET /domain/find/{id}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
id path string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

DELETE 根据ID删除企业域

DELETE /domain/remove/{id}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
id path string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据企业域名称查询

GET /domain/getDomainByName

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
name query string 否 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据父级id查询下级企业域

GET /domain/queryDomainsByParentId

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
parentId query string 否 none

返回示例

200 Response

"string"

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 string

GET 获取所有企业域

GET /domain/getAllDomain

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none

返回示例

200 Response

"string"

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 string

GET 根据企业域状态获取

GET /domain/getDomainByStatus

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
status query string 否 none

返回示例

200 Response

"string"

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 string

GET 根据企业域状态查询

GET /domain/queryDomainsByStatus

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
status query string 否 none

返回示例

200 Response

"string"

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 string

GET 根据域管理员的名称以及企业域名模糊查询

GET /domain/queryDomainVOByUsernameAndDomainName

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
userName query string 否 none
domainName query string 否 none
page query string 否 none
lines query string 否 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据企业域名称查询

GET /domain/simpleQuery

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
name query string 否 none
page query string 否 none
lines query string 否 none

返回示例

200 Response

"string"

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 string

GET 根据密钥获取域

GET /domain/getDomainBySecret

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
secret query string 否 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

myApps用户中心/字段

POST 创建字段

POST /fieldextends/create

Body 请求参数

{
  "FieldExtendsPO": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
body body object 否 none
» FieldExtendsPO body string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

PUT 更新字段

PUT /fieldextends/update

Body 请求参数

{
  "FieldExtendsPO": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
body body object 否 none
» FieldExtendsPO body string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据ID查找字段

GET /fieldextends/find/{id}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
id path string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

DELETE 根据ID删除id

DELETE /fieldextends/remove/{id}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
id path string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据ID查询FieldExtendsVO对象

GET /fieldextends/queryFieldExtendsByFid

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
fid query string 否 none

返回示例

200 Response

"string"

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 string

DELETE 根据ID集合删除字段

DELETE /fieldextends/deleteFieldExtendsByIds

Body 请求参数

{
  "fids": "",
  "String": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
body body object 否 none
» fids body string 是 none
» String body string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据模块名查找字段集合

GET /fieldextends/queryFieldExtendsByTable

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
domainId query string 否 none
forTable query string 否 none

返回示例

200 Response

"string"

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 string

PUT 清空field在相应表中的数据

PUT /fieldextends/cleanFieldData

Body 请求参数

{
  "id": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
domainId query string 否 none
tableName query string 否 none
fieldName query string 否 none
body body object 否 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

myApps用户中心/日志

POST 创建日志

POST /log/create

Body 请求参数

{
  "LogPO": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
body body object 否 none
» LogPO body string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

PUT 更新日志

PUT /log/update

Body 请求参数

{
  "LogPO": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
body body object 否 none
» LogPO body string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据id查找日志

GET /log/find/{id}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
id path string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

DELETE 根据id删除日志

DELETE /log/remove/{id}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
id path string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 查找日志

GET /log/queryLog

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
operator query string 否 none
date query string 否 none
ip query string 否 none
domain query string 否 none
page query string 否 none
lines query string 否 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

myApps用户中心/例外日

POST 创建例外日

POST /specialday/create

Body 请求参数

{
  "SpecialDayPO": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
id query string 否 none
body body object 否 none
» SpecialDayPO body string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

PUT 更新例外日

PUT /specialday/update

Body 请求参数

{
  "SpecialDayPO": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
body body object 否 none
» SpecialDayPO body string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 通过id查找例外日

GET /specialday/find/{id}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
id path string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

DELETE 根据id删除例外日

DELETE /specialday/remove/{id}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
id path string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 查找例外日

GET /specialday/queryByCalendar/{domainId}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
domainId path string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

myApps用户中心/标准日历

POST 创建日历

POST /standardday/create

Body 请求参数

{
  "StandardDayVO": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
body body object 否 none
» StandardDayVO body string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

PUT 更新日历

PUT /standardday/update

Body 请求参数

{
  "StandardDayVO": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
body body object 否 none
» StandardDayVO body string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据id获取日历

GET /standardday/find/{id}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
id path string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

DELETE 根据id删除日历

DELETE /standardday/remove/{id}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
id path string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 查找日历

GET /standardday/queryByCalendar/{domainId}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
domainId path string 是 none
calendarId query string 否 none
page query string 否 none
lines query string 否 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

myApps用户中心/同步日志

POST 创建同步日志

POST /SyncLogPO/create

Body 请求参数

{
  "SyncLogPO": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
body body object 否 none
» SyncLogPO body string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

PUT 更新同步日志

PUT /SyncLogPO/update

Body 请求参数

{
  "SyncLogPO": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
body body object 否 none
» SyncLogPO body string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 判断日志是否存在

GET /SyncLogPO/isExsit

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
id query string 否 none

返回示例

200 Response

"string"

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 string

myApps用户中心/用户

POST 创建用户

POST /user/create

Body 请求参数

{
  "po": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
body body object 否 none
» po body string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

PUT 更新用户

PUT /user/update

Body 请求参数

{
  "po": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
body body object 否 none
» po body string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据ID查找用户

GET /user/find/{id}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
id path string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

DELETE 根据ID删除用户

DELETE /user/remove/{id}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
id path string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据企业域用户集合并且分页

GET /user/queryByDomain

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
domainId query string 是 企业域id
page query string 是 none
lines query string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据账号，企业域查询用户

GET /user/findByLoginno

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
loginNo query string 否 用户账号
domainId query string 否 企业域Id

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据手机号码，企业域查询用户

GET /user/findByTelephone

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
telephone query string 否 用户手机号
domainId query string 否 企业域Id

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据邮箱，企业域查询用户

GET /user/findByEmail

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
email query string 否 用户邮箱账号
domainId query string 否 企业域Id

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据代理用户id查询用户集合

GET /user/queryByProxyUserId

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
proxyid query string 否 代理Id

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

PUT 更新用户锁定标志

PUT /user/updateUserLockFlag

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
loginNo query string 否 要锁定的状态
lockFlag query integer 否 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

POST JDBC批量创建用户

POST /user/batchCreate

Body 请求参数

{
  "users": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
body body object 否 none
» users body object 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 获取指定部门所有用户数

GET /user/countByDepartment

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
deptId query string 否 部门ID

返回示例

200 Response

0

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 integer

GET 获取指定角色且在指定企业域下所有用户数

GET /user/countByRoleAndDomain

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
roleId query string 否 角色ID
domainId query string 否 企业域ID

返回示例

200 Response

0

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 integer

GET 通过用户id获取该用户的所有角色id

GET /user/queryRoleIdsByUserId

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
userId query string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 查询用户，添加是否企业管理员参数

GET /user/queryDataByParamsTable

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
domainId query string 是 企业域id
departmentId query string 是 none
roleId query string 是 none
searchWord query string 是 none
status query integer 否 none
order query string 是 none
page query integer 是 none
lines query integer 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据关键字，企业域查询用户首字母集合

GET /user/queryByFirstLetter

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
keyword query string 是 none
domainId query string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据关键字，企业域进行模糊(用户名首字母，手机号，登陆名)查询用户集合

GET /user/queryByFuzzy

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
keyword query string 是 none
domainId query string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据用户数组，企业域查询用户集合

GET /user/queryByUserIds

Body 请求参数

[
  "__oP0irhWXGA2oZRusW1d"
]

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
domainId query string 是 企业域id
body body object 否 none
» ids body [string] 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据企业域，用户名称模糊查询用户集合

GET /user/queryByDomainAndLikeName

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
domainId query string 是 none
name query string 是 none
page query integer 是 none
lines query integer 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据企业域名称，钉钉用户id查询用户

GET /user/getUserByDdUserIdAndDoaminName

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
ddUserId query string 否 钉钉用户id
domainName query string 否 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据企业域名称，飞书用户id查询用户

GET /user/getUserByFsUserIdAndDoaminName

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
fsUserId query string 否 飞书用户id
domainName query string 否 企业域名称

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据企业域名称，用户账号模糊查询用户

GET /user/getUserByLoginnoLikeAndDoaminName

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
domainName query string 是 企业域名称
userName query string 是 用户名
page query integer 是 none
line query string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据部门查询用户集合

GET /user/queryByDepartmentAndRole

Body 请求参数

{
  "roleIds": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
deptId query string 否 部门Id
body body object 否 none
» roleIds body object 是 角色Id集合

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据部门查询用户集合

GET /user/queryByDepartment

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
deptId query string 是 部门Id
onlyUserinfoPublic query string 是 用户信息是否公开 true 仅显示公开信息的用户，false显示所哟用户
page query integer 是 none
lines query integer 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据角色查询用户集合

GET /user/queryByRoleAndDomain

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
roleId query string 是 角色id
domainId query string 是 企业域
page query integer 是 none
lines query integer 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 通过上级查找用户

GET /user/queryBySuperior

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
superiorId query string 是 none
page query integer 是 none
lines query integer 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据角色查询用户集合

GET /user/queryByDomainAndContanctsIdAndUsers

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
domainId query string 是 none
contanctId query string 是 用户组id
userName query string 否 none
page query string 是 none
lines query string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 获得用户(UserPO)的对象列表

GET /user/queryUsersByLoginno

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
loginNo query string 是 用户名

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据角色id获取全部用户部门角色权限关系

GET /user/queryUserDeptRoleSetsByRoleId

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
roleId query string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 查询符合条件的对象集合

GET /user/queryKmRoleIdsByUserId

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
userId query string 是 用户id

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

myApps用户中心/用户扩展属性

POST 创建用户扩展属性

POST /userdefined/create

Body 请求参数

{
  "UserDefinedPO": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
body body object 否 none
» UserDefinedPO body string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

PUT 更新用户扩展属性

PUT /userdefined/update

Body 请求参数

{
  "UserDefinedPO": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
body body object 否 none
» UserDefinedPO body string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据id查找用户扩展属性

GET /userdefined/find/{id}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
id path string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

DELETE 根据id删除用户扩展属性

DELETE /userdefined/remove/{id}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
id path string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 获取用户扩展属性

GET /userdefined/findMyCustomUserDefined

Body 请求参数

{
  "userid": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
userId query string 否 none
body body object 否 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

myApps用户中心/用户分组

POST 新建用户分组

POST /usergroup/create

Body 请求参数

{
  "po": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
body body object 否 none
» po body string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

PUT 更新用户分组

PUT /usergroup/update

Body 请求参数

{
  "po": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
body body object 否 none
» po body string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据ID查找用户分组

GET /usergroup/find/{id}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
id path string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

DELETE 根据ID删除

DELETE /usergroup/remove/{id}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
id path string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据用户返回用户的组信息

GET /usergroup/getUserGroupsByUser

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
userId query string 是 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 根据分组名和用户ID查询是否已存在分组

GET /usergroup/isExistGroup

请求参数

名称 位置 类型 必选 说明
accessToken cookie string 否 none
adminToken cookie string 否 none
userGroupName query string 是 分组名
ownerId query string 是 用户ID

返回示例

200 Response

"string"

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 string

数据模型

文档更新时间: 2023-09-12 11:55   作者：admin