GAC-CMS

广新公共模块


广汽CMS所有接口

[TOC]

广汽-通用管理接口文档

简介:为广汽开发提供接口服务

联系人:

Version:1.0

接口路径:/v2/api-docs

oauth-token-controller

getAccessToken

接口说明:

接口地址:/oauth/token

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
name query false string
parameters parameters query true object

响应数据:

响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

postAccessToken

接口说明:

接口地址:/oauth/token

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
name query false string
parameters parameters query true object

响应数据:

响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

oauth用户相关

添加用户信息用户信息

接口说明:

接口地址:/oauth/add/user

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "account": "",
    "agentId": "",
    "category": "",
    "domain": "",
    "email": "",
    "onboardingTime": "",
    "organizeId": "",
    "phone": "",
    "position": "",
    "roleId": "",
    "sex": "",
    "status": 0,
    "superiorId": "",
    "technicalId": "",
    "userId": "",
    "username": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
addUserVo 用户信息 body false 添加用户信息 添加用户信息

schema属性说明

添加用户信息

参数名称 说明 in 是否必须 类型 schema
account 工号 body true string
agentId 代理人ID body false string
category 类别 body true string
domain 厂域 body false string
email 邮箱 body true string
onboardingTime 入职时间 body true string
organizeId 组织ID body false string
phone 手机号码 body true string
position 职位 body false string
roleId 角色ID body false string
sex 性别 body true string
status 启用状态:0为启用,1为未启用 body true int32
superiorId 上级主管ID body false string
technicalId 技能ID body false string
userId 用户id body false string
username 用户名 body true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

获取当前用户信息

接口说明:

接口地址:/oauth/current/user

请求方式GET

consumes:``

produces:["*/*"]

请求参数: 暂无

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {
        "account": "",
        "agent": "",
        "agentId": "",
        "agentName": "",
        "authorityInfo": [
            {
                "appId": "",
                "appName": "",
                "authorityInfo": [
                    {
                        "appId": "",
                        "appName": "",
                        "clientId": "",
                        "id": "",
                        "modelName": "",
                        "modelParentId": "",
                        "other": "",
                        "resourceId": "",
                        "resourceName": "",
                        "status": 0
                    }
                ],
                "clientId": ""
            }
        ],
        "category": "",
        "domain": "",
        "email": "",
        "id": "",
        "index": 0,
        "localRes": [
            {
                "desc": "",
                "resourceId": ""
            }
        ],
        "mobile": "",
        "onboardingTime": "",
        "organizeId": "",
        "organizeName": "",
        "position": "",
        "roleList": [
            {
                "count": 0,
                "delete": 0,
                "enable": 0,
                "id": "",
                "roleName": ""
            }
        ],
        "sex": "",
        "status": 0,
        "superior": "",
        "superiorId": "",
        "superiorName": "",
        "technicalList": [
            {
                "technicalCode": "",
                "technicalId": ""
            }
        ],
        "username": ""
    }
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload 用户列表信息 用户列表信息

schema属性说明

用户列表信息

参数名称 说明 类型 schema
account 账户 string
agent 代理人工号 string
agentId 代理人Id string
agentName 代理人名称 string
authorityInfo array AppPointInfo
category 类别 string
domain 厂域 string
email 用户邮箱 string
id 用户id string
index 序号 int32
localRes array LocalAppResourceInfo
mobile 用户手机 string
onboardingTime 入职时间 date-time
organizeId 组织id string
organizeName 组织名称 string
position 职位 string
roleList array RoleDo
sex 性别 string
status 启用状态:0为启用,1为未启用 int32
superior 上级主管工号 string
superiorId 上级主管ID string
superiorName 上级主管名称 string
technicalList array TechnicalDo
username 用户姓名 string

AppPointInfo

参数名称 说明 类型 schema
appId 应用ID string
appName 应用名称 string
authorityInfo array 应用节点信息
clientId 客户端ID string

应用节点信息

参数名称 说明 类型 schema
appId 应用ID string
appName 应用名称 string
clientId 客户端ID string
id 节点ID string
modelName 节点名称 string
modelParentId 节点父级节点ID string
other 资源说明 string
resourceId 资源ID string
resourceName 资源名称 string
status 是否可用:0(可用)/1(禁用) int32

LocalAppResourceInfo

参数名称 说明 类型 schema
desc 资源描述 string
resourceId 资源ID string

RoleDo

参数名称 说明 类型 schema
count 角色下人数 int32
delete 是否可编辑:0(可编辑)/1(不可编辑) int32
enable 角色状态 int32
id 角色id string
roleName 角色名称 string

TechnicalDo

参数名称 说明 类型 schema
technicalCode 技能编号 string
technicalId 技能id string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«用户列表信息»
204 No Content
401 Unauthorized
403 Forbidden

用户导入模板下载

接口说明:

接口地址:/oauth/download/template

请求方式GET

consumes:``

produces:["*/*"]

请求参数: 暂无

响应数据:

响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

修改密码

接口说明:

接口地址:/oauth/edit/password

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
newPassword 新密码 query true string
oldPassword 旧密码 query true string
userId 用户Id query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

忘记密码

接口说明:

接口地址:/oauth/forget/password

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
account 用户工号 query false string
code 验证码 query false string
passwordNew 新密码 query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

服务端登录获取token

接口说明:

接口地址:/oauth/get/token

请求方式GET

consumes:``

produces:["*/*"]

请求参数: 暂无

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

传入用户工号集获取用户基础信息

接口说明:

接口地址:/oauth/info/accounts

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
accounts accounts query true array string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": [
        {
            "account": "",
            "email": "",
            "id": "",
            "mobile": "",
            "parent_id": "",
            "username": ""
        }
    ]
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload array UserSimpleInfoVo

schema属性说明

UserSimpleInfoVo

参数名称 说明 类型 schema
account 账户 string
email 用户邮箱 string
id string
mobile 用户手机 string
parent_id 上一级id string
username 用户姓名 string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«List«UserSimpleInfoVo»»
401 Unauthorized
403 Forbidden
404 Not Found

登录

接口说明:

接口地址:/oauth/login

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数: 暂无

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

登出

接口说明:

接口地址:/oauth/logout

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
logout_all 是否全部登出 query false boolean

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

重置密码

接口说明:

接口地址:/oauth/reset/password

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
password 密码 query false string
userId 用户Id query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

传入用户工号获取下属信息

接口说明:

接口地址:/oauth/sbordinate/info

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
account account query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": [
        {
            "account": "",
            "email": "",
            "id": "",
            "mobile": "",
            "parent_id": "",
            "username": ""
        }
    ]
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload array UserSimpleInfoVo

schema属性说明

UserSimpleInfoVo

参数名称 说明 类型 schema
account 账户 string
email 用户邮箱 string
id string
mobile 用户手机 string
parent_id 上一级id string
username 用户姓名 string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«List«UserSimpleInfoVo»»
401 Unauthorized
403 Forbidden
404 Not Found

发送验证码

接口说明:

接口地址:/oauth/send/code

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
account 用户工号 query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

修改个人用户信息用户信息

接口说明:

接口地址:/oauth/update/personal

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "agent": "",
    "email": "",
    "phone": "",
    "sex": "",
    "userId": "",
    "username": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
addUserVo 用户信息 body false UserPersonalVo UserPersonalVo

schema属性说明

UserPersonalVo

参数名称 说明 in 是否必须 类型 schema
agent 代理人ID body false string
email 邮箱 body true string
phone 联系方式 body true string
sex 性别 body true string
userId 用户ID body true string
username 用户名 body true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

修改用户信息用户信息

接口说明:

接口地址:/oauth/update/user

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "account": "",
    "agentId": "",
    "category": "",
    "domain": "",
    "email": "",
    "onboardingTime": "",
    "organizeId": "",
    "phone": "",
    "position": "",
    "roleId": "",
    "sex": "",
    "status": 0,
    "superiorId": "",
    "technicalId": "",
    "userId": "",
    "username": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
addUserVo 用户信息 body false 添加用户信息 添加用户信息

schema属性说明

添加用户信息

参数名称 说明 in 是否必须 类型 schema
account 工号 body true string
agentId 代理人ID body false string
category 类别 body true string
domain 厂域 body false string
email 邮箱 body true string
onboardingTime 入职时间 body true string
organizeId 组织ID body false string
phone 手机号码 body true string
position 职位 body false string
roleId 角色ID body false string
sex 性别 body true string
status 启用状态:0为启用,1为未启用 body true int32
superiorId 上级主管ID body false string
technicalId 技能ID body false string
userId 用户id body false string
username 用户名 body true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

获取指定用户信息

接口说明:

