Macdown接口文档模板

样式:

 

macdown 代码:

#xxx接口文档
版本:

版本 | 日期      |操作人
--- |---|---
v1  | 2019-10-11|xx
##1、根据筛选条件获取工单列表
###1.1接口url
前缀/xxxx/xxxx
###1.2请求方式
GET
###1.3请求头

参数      |类型     |是否必传 |说明       | 示例     |
-------- |---------|--------|----------|---------|
token      | string  |是       |token    |V3       | 
###1.4参数说明

参数     |类型     |是否必传 |说明       | 示例     |
--------|---------|--------|----------|---------|
applyCode   | string  |否      |xxx    |2019100920240440258574|
emplid    | string  |否      |xxx    |D27704 | 
emplName    | string  |否      |xxx     |布 |   
ldap    | string  |否      |xxx     |aliceqixin|
deptId    | string  |否      |xxx     |105781|
deptName    | string  |否      |xxx     | 萨 |    
typeId    | integer  |否      |xxx     | 7 |
applyStatus    | integer  |否      |xxx    |0 |  
approvalStatus    | integer  |否      |xxx     |0 |
fileStatus    | integer  |否      |xxx     |0 | 
state    | integer  |否      |xxx     |0 | 

          
###1.5返回结果
```
{
    "data": [
        {
            "id": 9,
            "applyCode": "2019100920240440258574",
            "emplid": "D27704",
            "emplName": "xxx ",
            "deptId": "105781",
            "typeId": 7,
            "typeDesc": "其他用途",
            "description": "其他用途",
            "applyStatus": 1,
            "rejectReason": null,
            "auditTime": null,
            "updater": "aliceqixin",
            "approvalStatus": 1,
            "rejectDesc": null,
            "fileStatus": 1,
            "fileTime": "2019-10-10 16:13:31",
            "creator": "aliceqixin",
            "gmtCreate": "2019-10-09 20:24:04",
            "gmtUpdate": "2019-10-11 14:58:01",
            "state": 0,
            "emplWordCardPhotoDtoList": null,
            "hrbpName": null,
            "hrbpLdap": null,
            "hrbpLdaps": null,
            "hrbpEmail": null,
            "hrbpEmails": null,
            "managerId": null,
            "managerEmail": null
        },
     ],
    "currentPage": 1,
    "pageSize": 100,
    "totalPage": 1,
    "totalCount": 1
}
```
返回结果参数中字段说明:

参数     |类型     |说明       |
--------|---------|----------|
id   | integer  |id       | 
applyCode | string  |xxx   |
emplid    | string  |xxx |
emplName    | string |xxx   |    
typeId    | integer  |申请类型id    |
typeDesc| string  |申请类型描述    |
description| string   |用途描述  |  
applyStatus    | integer  |申请状态 0申请中  1申请通过待审核 2申请驳回   |
rejectReason| string  |申请驳回原因    |
approvalStatus    | integer   |流程审核状态,0审核中 1审核成功 2审核驳回  |
rejectDesc| string  |流程审核驳回描述    |
fileStatus    | integer    |文件状态    0未生成,1已生成 2失败|
state    | integer    |工单状态   工单状态 0进行中 1完成 2失败 | 
gmtCreate| string  |创建时间   |
updater| string  |最后更新人  |

 

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值