接口地址:/oauth/user

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
userId 用户ID query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {
        "account": "",
        "agent": "",
        "agentId": "",
        "agentName": "",
        "authorityInfo": [
            {
                "appId": "",
                "appName": "",
                "authorityInfo": [
                    {
                        "appId": "",
                        "appName": "",
                        "clientId": "",
                        "id": "",
                        "modelName": "",
                        "modelParentId": "",
                        "other": "",
                        "resourceId": "",
                        "resourceName": "",
                        "status": 0
                    }
                ],
                "clientId": ""
            }
        ],
        "category": "",
        "domain": "",
        "email": "",
        "id": "",
        "index": 0,
        "localRes": [
            {
                "desc": "",
                "resourceId": ""
            }
        ],
        "mobile": "",
        "onboardingTime": "",
        "organizeId": "",
        "organizeName": "",
        "position": "",
        "roleList": [
            {
                "count": 0,
                "delete": 0,
                "enable": 0,
                "id": "",
                "roleName": ""
            }
        ],
        "sex": "",
        "status": 0,
        "superior": "",
        "superiorId": "",
        "superiorName": "",
        "technicalList": [
            {
                "technicalCode": "",
                "technicalId": ""
            }
        ],
        "username": ""
    }
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload 用户列表信息 用户列表信息

schema属性说明

用户列表信息

参数名称 说明 类型 schema
account 账户 string
agent 代理人工号 string
agentId 代理人Id string
agentName 代理人名称 string
authorityInfo array AppPointInfo
category 类别 string
domain 厂域 string
email 用户邮箱 string
id 用户id string
index 序号 int32
localRes array LocalAppResourceInfo
mobile 用户手机 string
onboardingTime 入职时间 date-time
organizeId 组织id string
organizeName 组织名称 string
position 职位 string
roleList array RoleDo
sex 性别 string
status 启用状态:0为启用,1为未启用 int32
superior 上级主管工号 string
superiorId 上级主管ID string
superiorName 上级主管名称 string
technicalList array TechnicalDo
username 用户姓名 string

AppPointInfo

参数名称 说明 类型 schema
appId 应用ID string
appName 应用名称 string
authorityInfo array 应用节点信息
clientId 客户端ID string

应用节点信息

参数名称 说明 类型 schema
appId 应用ID string
appName 应用名称 string
clientId 客户端ID string
id 节点ID string
modelName 节点名称 string
modelParentId 节点父级节点ID string
other 资源说明 string
resourceId 资源ID string
resourceName 资源名称 string
status 是否可用:0(可用)/1(禁用) int32

LocalAppResourceInfo

参数名称 说明 类型 schema
desc 资源描述 string
resourceId 资源ID string

RoleDo

参数名称 说明 类型 schema
count 角色下人数 int32
delete 是否可编辑:0(可编辑)/1(不可编辑) int32
enable 角色状态 int32
id 角色id string
roleName 角色名称 string

TechnicalDo

参数名称 说明 类型 schema
technicalCode 技能编号 string
technicalId 技能id string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«用户列表信息»
204 No Content
401 Unauthorized
403 Forbidden

获取用户信息列表

接口说明:

接口地址:/oauth/user/list

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "account": "",
    "endDate": "",
    "isAll": 0,
    "organizeId": "",
    "pageNum": 0,
    "pageSize": 0,
    "position": "",
    "roleId": "",
    "startDate": "",
    "superiorId": "",
    "technicalName": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
userParam 用户信息 body false UserParam UserParam

schema属性说明

UserParam

参数名称 说明 in 是否必须 类型 schema
account 姓名/工号 body false string
endDate 结束时间 body false string
isAll 是否查询全部:0为查询全部/1为查询不包括本身的用户列表 body false int32
organizeId 所属组织 body false string
pageNum 页码 body false int32
pageSize 每页显示数 body false int32
position 职位 body false string
roleId 角色id body false string
startDate 开始时间 body false string
superiorId 上级主管 body false string
technicalName 技能等级 body false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {
        "count": 0,
        "data": [
            {
                "account": "",
                "agent": "",
                "agentId": "",
                "agentName": "",
                "authorityInfo": [
                    {
                        "appId": "",
                        "appName": "",
                        "authorityInfo": [
                            {
                                "appId": "",
                                "appName": "",
                                "clientId": "",
                                "id": "",
                                "modelName": "",
                                "modelParentId": "",
                                "other": "",
                                "resourceId": "",
                                "resourceName": "",
                                "status": 0
                            }
                        ],
                        "clientId": ""
                    }
                ],
                "category": "",
                "domain": "",
                "email": "",
                "id": "",
                "index": 0,
                "localRes": [
                    {
                        "desc": "",
                        "resourceId": ""
                    }
                ],
                "mobile": "",
                "onboardingTime": "",
                "organizeId": "",
                "organizeName": "",
                "position": "",
                "roleList": [
                    {
                        "count": 0,
                        "delete": 0,
                        "enable": 0,
                        "id": "",
                        "roleName": ""
                    }
                ],
                "sex": "",
                "status": 0,
                "superior": "",
                "superiorId": "",
                "superiorName": "",
                "technicalList": [
                    {
                        "technicalCode": "",
                        "technicalId": ""
                    }
                ],
                "username": ""
            }
        ],
        "pageCount": 0,
        "pageNum": 0,
        "pageSize": 0
    }
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload PageBody«List«用户列表信息»» PageBody«List«用户列表信息»»

schema属性说明

PageBody«List«用户列表信息»»

参数名称 说明 类型 schema
count 总共有多少条数据 int64
data 数据列表 array 用户列表信息
pageCount 总共有多少页 int64
pageNum 当前第几页 int32
pageSize 每页条数 int32

用户列表信息

参数名称 说明 类型 schema
account 账户 string
agent 代理人工号 string
agentId 代理人Id string
agentName 代理人名称 string
authorityInfo array AppPointInfo
category 类别 string
domain 厂域 string
email 用户邮箱 string
id 用户id string
index 序号 int32
localRes array LocalAppResourceInfo
mobile 用户手机 string
onboardingTime 入职时间 date-time
organizeId 组织id string
organizeName 组织名称 string
position 职位 string
roleList array RoleDo
sex 性别 string
status 启用状态:0为启用,1为未启用 int32
superior 上级主管工号 string
superiorId 上级主管ID string
superiorName 上级主管名称 string
technicalList array TechnicalDo
username 用户姓名 string

AppPointInfo

参数名称 说明 类型 schema
appId 应用ID string
appName 应用名称 string
authorityInfo array 应用节点信息
clientId 客户端ID string

应用节点信息

参数名称 说明 类型 schema
appId 应用ID string
appName 应用名称 string
clientId 客户端ID string
id 节点ID string
modelName 节点名称 string
modelParentId 节点父级节点ID string
other 资源说明 string
resourceId 资源ID string
resourceName 资源名称 string
status 是否可用:0(可用)/1(禁用) int32

LocalAppResourceInfo

参数名称 说明 类型 schema
desc 资源描述 string
resourceId 资源ID string

RoleDo

参数名称 说明 类型 schema
count 角色下人数 int32
delete 是否可编辑:0(可编辑)/1(不可编辑) int32
enable 角色状态 int32
id 角色id string
roleName 角色名称 string

TechnicalDo

参数名称 说明 类型 schema
technicalCode 技能编号 string
technicalId 技能id string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«PageBody«List«用户列表信息»»»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

获取简单用户信息

接口说明:

接口地址:/oauth/user/simple

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
account 用户工号/姓名 query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": [
        {
            "account": "",
            "email": "",
            "id": "",
            "mobile": "",
            "parent_id": "",
            "username": ""
        }
    ]
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload array UserSimpleInfoVo

schema属性说明

UserSimpleInfoVo

参数名称 说明 类型 schema
account 账户 string
email 用户邮箱 string
id string
mobile 用户手机 string
parent_id 上一级id string
username 用户姓名 string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«List«UserSimpleInfoVo»»
204 No Content
401 Unauthorized
403 Forbidden

禁用用户

接口说明:

接口地址:/oauth/user/status

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
status 启用状态:0为启用,1为未启用 query false integer
userId 用户Id:多个用英文逗号隔开 query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

用户批量上传

接口说明:

接口地址:/oauth/user/upload

请求方式POST

consumes:["multipart/form-data"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
file file formData true file

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

企业微信调试

getinfo

接口说明:

接口地址:/qywechat/getinfo

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
token token query false string

响应数据:

响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

getAccesstoken

接口说明:

接口地址:/qywechat/gettoken

请求方式GET

consumes:``

produces:["*/*"]

请求参数: 暂无

响应数据:

响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

学习管理

课程完成学习

接口说明:

接口地址:/study/complete

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
file_ids 项目id集 query true array string
task_id 任务id query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

附件列表

接口说明:

接口地址:/study/course/annex/list

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
course_id 课程id query true string
task_id 任务id query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": [
        {
            "createTime": "",
            "file_name": "",
            "id": "",
            "preview": true,
            "status": "",
            "version": ""
        }
    ]
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload array CourseAnnexInfoVo

schema属性说明

CourseAnnexInfoVo

参数名称 说明 类型 schema
createTime string
file_name string
id string
preview boolean
status string
version string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«List«CourseAnnexInfoVo»»
401 Unauthorized
403 Forbidden
404 Not Found

新建推送任务

接口说明:

接口地址:/study/create/task

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "course_ids": [],
    "user_ids": []
}

请求参数

参数名称 说明 in 是否必须 类型 schema
data 新建任务信息 body true 新建推送任务 新建推送任务

schema属性说明

新建推送任务

参数名称 说明 in 是否必须 类型 schema
course_ids 课程id集 body true array
user_ids 用户id集 body true array

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

学习任务

接口说明:

接口地址:/study/task

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
page_num 当前页数 query false integer
page_size 每页数量 query false integer
status 状态 query true boolean

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

学习记录员工列表

接口说明:

接口地址:/study/task/user/list

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
keyword 关键字 query false string
page_num 当前页数 query false integer
page_size 每页数量 query false integer

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {
        "count": 0,
        "data": [
            {
                "account": "",
                "agent": "",
                "agentId": "",
                "agentName": "",
                "category": "",
                "domain": "",
                "email": "",
                "enabled": 0,
                "id": "",
                "mobile": "",
                "onboardingTime": "",
                "onboarding_time": "",
                "organizeId": "",
                "organizeName": "",
                "password": "",
                "position": "",
                "roleList": [
                    {
                        "count": 0,
                        "delete": 0,
                        "enable": 0,
                        "id": "",
                        "roleName": ""
                    }
                ],
                "sex": "",
                "superior": "",
                "superiorId": "",
                "superiorName": "",
                "technicalList": [
                    {
                        "technicalCode": "",
                        "technicalId": ""
                    }
                ],
                "username": ""
            }
        ],
        "pageCount": 0,
        "pageNum": 0,
        "pageSize": 0
    }
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload PageBody«List«OauthAccountDo»» PageBody«List«OauthAccountDo»»

schema属性说明

PageBody«List«OauthAccountDo»»

参数名称 说明 类型 schema
count 总共有多少条数据 int64
data 数据列表 array OauthAccountDo
pageCount 总共有多少页 int64
pageNum 当前第几页 int32
pageSize 每页条数 int32

OauthAccountDo

参数名称 说明 类型 schema
account string
agent string
agentId string
agentName string
category string
domain string
email string
enabled int32
id string
mobile string
onboardingTime date-time
onboarding_time string
organizeId string
organizeName string
password string
position string
roleList array RoleDo
sex string
superior string
superiorId string
superiorName string
technicalList array TechnicalDo
username string

RoleDo

参数名称 说明 类型 schema
count 角色下人数 int32
delete 是否可编辑:0(可编辑)/1(不可编辑) int32
enable 角色状态 int32
id 角色id string
roleName 角色名称 string

TechnicalDo

参数名称 说明 类型 schema
technicalCode 技能编号 string
technicalId 技能id string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«PageBody«List«OauthAccountDo»»»
401 Unauthorized
403 Forbidden
404 Not Found

用户列表

接口说明:

接口地址:/study/user/list

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
keyword 关键字 query false string
page_num 当前页数 query false integer
page_size 每页数量 query false integer

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {
        "count": 0,
        "data": [
            {
                "account": "",
                "agent": "",
                "agentId": "",
                "agentName": "",
                "category": "",
                "domain": "",
                "email": "",
                "enabled": 0,
                "id": "",
                "mobile": "",
                "onboardingTime": "",
                "onboarding_time": "",
                "organizeId": "",
                "organizeName": "",
                "password": "",
                "position": "",
                "roleList": [
                    {
                        "count": 0,
                        "delete": 0,
                        "enable": 0,
                        "id": "",
                        "roleName": ""
                    }
                ],
                "sex": "",
                "superior": "",
                "superiorId": "",
                "superiorName": "",
                "technicalList": [
                    {
                        "technicalCode": "",
                        "technicalId": ""
                    }
                ],
                "username": ""
            }
        ],
        "pageCount": 0,
        "pageNum": 0,
        "pageSize": 0
    }
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload PageBody«List«OauthAccountDo»» PageBody«List«OauthAccountDo»»

schema属性说明

PageBody«List«OauthAccountDo»»

参数名称 说明 类型 schema
count 总共有多少条数据 int64
data 数据列表 array OauthAccountDo
pageCount 总共有多少页 int64
pageNum 当前第几页 int32
pageSize 每页条数 int32

OauthAccountDo

参数名称 说明 类型 schema
account string
agent string
agentId string
agentName string
category string
domain string
email string
enabled int32
id string
mobile string
onboardingTime date-time
onboarding_time string
organizeId string
organizeName string
password string
position string
roleList array RoleDo
sex string
superior string
superiorId string
superiorName string
technicalList array TechnicalDo
username string

RoleDo

参数名称 说明 类型 schema
count 角色下人数 int32
delete 是否可编辑:0(可编辑)/1(不可编辑) int32
enable 角色状态 int32
id 角色id string
roleName 角色名称 string

TechnicalDo

参数名称 说明 类型 schema
technicalCode 技能编号 string
technicalId 技能id string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«PageBody«List«OauthAccountDo»»»
401 Unauthorized
403 Forbidden
404 Not Found

员工学习记录

接口说明:

接口地址:/study/user/record

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
user_id 用户id query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": [
        {
            "complete_time": "",
            "course_code": "",
            "course_name": "",
            "create_time": "",
            "status": "",
            "task_num": "",
            "technicalList": [
                {
                    "technicalCode": "",
                    "technicalId": ""
                }
            ]
        }
    ]
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload array StudyRecordVo

schema属性说明

StudyRecordVo

参数名称 说明 类型 schema
complete_time string
course_code string
course_name string
create_time string
status string
task_num string
technicalList array TechnicalDo

TechnicalDo

参数名称 说明 类型 schema
technicalCode 技能编号 string
technicalId 技能id string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«List«StudyRecordVo»»
401 Unauthorized
403 Forbidden
404 Not Found

客户端管理

应用注册

接口说明:

接口地址:/client/add/app

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "appAddress": "",
    "appName": "",
    "appType": "",
    "authorityModel": 0,
    "cronId": "",
    "id": "",
    "menuModel": 0,
    "menuUrl": "",
    "order": 0
}

请求参数

参数名称 说明 in 是否必须 类型 schema
clientParamVo 应用注册信息 body false 客户端参数信息 客户端参数信息

schema属性说明

客户端参数信息

参数名称 说明 in 是否必须 类型 schema
appAddress 应用地址 body true string
appName 应用名称 body true string
appType 应用类型:WEB/APP body true string
authorityModel 接入模块-权限管理(0:接入/1:不接入) body true int32
cronId 应用图标 body true string
id 应用id body false string
menuModel 接入模块-菜单集成(0:接入/1:不接入) body true int32
menuUrl 菜单地址 body false string
order body false int32

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {
        "appName": "",
        "clientId": "",
        "clientSecret": ""
    }
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload ClientInfoVo ClientInfoVo

schema属性说明

ClientInfoVo

参数名称 说明 类型 schema
appName 应用名 string
clientId 客户端ID string
clientSecret 客户端Secret string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«ClientInfoVo»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

删除应用

接口说明:

接口地址:/client/app/delete

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
clientId 应用Id query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

编辑应用

接口说明:

接口地址:/client/app/edit

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "appAddress": "",
    "appName": "",
    "appType": "",
    "authorityModel": 0,
    "cronId": "",
    "id": "",
    "menuModel": 0,
    "menuUrl": "",
    "order": 0
}

请求参数

参数名称 说明 in 是否必须 类型 schema
clientParamVo 应用注册信息 body false 客户端参数信息 客户端参数信息

schema属性说明

客户端参数信息

参数名称 说明 in 是否必须 类型 schema
appAddress 应用地址 body true string
appName 应用名称 body true string
appType 应用类型:WEB/APP body true string
authorityModel 接入模块-权限管理(0:接入/1:不接入) body true int32
cronId 应用图标 body true string
id 应用id body false string
menuModel 接入模块-菜单集成(0:接入/1:不接入) body true int32
menuUrl 菜单地址 body false string
order body false int32

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

应用列表

接口说明:

接口地址:/client/app/list

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
appName 应用名 query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": [
        {
            "appAddress": "",
            "appName": "",
            "appType": "",
            "authorityModel": 0,
            "clientId": "",
            "clientSecret": "",
            "cronId": "",
            "id": "",
            "menuModel": 0,
            "menuUrl": ""
        }
    ]
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload array ClientDetailVo

schema属性说明

ClientDetailVo

参数名称 说明 类型 schema
appAddress string
appName string
appType string
authorityModel int32
clientId string
clientSecret string
cronId string
id string
menuModel int32
menuUrl string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«List«ClientDetailVo»»
401 Unauthorized
403 Forbidden
404 Not Found

开放接口

获取用户信息列表

接口说明:

接口地址:/open/oauth/user/list

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "account": "",
    "endDate": "",
    "isAll": 0,
    "organizeId": "",
    "pageNum": 0,
    "pageSize": 0,
    "position": "",
    "roleId": "",
    "startDate": "",
    "superiorId": "",
    "technicalName": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
userParam 用户信息 body false UserParam UserParam

schema属性说明

UserParam

参数名称 说明 in 是否必须 类型 schema
account 姓名/工号 body false string
endDate 结束时间 body false string
isAll 是否查询全部:0为查询全部/1为查询不包括本身的用户列表 body false int32
organizeId 所属组织 body false string
pageNum 页码 body false int32
pageSize 每页显示数 body false int32
position 职位 body false string
roleId 角色id body false string
startDate 开始时间 body false string
superiorId 上级主管 body false string
technicalName 技能等级 body false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {
        "count": 0,
        "data": [
            {
                "account": "",
                "agent": "",
                "agentId": "",
                "agentName": "",
                "authorityInfo": [
                    {
                        "appId": "",
                        "appName": "",
                        "authorityInfo": [
                            {
                                "appId": "",
                                "appName": "",
                                "clientId": "",
                                "id": "",
                                "modelName": "",
                                "modelParentId": "",
                                "other": "",
                                "resourceId": "",
                                "resourceName": "",
                                "status": 0
                            }
                        ],
                        "clientId": ""
                    }
                ],
                "category": "",
                "domain": "",
                "email": "",
                "id": "",
                "index": 0,
                "localRes": [
                    {
                        "desc": "",
                        "resourceId": ""
                    }
                ],
                "mobile": "",
                "onboardingTime": "",
                "organizeId": "",
                "organizeName": "",
                "position": "",
                "roleList": [
                    {
                        "count": 0,
                        "delete": 0,
                        "enable": 0,
                        "id": "",
                        "roleName": ""
                    }
                ],
                "sex": "",
                "status": 0,
                "superior": "",
                "superiorId": "",
                "superiorName": "",
                "technicalList": [
                    {
                        "technicalCode": "",
                        "technicalId": ""
                    }
                ],
                "username": ""
            }
        ],
        "pageCount": 0,
        "pageNum": 0,
        "pageSize": 0
    }
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload PageBody«List«用户列表信息»» PageBody«List«用户列表信息»»

schema属性说明

PageBody«List«用户列表信息»»

参数名称 说明 类型 schema
count 总共有多少条数据 int64
data 数据列表 array 用户列表信息
pageCount 总共有多少页 int64
pageNum 当前第几页 int32
pageSize 每页条数 int32

用户列表信息

参数名称 说明 类型 schema
account 账户 string
agent 代理人工号 string
agentId 代理人Id string
agentName 代理人名称 string
authorityInfo array AppPointInfo
category 类别 string
domain 厂域 string
email 用户邮箱 string
id 用户id string
index 序号 int32
localRes array LocalAppResourceInfo
mobile 用户手机 string
onboardingTime 入职时间 date-time
organizeId 组织id string
organizeName 组织名称 string
position 职位 string
roleList array RoleDo
sex 性别 string
status 启用状态:0为启用,1为未启用 int32
superior 上级主管工号 string
superiorId 上级主管ID string
superiorName 上级主管名称 string
technicalList array TechnicalDo
username 用户姓名 string

AppPointInfo

参数名称 说明 类型 schema
appId 应用ID string
appName 应用名称 string
authorityInfo array 应用节点信息
clientId 客户端ID string

应用节点信息

参数名称 说明 类型 schema
appId 应用ID string
appName 应用名称 string
clientId 客户端ID string
id 节点ID string
modelName 节点名称 string
modelParentId 节点父级节点ID string
other 资源说明 string
resourceId 资源ID string
resourceName 资源名称 string
status 是否可用:0(可用)/1(禁用) int32

LocalAppResourceInfo

参数名称 说明 类型 schema
desc 资源描述 string
resourceId 资源ID string

RoleDo

参数名称 说明 类型 schema
count 角色下人数 int32
delete 是否可编辑:0(可编辑)/1(不可编辑) int32
enable 角色状态 int32
id 角色id string
roleName 角色名称 string

TechnicalDo

参数名称 说明 类型 schema
technicalCode 技能编号 string
technicalId 技能id string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«PageBody«List«用户列表信息»»»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

获取指定组织信息

接口说明:

接口地址:/open/organize/info

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
organizeId 组织Id query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {
        "account": "",
        "count": 0,
        "email": "",
        "id": "",
        "organizeName": "",
        "organizeParent": "",
        "other": "",
        "phone": "",
        "status": 0,
        "userId": "",
        "username": ""
    }
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload OrganizeDetailVo OrganizeDetailVo

schema属性说明

OrganizeDetailVo

参数名称 说明 类型 schema
account 负责人账号 string
count 组织人数 int32
email 负责人邮箱 string
id 组织ID string
organizeName 组织名称 string
organizeParent 上级组织 string
other 备注 string
phone 负责人电话 string
status 是否可用:0(可用)/1(禁用) int32
userId 用户Id string
username 负责人名称 string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«OrganizeDetailVo»
401 Unauthorized
403 Forbidden
404 Not Found

技能管理

技能添加课程

接口说明:

接口地址:/technical/bind/course

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "ids": [],
    "technical_id": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
info 技能信息 body true AddUserCourseTechnicalDto AddUserCourseTechnicalDto

schema属性说明

AddUserCourseTechnicalDto

参数名称 说明 in 是否必须 类型 schema
ids 用户id集或课程id集 body true array
technical_id 技能id body true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

技能添加用户

接口说明:

接口地址:/technical/bind/user

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "ids": [],
    "technical_id": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
info 技能信息 body true AddUserCourseTechnicalDto AddUserCourseTechnicalDto

schema属性说明

AddUserCourseTechnicalDto

参数名称 说明 in 是否必须 类型 schema
ids 用户id集或课程id集 body true array
technical_id 技能id body true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

获取技能关联课程

接口说明:

接口地址:/technical/course

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
id 当前技能id query true string
keyword 关键字 query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": [
        {
            "course_code": "",
            "course_name": "",
            "id": "",
            "project_code": "",
            "project_name": ""
        }
    ]
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload array TechnicalCourseVo

schema属性说明

TechnicalCourseVo

参数名称 说明 类型 schema
course_code string
course_name string
id string
project_code string
project_name string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«List«TechnicalCourseVo»»
401 Unauthorized
403 Forbidden
404 Not Found

删除技能

接口说明:

接口地址:/technical/delete

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
ids 技能id集 query true array string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

技能删除课程

接口说明:

接口地址:/technical/delete/course

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "ids": [],
    "technical_id": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
info 技能信息 body true AddUserCourseTechnicalDto AddUserCourseTechnicalDto

schema属性说明

AddUserCourseTechnicalDto

参数名称 说明 in 是否必须 类型 schema
ids 用户id集或课程id集 body true array
technical_id 技能id body true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

技能删除用户

接口说明:

接口地址:/technical/delete/user

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "ids": [],
    "technical_id": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
info 技能信息 body true AddUserCourseTechnicalDto AddUserCourseTechnicalDto

schema属性说明

AddUserCourseTechnicalDto

参数名称 说明 in 是否必须 类型 schema
ids 用户id集或课程id集 body true array
technical_id 技能id body true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

分厂域技能列表

接口说明:

接口地址:/technical/domain/list

请求方式GET

consumes:``

produces:["*/*"]

请求参数: 暂无

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

获取技能详情

接口说明:

接口地址:/technical/info/{id}

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
id 当前技能id path true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {
        "courses": 0,
        "id": "",
        "other": "",
        "parent_code": "",
        "parent_id": "",
        "technical_code": "",
        "technical_sequence": "",
        "users": 0
    }
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload TechnicalInfoVo TechnicalInfoVo

schema属性说明

TechnicalInfoVo

参数名称 说明 类型 schema
courses int32
id string
other string
parent_code string
parent_id string
technical_code string
technical_sequence string
users int32

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«TechnicalInfoVo»
401 Unauthorized
403 Forbidden
404 Not Found

技能列表

接口说明:

接口地址:/technical/list

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
keyword 关键字 query false string
page_num 当前页数 query false integer
page_size 每页数量 query false integer

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {
        "count": 0,
        "data": [
            {
                "courses": 0,
                "id": "",
                "other": "",
                "parent_code": "",
                "parent_id": "",
                "technical_code": "",
                "technical_sequence": "",
                "users": 0
            }
        ],
        "pageCount": 0,
        "pageNum": 0,
        "pageSize": 0
    }
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload PageBody«List«TechnicalInfoVo»» PageBody«List«TechnicalInfoVo»»

schema属性说明

PageBody«List«TechnicalInfoVo»»

参数名称 说明 类型 schema
count 总共有多少条数据 int64
data 数据列表 array TechnicalInfoVo
pageCount 总共有多少页 int64
pageNum 当前第几页 int32
pageSize 每页条数 int32

TechnicalInfoVo

参数名称 说明 类型 schema
courses int32
id string
other string
parent_code string
parent_id string
technical_code string
technical_sequence string
users int32

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«PageBody«List«TechnicalInfoVo»»»
401 Unauthorized
403 Forbidden
404 Not Found

新建技能

接口说明:

接口地址:/technical/save

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "course_ids": [],
    "other": "",
    "parent_id": "",
    "technical_code": "",
    "technical_sequence": "",
    "user_ids": []
}

请求参数

参数名称 说明 in 是否必须 类型 schema
technical 技能信息 body true AddTechnicalDto AddTechnicalDto

schema属性说明

AddTechnicalDto

参数名称 说明 in 是否必须 类型 schema
course_ids 课程id集 body false array
other 备注 body false string
parent_id 父级id body false string
technical_code 技能等级 body true string
technical_sequence 技能序列 body true string
user_ids 用户id集 body false array

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

技能序列及技能列表

接口说明:

接口地址:/technical/sequence

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
technical_id 当前技能id query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

编辑技能

接口说明:

接口地址:/technical/update

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "id": "",
    "other": "",
    "parent_id": "",
    "technical_code": "",
    "technical_sequence": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
technical 技能信息 body true UpdateTechnicalDto UpdateTechnicalDto

schema属性说明

UpdateTechnicalDto

参数名称 说明 in 是否必须 类型 schema
id 技能id body true string
other 备注 body false string
parent_id 父级id body false string
technical_code 技能等级 body true string
technical_sequence 技能序列 body true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

获取技能关联用户

接口说明:

接口地址:/technical/user/{id}

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
id 当前技能id path true string
keyword 关键字 query false string
page_num 当前页数 query false integer
page_size 每页数量 query false integer

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {
        "count": 0,
        "data": [
            {
                "account": "",
                "email": "",
                "id": "",
                "mobile": "",
                "onboarding_time": "",
                "organize_name": "",
                "position": "",
                "role": [],
                "sex": "",
                "superior_name": "",
                "username": ""
            }
        ],
        "pageCount": 0,
        "pageNum": 0,
        "pageSize": 0
    }
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload PageBody«List«TechnicalUserVo»» PageBody«List«TechnicalUserVo»»

schema属性说明

PageBody«List«TechnicalUserVo»»

参数名称 说明 类型 schema
count 总共有多少条数据 int64
data 数据列表 array TechnicalUserVo
pageCount 总共有多少页 int64
pageNum 当前第几页 int32
pageSize 每页条数 int32

TechnicalUserVo

参数名称 说明 类型 schema
account string
email string
id string
mobile string
onboarding_time string
organize_name string
position string
role array
sex string
superior_name string
username string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«PageBody«List«TechnicalUserVo»»»
401 Unauthorized
403 Forbidden
404 Not Found

文档管理及文档类型管理

新建文档

接口说明:

接口地址:/doc/add

请求方式POST

consumes:["multipart/form-data"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
asset_type 资产类型 query false string
binding 是否绑定资产 query true boolean
doc_code 文档编号 query true string
doc_desc 文档描述 query false string
doc_name 文档名称 query true string
doc_type_id 文档类型ID query true string
equipment_code 设备编号 query false string
equipment_type 设备类型 query false string
file 附件 formData false file
version 版本 query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

新增文档管理类型

接口说明:

接口地址:/doc/add/type

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
parent_id 父级类型ID query false string
type_name 类型名称 query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

删除文档

接口说明:

接口地址:/doc/delete

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
doc_ids 文档ID集 query true array string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

获取附件minio下载地址

接口说明:

接口地址:/doc/downloadurl

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
doc_id 文档ID query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": ""
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«string»
401 Unauthorized
403 Forbidden
404 Not Found

第三方接口:设备编号

接口说明:

接口地址:/doc/equipment/code

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
manufacturer manufacturer query false string
model model query false string
typeName typeName query false string

响应数据:

响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

第三方接口:模具

接口说明:

接口地址:/doc/equipment/mold

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
queryCriteria queryCriteria query false string

响应数据:

响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

第三方接口:设备类型

接口说明:

接口地址:/doc/equipment/type

请求方式GET

consumes:``

produces:["*/*"]

请求参数: 暂无

响应数据:

响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

历史版本

接口说明:

接口地址:/doc/history

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
doc_id 文档id query true string
page_num 当前页数 query false integer
page_size 每页数量 query false integer

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {
        "count": 0,
        "data": [
            {
                "doc_id": "",
                "file_id": "",
                "file_name": "",
                "preview": true,
                "update_time": "",
                "version": ""
            }
        ],
        "pageCount": 0,
        "pageNum": 0,
        "pageSize": 0
    }
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload PageBody«List«DocumentHistoryVersionVo»» PageBody«List«DocumentHistoryVersionVo»»

schema属性说明

PageBody«List«DocumentHistoryVersionVo»»

参数名称 说明 类型 schema
count 总共有多少条数据 int64
data 数据列表 array DocumentHistoryVersionVo
pageCount 总共有多少页 int64
pageNum 当前第几页 int32
pageSize 每页条数 int32

DocumentHistoryVersionVo

参数名称 说明 类型 schema
doc_id string
file_id string
file_name string
preview boolean
update_time string
version string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«PageBody«List«DocumentHistoryVersionVo»»»
401 Unauthorized
403 Forbidden
404 Not Found

文档列表

接口说明:

接口地址:/doc/list

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "key_word": "",
    "page_num": 0,
    "page_size": 0,
    "type_ids": []
}

请求参数

参数名称 说明 in 是否必须 类型 schema
param 文档编号 body true DocumentListParam DocumentListParam

schema属性说明

DocumentListParam

参数名称 说明 in 是否必须 类型 schema
key_word 关键字 body false string
page_num 页码 body false int32
page_size 每页显示数 body false int32
type_ids 每页显示数 body false array

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {
        "count": 0,
        "data": [
            {
                "assetType": "",
                "binding": true,
                "docCode": "",
                "docDesc": "",
                "docId": "",
                "docName": "",
                "equipmentCode": "",
                "equipmentType": "",
                "fileId": "",
                "fileName": "",
                "preview": true,
                "typeId": "",
                "typeName": "",
                "version": ""
            }
        ],
        "pageCount": 0,
        "pageNum": 0,
        "pageSize": 0
    }
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload PageBody«List«DocumentListVo»» PageBody«List«DocumentListVo»»

schema属性说明

PageBody«List«DocumentListVo»»

参数名称 说明 类型 schema
count 总共有多少条数据 int64
data 数据列表 array DocumentListVo
pageCount 总共有多少页 int64
pageNum 当前第几页 int32
pageSize 每页条数 int32

DocumentListVo

参数名称 说明 类型 schema
assetType string
binding boolean
docCode string
docDesc string
docId string
docName string
equipmentCode string
equipmentType string
fileId string
fileName string
preview boolean
typeId string
typeName string
version string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«PageBody«List«DocumentListVo»»»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

设置主版本

接口说明:

接口地址:/doc/mainversion

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
doc_id 文档id query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

上传版本

接口说明:

接口地址:/doc/newversion

请求方式POST

consumes:["multipart/form-data"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
doc_desc 文档描述 query false string
doc_id 文档ID query true string
file 附件 formData false file
version 版本 query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": ""
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«string»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

文件预览

接口说明:

接口地址:/doc/preview

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
doc_id 文档ID query true string

响应数据:

响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

删除文档类型

接口说明:

接口地址:/doc/type/delete

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
type_ids 类型ID集合 query true array string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

获取文档类型树结构

接口说明:

接口地址:/doc/type/tree

请求方式GET

consumes:``

produces:["*/*"]

请求参数: 暂无

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": [
        {
            "parent_id": "",
            "type_id": "",
            "type_name": ""
        }
    ]
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload array DocumentTypeTreeVo

schema属性说明

DocumentTypeTreeVo

参数名称 说明 类型 schema
parent_id string
type_id string
type_name string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«List«DocumentTypeTreeVo»»
401 Unauthorized
403 Forbidden
404 Not Found

编辑文档

接口说明:

接口地址:/doc/update

请求方式POST

consumes:["multipart/form-data"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
asset_type 资产类型 query false string
binding 是否绑定资产 query true boolean
doc_desc 文档描述 query false string
doc_id 文档ID query true string
doc_name 文档名称 query true string
doc_type_id 文档类型ID query true string
equipment_code 设备编号 query false string
equipment_type 设备类型 query false string
file 附件 formData false file
file_id 原文件ID query false string
version 版本 query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

编辑文档类型

接口说明:

接口地址:/doc/update/type

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
parent_id 父级类型ID query true string
type_id 类型ID query true string
type_name 类型名称 query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

权限管控

新增权限节点

接口说明:

接口地址:/auth/add/point

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "appId": "",
    "other": "",
    "pointId": "",
    "pointName": "",
    "pointParentId": "",
    "resourceId": "",
    "resourceName": "",
    "status": 0
}

请求参数

参数名称 说明 in 是否必须 类型 schema
pointParamVo 节点参数信息 body false 节点参数信息 节点参数信息

schema属性说明

节点参数信息

参数名称 说明 in 是否必须 类型 schema
appId 应用ID body false string
other 资源说明 body false string
pointId 节点ID body false string
pointName 节点名称 body false string
pointParentId 父节点ID body false string
resourceId 资源ID body false string
resourceName 资源名称 body false string
status 是否可用:0(可用)/1(禁用) body false int32

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

查询所有节点列表

接口说明:

接口地址:/auth/all/point/list

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
appId 应用ID query true string
pointId 节点ID query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

获取可管控权限应用列表

接口说明:

接口地址:/auth/app/list

请求方式GET

consumes:``

produces:["*/*"]

请求参数: 暂无

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

权限节点资源导出

接口说明:

接口地址:/auth/auth/download

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
appId 应用ID query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

权限节点资源导入

接口说明:

接口地址:/auth/auth/upload

请求方式POST

consumes:["multipart/form-data"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
appId 应用ID query false string
file file formData true file

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

用户/角色 权限分配

接口说明:

接口地址:/auth/distribution

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
appId 应用ID query false string
resourceId 资源ID:多个用英文逗号隔开 query true string
roleId 角色ID query false string
userId 用户ID query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

权限节点资源导入模板下载

接口说明:

接口地址:/auth/download/template

请求方式GET

consumes:``

produces:["*/*"]

请求参数: 暂无

响应数据:

响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

编辑节点信息

接口说明:

接口地址:/auth/edit/point

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "appId": "",
    "other": "",
    "pointId": "",
    "pointName": "",
    "pointParentId": "",
    "resourceId": "",
    "resourceName": "",
    "status": 0
}

请求参数

参数名称 说明 in 是否必须 类型 schema
pointParamVo 节点参数信息 body false 节点参数信息 节点参数信息

schema属性说明

节点参数信息

参数名称 说明 in 是否必须 类型 schema
appId 应用ID body false string
other 资源说明 body false string
pointId 节点ID body false string
pointName 节点名称 body false string
pointParentId 父节点ID body false string
resourceId 资源ID body false string
resourceName 资源名称 body false string
status 是否可用:0(可用)/1(禁用) body false int32

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

启用/禁用节点

接口说明:

接口地址:/auth/enable/point

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
appId 应用ID query true string
pointId 节点ID query true string
status 节点状态 query true integer

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

查询节点列表

接口说明:

接口地址:/auth/point/list

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
appId 应用ID query true string
pointId 节点ID query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

删除节点

接口说明:

接口地址:/auth/remove/point

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
appId 应用ID query true string
pointId 节点ID query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

查询指定应用下用户/角色权限详情

接口说明:

接口地址:/auth/resource/detail

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
appId 应用ID query true string
roleId 角色ID query false string
userId 用户ID query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

查看当前权限下 用户/角色 列表

接口说明:

接口地址:/auth/resource/distribution/list

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
pageNum 页码 query false integer
pageSize 每页显示数 query false integer
resourceId 权限ID query true string
search 查询条件 query false string
tag 条件标识:0->用户/1->角色 query true integer

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

取消用户/角色权限

接口说明:

接口地址:/auth/user/invalid

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
pointId 权限ID query true string
roleIds 角色ID:多个用英文逗号隔开 query false string
userIds 用户ID:多个用英文逗号隔开 query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

查看用户权限列表

接口说明:

接口地址:/auth/user/list

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
pageNum 页码 query false integer
pageSize 每页显示数 query false integer
resourceName 权限名称 query false string
userId 用户ID query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

消息管理

修改读状态

接口说明:

接口地址:/message/edit

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
ids 消息Id:多个用英文逗号隔开 query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

历史消息列表

接口说明:

接口地址:/message/history/list

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
endDate 查询结束时间 query false string
pageNum 页码 query false integer
pageSize 每页显示数 query false integer
search 消息内容 query false string
startDate 查询开始时间 query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

查询消息通知列表/查询代办事项

接口说明:

接口地址:/message/list

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
endDate 查询结束时间 query false string
messageType 消息类型:normal/todo query true string
pageNum 页码 query true integer
pageSize 每页显示数 query true integer
search 消息内容 query false string
startDate 查询开始时间 query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

消息重发

接口说明:

接口地址:/message/re/send

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
sendIds 消息发送Id:多个用英文逗号隔开 query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

recivetest

接口说明:

接口地址:/message/recivetest

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
jobnum jobnum query false string

响应数据:

响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

删除消息通知或代办事项

接口说明:

接口地址:/message/remove

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
ids 消息Id:多个用英文逗号隔开 query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

RabbitMq-消息队列-消息推送

接口说明:

接口地址:/message/send

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "content": "",
    "from": "",
    "message": "",
    "messageType": "",
    "msgStatus": 0,
    "recipient": "",
    "sending": "",
    "subject": "",
    "time": "",
    "todoId": "",
    "url": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
mailSubjectInfoVo 消息内容 body false MailSubjectInfoVo MailSubjectInfoVo

schema属性说明

MailSubjectInfoVo

参数名称 说明 in 是否必须 类型 schema
content 消息内容 body false string
from 发送方 body false string
message json字符串,选填 body false string
messageType 消息类型:normal(普通消息)/todo(待办事项) body false string
msgStatus 消息状态-当消息类型为todo时必填 body false int32
recipient 接收方:工号 body false string
sending 发送途径:app,mail,wechat body false string
subject 消息标题 body false string
time 时间,必填 body false string
todoId 待办事项ID(UUID)-当消息类型为todo时必填 body false string
url 地址链接 body false string

响应数据:

响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

RabbitMq-消息队列-消息状态推送

接口说明:

接口地址:/message/send/status

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

[
    {
        "status": 0,
        "todoId": ""
    }
]

请求参数

参数名称 说明 in 是否必须 类型 schema
todoVos 消息内容 body false array TodoVo

schema属性说明

TodoVo

参数名称 说明 in 是否必须 类型 schema
status body false int32
todoId body false string

响应数据:

响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

rqsendtest

接口说明:

接口地址:/message/sendtest

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
jobnum jobnum query false string
message message query false string

响应数据:

响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

查询未读消息数

接口说明:

接口地址:/message/unread

请求方式GET

consumes:``

produces:["*/*"]

请求参数: 暂无

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {
        "m1": 0,
        "m2": 0
    }
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload UnreadVo UnreadVo

schema属性说明

UnreadVo

参数名称 说明 类型 schema
m1 消息通知 int32
m2 代办事项 int32

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«UnreadVo»
401 Unauthorized
403 Forbidden
404 Not Found

组织管理

添加组织

接口说明:

接口地址:/organize/add

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "account": "",
    "email": "",
    "organizeId": "",
    "organizeName": "",
    "organizeParentId": "",
    "other": "",
    "ownerName": "",
    "phone": "",
    "status": 0,
    "userId": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
organizeParam 组织信息 body true 组织参数信息 组织参数信息

schema属性说明

组织参数信息

参数名称 说明 in 是否必须 类型 schema
account 工号 body false string
email 邮箱 body false string
organizeId 组织ID body false string
organizeName 组织名称 body true string
organizeParentId 上级组织Id body true string
other 备注 body false string
ownerName 组织拥有者 body false string
phone 手机号码 body false string
status 是否可用:0(可用)/1(禁用) body false int32
userId 用户Id body false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

添加用户组织

接口说明:

接口地址:/organize/add/user/organizes

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
organizeIds 组织id query false string
userIds 用户ID:多个用英文逗号隔开 query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

添加组织用户

接口说明:

接口地址:/organize/add/users

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
organizeId 组织id query true string
userId 用户ID:多个用英文逗号隔开 query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

删除组织

接口说明:

接口地址:/organize/delete

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
ids 组织id,多个用英文逗号隔开 query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

移除组织用户

接口说明:

接口地址:/organize/delete/users

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
organizeId 组织id query true string
userId 用户ID:多个用英文逗号隔开 query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

禁用组织

接口说明:

接口地址:/organize/disable

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
ids 组织id,多个用英文逗号隔开 query true string
status 状态 query true integer

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

编辑组织

接口说明:

接口地址:/organize/edit

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "account": "",
    "email": "",
    "organizeId": "",
    "organizeName": "",
    "organizeParentId": "",
    "other": "",
    "ownerName": "",
    "phone": "",
    "status": 0,
    "userId": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
organizeParam 组织信息 body true 组织参数信息 组织参数信息

schema属性说明

组织参数信息

参数名称 说明 in 是否必须 类型 schema
account 工号 body false string
email 邮箱 body false string
organizeId 组织ID body false string
organizeName 组织名称 body true string
organizeParentId 上级组织Id body true string
other 备注 body false string
ownerName 组织拥有者 body false string
phone 手机号码 body false string
status 是否可用:0(可用)/1(禁用) body false int32
userId 用户Id body false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

获取指定组织信息

接口说明:

接口地址:/organize/info

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
organizeId 组织Id query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {
        "account": "",
        "count": 0,
        "email": "",
        "id": "",
        "organizeName": "",
        "organizeParent": "",
        "other": "",
        "phone": "",
        "status": 0,
        "userId": "",
        "username": ""
    }
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload OrganizeDetailVo OrganizeDetailVo

schema属性说明

OrganizeDetailVo

参数名称 说明 类型 schema
account 负责人账号 string
count 组织人数 int32
email 负责人邮箱 string
id 组织ID string
organizeName 组织名称 string
organizeParent 上级组织 string
other 备注 string
phone 负责人电话 string
status 是否可用:0(可用)/1(禁用) int32
userId 用户Id string
username 负责人名称 string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«OrganizeDetailVo»
401 Unauthorized
403 Forbidden
404 Not Found

根据组织ID获取信息

接口说明:

接口地址:/organize/info/id

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
id 组织id query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {
        "account": "",
        "count": 0,
        "email": "",
        "id": "",
        "organizeName": "",
        "organizeParent": "",
        "other": "",
        "phone": "",
        "status": 0,
        "userId": "",
        "username": ""
    }
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload OrganizeDetailVo OrganizeDetailVo

schema属性说明

OrganizeDetailVo

参数名称 说明 类型 schema
account 负责人账号 string
count 组织人数 int32
email 负责人邮箱 string
id 组织ID string
organizeName 组织名称 string
organizeParent 上级组织 string
other 备注 string
phone 负责人电话 string
status 是否可用:0(可用)/1(禁用) int32
userId 用户Id string
username 负责人名称 string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«OrganizeDetailVo»
401 Unauthorized
403 Forbidden
404 Not Found

获取上级组织列表

接口说明:

接口地址:/organize/list

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
organizeName 组织名称 query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": [
        {
            "id": "",
            "organizeName": "",
            "organizeParent": ""
        }
    ]
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload array 组织信息

schema属性说明

组织信息

参数名称 说明 类型 schema
id 组织ID string
organizeName 组织名称 string
organizeParent 上级组织 string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«List«组织信息»»
401 Unauthorized
403 Forbidden
404 Not Found

获取组织列表

接口说明:

接口地址:/organize/list/info

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
organizeName 组织名称 query false string
owner 组织负责人 query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": [
        {
            "account": "",
            "count": 0,
            "email": "",
            "id": "",
            "organizeName": "",
            "organizeParent": "",
            "other": "",
            "phone": "",
            "status": 0,
            "userId": "",
            "username": ""
        }
    ]
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload array OrganizeDetailVo

schema属性说明

OrganizeDetailVo

参数名称 说明 类型 schema
account 负责人账号 string
count 组织人数 int32
email 负责人邮箱 string
id 组织ID string
organizeName 组织名称 string
organizeParent 上级组织 string
other 备注 string
phone 负责人电话 string
status 是否可用:0(可用)/1(禁用) int32
userId 用户Id string
username 负责人名称 string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«List«OrganizeDetailVo»»
401 Unauthorized
403 Forbidden
404 Not Found

菜单管理

获取应用列表

接口说明:

接口地址:/menu/app/list

请求方式GET

consumes:``

produces:["*/*"]

请求参数: 暂无

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

获取菜单信息列表

接口说明:

接口地址:/menu/info

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
appId 应用id query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

获取系统菜单列表

接口说明:

接口地址:/menu/sys/info

请求方式GET

consumes:``

produces:["*/*"]

请求参数: 暂无

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

角色管理

添加角色

接口说明:

接口地址:/role/add

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
roleName 角色名称 query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

添加角色用户

接口说明:

接口地址:/role/add/role/user

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
account 用户Id:多个用英文逗号隔开 query true string
roleId 角色id query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

添加用户角色

接口说明:

接口地址:/role/add/user/roles

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
roleIds 角色Id:多个用英文逗号隔开 query false string
userIds 用户id:多个用英文逗号隔开 query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

删除角色

接口说明:

接口地址:/role/delete

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
roleId 角色id query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

删除角色用户

接口说明:

接口地址:/role/delete/role/user

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
roleId 角色id query true string
userId 用户ID:多个用英文逗号隔开 query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

编辑角色/角色状态

接口说明:

接口地址:/role/edit

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
roleId 角色id query true string
roleName 角色名称 query false string
status 角色状态 query false integer

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

获取指定角色

接口说明:

接口地址:/role/role/info

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
roleId 角色Id query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {
        "count": 0,
        "id": "",
        "index": 0,
        "isEdit": 0,
        "roleName": "",
        "status": 0
    }
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload RoleVo RoleVo

schema属性说明

RoleVo

参数名称 说明 类型 schema
count 用户数量 int32
id id string
index 序号 int32
isEdit 状态:0为可编辑,1为不可编辑 int32
roleName 角色名称 string
status 状态:0为正常,1为禁用 int32

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«RoleVo»
401 Unauthorized
403 Forbidden
404 Not Found

获取角色列表

接口说明:

接口地址:/role/role/list

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
account 姓名或工号 query false string
roleName 角色名称 query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": [
        {
            "count": 0,
            "id": "",
            "index": 0,
            "isEdit": 0,
            "roleName": "",
            "status": 0
        }
    ]
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload array RoleVo

schema属性说明

RoleVo

参数名称 说明 类型 schema
count 用户数量 int32
id id string
index 序号 int32
isEdit 状态:0为可编辑,1为不可编辑 int32
roleName 角色名称 string
status 状态:0为正常,1为禁用 int32

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«List«RoleVo»»
401 Unauthorized
403 Forbidden
404 Not Found

辅助接口

获取用户列表

接口说明:

接口地址:/assist/account/list

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
account 工号/姓名 query false string
roleId 角色ID query false string
select 查询方式:0为全部查询;1为角色用户查询;2非角色用户查询; query false integer
userId 当前用户id query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": [
        {
            "account": "",
            "domain": "",
            "email": "",
            "id": "",
            "name": "",
            "organizeId": "",
            "parentId": "",
            "phone": ""
        }
    ]
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload array CarrierVo

schema属性说明

CarrierVo

参数名称 说明 类型 schema
account 用户工号 string
domain 厂域 string
email 电子邮箱 string
id id string
name 名称 string
organizeId 组织id string
parentId 父Id string
phone 联系电话 string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«List«CarrierVo»»
401 Unauthorized
403 Forbidden
404 Not Found

获取组织列表

接口说明:

接口地址:/assist/organize/list

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
organize 组织名称 query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": [
        {
            "account": "",
            "domain": "",
            "email": "",
            "id": "",
            "name": "",
            "organizeId": "",
            "parentId": "",
            "phone": ""
        }
    ]
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload array CarrierVo

schema属性说明

CarrierVo

参数名称 说明 类型 schema
account 用户工号 string
domain 厂域 string
email 电子邮箱 string
id id string
name 名称 string
organizeId 组织id string
parentId 父Id string
phone 联系电话 string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«List«CarrierVo»»
401 Unauthorized
403 Forbidden
404 Not Found

获取组织用户列表

接口说明:

接口地址:/assist/organize/user/list

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
organizeId 组织ID query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {
        "noOrganizeUsers": [
            {
                "account": "",
                "userId": "",
                "username": ""
            }
        ],
        "organizeUsers": [
            {
                "account": "",
                "userId": "",
                "username": ""
            }
        ]
    }
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload 组织用户信息 组织用户信息

schema属性说明

组织用户信息

参数名称 说明 类型 schema
noOrganizeUsers 没组织用户列表 array UserVo
organizeUsers 组织用户列表 array UserVo

UserVo

参数名称 说明 类型 schema
account 用户账户 string
userId 用户ID string
username 用户名称 string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«组织用户信息»
401 Unauthorized
403 Forbidden
404 Not Found

获取角色列表

接口说明:

接口地址:/assist/role/list

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
name 角色名称 query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": [
        {
            "account": "",
            "domain": "",
            "email": "",
            "id": "",
            "name": "",
            "organizeId": "",
            "parentId": "",
            "phone": ""
        }
    ]
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload array CarrierVo

schema属性说明

CarrierVo

参数名称 说明 类型 schema
account 用户工号 string
domain 厂域 string
email 电子邮箱 string
id id string
name 名称 string
organizeId 组织id string
parentId 父Id string
phone 联系电话 string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«List«CarrierVo»»
401 Unauthorized
403 Forbidden
404 Not Found

获取技能等级列表

接口说明:

接口地址:/assist/technical/list

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
name 技能名称 query false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": [
        {
            "account": "",
            "domain": "",
            "email": "",
            "id": "",
            "name": "",
            "organizeId": "",
            "parentId": "",
            "phone": ""
        }
    ]
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload array CarrierVo

schema属性说明

CarrierVo

参数名称 说明 类型 schema
account 用户工号 string
domain 厂域 string
email 电子邮箱 string
id id string
name 名称 string
organizeId 组织id string
parentId 父Id string
phone 联系电话 string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«List«CarrierVo»»
401 Unauthorized
403 Forbidden
404 Not Found

用户快速网址删除

接口说明:

接口地址:/assist/user/website/delete

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
id id query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

用户快速网址查询

接口说明:

接口地址:/assist/user/website/list

请求方式GET

consumes:``

produces:["*/*"]

请求参数: 暂无

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": [
        {
            "createtime": "",
            "id": "",
            "updatetime": "",
            "userId": "",
            "websiteName": "",
            "websiteUrl": ""
        }
    ]
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload array UserFastWebSiteInfo

schema属性说明

UserFastWebSiteInfo

参数名称 说明 类型 schema
createtime date-time
id string
updatetime date-time
userId string
websiteName string
websiteUrl string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«List«UserFastWebSiteInfo»»
401 Unauthorized
403 Forbidden
404 Not Found

用户快速网址新增

接口说明:

接口地址:/assist/user/website/save

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "websiteName": "",
    "websiteUrl": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
data 用户快速网址信息 body true 添加用户快速网址 添加用户快速网址

schema属性说明

添加用户快速网址

参数名称 说明 in 是否必须 类型 schema
websiteName 网址名称 body false string
websiteUrl 网址 body false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

用户快速网址编辑

接口说明:

接口地址:/assist/user/website/update

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "id": "",
    "websiteName": "",
    "websiteUrl": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
data 用户快速网址信息 body true 编辑用户快速网址 编辑用户快速网址

schema属性说明

编辑用户快速网址

参数名称 说明 in 是否必须 类型 schema
id id body false string
websiteName 网址名称 body false string
websiteUrl 网址 body false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

项目课程管理

获取所有课程列表

接口说明:

接口地址:/project/allcorse

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
keyword 关键字 query false string
page_num 当前页数 query false integer
page_size 每页数量 query false integer

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {
        "count": 0,
        "data": [
            {
                "course_code": "",
                "course_name": "",
                "id": "",
                "project_code": "",
                "project_name": ""
            }
        ],
        "pageCount": 0,
        "pageNum": 0,
        "pageSize": 0
    }
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload PageBody«List«CourseProjectInfoVo»» PageBody«List«CourseProjectInfoVo»»

schema属性说明

PageBody«List«CourseProjectInfoVo»»

参数名称 说明 类型 schema
count 总共有多少条数据 int64
data 数据列表 array CourseProjectInfoVo
pageCount 总共有多少页 int64
pageNum 当前第几页 int32
pageSize 每页条数 int32

CourseProjectInfoVo

参数名称 说明 类型 schema
course_code string
course_name string
id string
project_code string
project_name string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«PageBody«List«CourseProjectInfoVo»»»
401 Unauthorized
403 Forbidden
404 Not Found

删除附件

接口说明:

接口地址:/project/course/annex/delete

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
file_ids 附件id query true array string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

附件下载

接口说明:

接口地址:/project/course/annex/download

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
file_id 附件id query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": ""
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«string»
401 Unauthorized
403 Forbidden
404 Not Found

附件历史版本

接口说明:

接口地址:/project/course/annex/history

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
file_id 附件id query true string
page_num 当前页数 query false integer
page_size 每页数量 query false integer

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {
        "count": 0,
        "data": [
            {
                "createTime": "",
                "file_name": "",
                "id": "",
                "preview": true,
                "status": "",
                "version": ""
            }
        ],
        "pageCount": 0,
        "pageNum": 0,
        "pageSize": 0
    }
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload PageBody«List«CourseAnnexInfoVo»» PageBody«List«CourseAnnexInfoVo»»

schema属性说明

PageBody«List«CourseAnnexInfoVo»»

参数名称 说明 类型 schema
count 总共有多少条数据 int64
data 数据列表 array CourseAnnexInfoVo
pageCount 总共有多少页 int64
pageNum 当前第几页 int32
pageSize 每页条数 int32

CourseAnnexInfoVo

参数名称 说明 类型 schema
createTime string
file_name string
id string
preview boolean
status string
version string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«PageBody«List«CourseAnnexInfoVo»»»
401 Unauthorized
403 Forbidden
404 Not Found

附件列表

接口说明:

接口地址:/project/course/annex/list

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
course_id 课程id query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": [
        {
            "createTime": "",
            "file_name": "",
            "id": "",
            "preview": true,
            "status": "",
            "version": ""
        }
    ]
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload array CourseAnnexInfoVo

schema属性说明

CourseAnnexInfoVo

参数名称 说明 类型 schema
createTime string
file_name string
id string
preview boolean
status string
version string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«List«CourseAnnexInfoVo»»
401 Unauthorized
403 Forbidden
404 Not Found

附件预览

接口说明:

接口地址:/project/course/annex/preview

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
file_id 附件id query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

上传附件

接口说明:

接口地址:/project/course/annex/upload

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
course_id 项目id query true string
files 附件集 formData true array file
version 项目版本 query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

删除课程

接口说明:

接口地址:/project/course/delete

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
course_ids 课程id query true array string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

课程列表

接口说明:

接口地址:/project/course/list

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
project_id 项目id query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": [
        {
            "ability_detail": "",
            "count": 0,
            "course_code": "",
            "course_name": "",
            "examine_details": "",
            "examine_duration": "",
            "id": "",
            "practice_duration": "",
            "training_duration": ""
        }
    ]
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload array 课程列表返回

schema属性说明

课程列表返回

参数名称 说明 类型 schema
ability_detail 能力要件 string
count 附件数量 int32
course_code 课程编号 string
course_name 课程名称 string
examine_details 考核内容 string
examine_duration 考核时长 string
id 课程id string
practice_duration 练习时长 string
training_duration 培训时长 string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«List«课程列表返回»»
401 Unauthorized
403 Forbidden
404 Not Found

新建课程

接口说明:

接口地址:/project/course/save

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "ability_detail": "",
    "course_code": "",
    "course_name": "",
    "examine_details": "",
    "examine_duration": "",
    "practice_duration": "",
    "project_id": "",
    "training_duration": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
course 课程信息 body true 新建课程 新建课程

schema属性说明

新建课程

参数名称 说明 in 是否必须 类型 schema
ability_detail 能力要件 body false string
course_code 课程编号 body true string
course_name 课程名称 body true string
examine_details 考核内容 body false string
examine_duration 考核时长 body false string
practice_duration 练习时长 body false string
project_id 项目id body true string
training_duration 培训时长 body false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

编辑课程

接口说明:

接口地址:/project/course/update

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "ability_detail": "",
    "course_code": "",
    "course_id": "",
    "course_name": "",
    "examine_details": "",
    "examine_duration": "",
    "practice_duration": "",
    "training_duration": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
course 课程信息 body true 编辑课程 编辑课程

schema属性说明

编辑课程

参数名称 说明 in 是否必须 类型 schema
ability_detail 能力要件 body false string
course_code 课程编号 body true string
course_id 课程id body true string
course_name 课程名称 body true string
examine_details 考核内容 body false string
examine_duration 考核时长 body false string
practice_duration 练习时长 body false string
training_duration 培训时长 body false string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

删除项目

接口说明:

接口地址:/project/delete

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
project_ids 项目id query true array string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

培训项目列表

接口说明:

接口地址:/project/list

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
keyword 关键字 query false string
page_num 当前页数 query false integer
page_size 每页数量 query false integer

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {
        "count": 0,
        "data": [
            {
                "count": 0,
                "id": "",
                "project_code": "",
                "project_desc": "",
                "project_name": ""
            }
        ],
        "pageCount": 0,
        "pageNum": 0,
        "pageSize": 0
    }
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload PageBody«List«项目列表返回»» PageBody«List«项目列表返回»»

schema属性说明

PageBody«List«项目列表返回»»

参数名称 说明 类型 schema
count 总共有多少条数据 int64
data 数据列表 array 项目列表返回
pageCount 总共有多少页 int64
pageNum 当前第几页 int32
pageSize 每页条数 int32

项目列表返回

参数名称 说明 类型 schema
count 课程数量 int32
id 项目id string
project_code 项目编号 string
project_desc 项目描述 string
project_name 项目名称 string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«PageBody«List«项目列表返回»»»
401 Unauthorized
403 Forbidden
404 Not Found

设置主版本

接口说明:

接口地址:/project/mainversion

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
file_id 附件id query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
401 Unauthorized
403 Forbidden
404 Not Found

上传附件版本

接口说明:

接口地址:/project/newversion

请求方式POST

consumes:["multipart/form-data"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
file 附件 formData false file
file_id 附件ID query true string
version 版本 query true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": ""
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload string

响应状态码说明:

状态码 说明 schema
200 OK ResultBody«string»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

新建项目

接口说明:

接口地址:/project/save

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "project_code": "",
    "project_desc": "",
    "project_name": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
project 项目信息 body true 新建项目 新建项目

schema属性说明

新建项目

参数名称 说明 in 是否必须 类型 schema
project_code 项目编号 body true string
project_desc 项目描述 body false string
project_name 项目名称 body true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

编辑项目

接口说明:

接口地址:/project/update

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "project_code": "",
    "project_desc": "",
    "project_id": "",
    "project_name": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
project 项目信息 body true 编辑项目 编辑项目

schema属性说明

编辑项目

参数名称 说明 in 是否必须 类型 schema
project_code 项目编号 body true string
project_desc 项目描述 body false string
project_id 项目id body true string
project_name 项目名称 body true string

响应数据:

{
    "code": 0,
    "errmsg": "",
    "payload": {}
}

响应参数说明:

参数名称 说明 类型 schema
code int32
errmsg string
payload object

响应状态码说明:

状态码 说明 schema
200 OK ResultBody
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

页面列表

ITEM_HTML