2. 工作报表新扩展接口（版本5.0.0及之后）

简要描述：

工作报表新扩展接口

请求URL：

{JiraBaseUrl}/rest/shdsd-Timesheet/2/workReport/extension2

请求方式：

GET

参数：

参数名	参数名称	必选	类型	说明
queryType	查询类型	是	String	常规：convention 筛选器：filter
start	开始时间	是	String	开始日期，如“2020-01-01”
end	结束时间	是	String	结束日期，如“2020-01-02”
groupBy	层级	是	String	User简写“U”， Project简写“P”， Issue简写“I”， IssueType简写“T”， Epic 简写“E”， Version简写“V”， Module简写“CT”, Sprint简写“S”, 大写，按自上到下节点顺序组合，如“U,P,T,I,E,V,CT,S”
filterId	筛选器的值	否	String	当queryType选择【filter】时，筛选器的值不允许为空
project	项目	否	String	项目ID,多个用逗号分隔，如“项目id1,项目id2”
user	用户	否	String	用户key,多个用逗号分隔，如“用户key1,用户key2”
userGroup	用户组	否	String	用户组名称,多个用逗号分隔，如“用户组1，用户组2”
issueType	问题类型	否	String	问题类型ID,多个用逗号分隔，如“问题类型id1,问题类型id2“
epic	史诗	否	String	史诗key,多个用逗号分隔，如 “epicKey1,epicKey2”。注意：想要查询空(值为空)的情况参数为：“$NONE$”
version	版本	否	String	版本ID,多个用逗号分隔，如“版本id1,版本id2” 。注意：想要查询空(值为空)的情况参数为：“$NONE$”
module	模块	否	String	模块ID,多个用逗号分隔，如“模块id1,模块id2” 。注意：想要查询空(值为空)的情况参数为：“$NONE$”
sprint	冲刺	否	String	sprintID,多个用逗号分隔，如“sprintId1,sprintId2”。注意：想要查询空(值为空)的情况参数为：“$NONE$”
workType	工作类型	否	String	工作类型ID,多个用逗号分隔，如“工作类型id1,工作类型id2”。注意：想要查询空(值为空)的情况参数为：“$NONE$”
approvalStatus	审核状态	否	String	未提交“0”，待审核“1”，已审核“2”
extensionSetting	扩展参数	否	String	key: 压缩工时（E10001）,不包含休息日（E10002）,补充工时(E10003)，压缩/补充已审核日志（E10004） disable:0:开启 1：禁用 settingValue: 配置参数范例: [ {key: 'E10001', disable: 1, settingValue: 8}, {key: 'E10002', disable: 1}, {key: 'E10003', disable: 1, settingValue: 8}, {key: 'E10004', disable:1} ] 注意:压缩工时和补充工时如果同时使用则压缩工时和补充工时的settingValue需要一致
order	排序Key	否	String	userName 用户名称 userKey 用户Key userDisplayName 用户全名 projectName项目名称 projectKey 项目Key issueSummary 问题描述 issueKey 问题Key Logtime 日志工时 Plantime 计划工时默认值：userKey
sort	升降序	否	String	升序 Asc 降序 Desc 补充：默认值为Asc
everyday	每日分类	否	Boolean	true 时，根据每日进行数据分类，默认：false
approval	审核开关	否	Boolean	true时，统计时，增加审核的状态统计信息,默认：false

提醒：

当queryType值为“convention”时，【project,user,userGroup,issueType,epic,version,module,sprint,workType,approvalStatus】条件才有效。
当queryType值为“filter”时，filterId条件有效。

返回结果特殊字段说明：

logApproverUserName：日志审核人用户名，多个时以逗号分隔

logApproverDisPlayName：日志审核人全名，多个时以逗号分隔

logApprovalDate：日志审核时间戳，格式为 yyyy-MM-dd HH:mm:ss，多个时以逗号分隔，与审核人一一对应

planApproverUserName：计划审核人用户名，多个时以逗号分隔

planApproverDisPlayName：计划审核人全名，多个时以逗号分隔

planApprovalDate：计划审核时间戳，格式为 yyyy-MM-dd HH:mm:ss，多个时以逗号分隔，与审核人一一对应

接口中只返回已审核日志或计划的审核人用户名，审核人全名和审核时间

addAndCompressApprovedLog：压缩/补充已审核日志字段，当天开启该功能，并且同时开启压缩/补充时才生效，若不开启该功能，该字段值为0

请求URL示例：

http://localhost:2990/rest/shdsd-Timesheet/latest/workReport/extension2?queryType=convention&start=2023-01-01&end=2023-03-31&groupBy=U,P,I&extensionSetting=[{"key":"E10001","disable":0,"settingValue":8},{"key":"E10002","disable":0},{"key":"E10003","disable":0,"settingValue":8},{"key":"E10004","disable":0}]

返回示例：

返回结果可以根据选择的层级（groupBy）选择多个进行组装

根据用户统计

[
    {
        "userKey": "admin", ---用户Key
        "userName": "admin", ---用户名
        "displayName": "admin", ---全名
        "logTime": "1.0", — 日志工时
        "planTime": "1.0", ---计划工时
        "logApproverUserName": "admin", ---日志审核人用户名，多个时以逗号分隔
        "logApproverDisPlayName": "admin", ---日志审核人全名，多个时以逗号分隔
        "logApprovalDate": "2023-03-31 15:26:11", ---日志审核时间戳，格式为 yyyy-MM-dd HH:mm:ss，多个时以逗号分隔，与审核人一一对应
        "planApproverUserName": "admin", ---计划审核人用户名，多个时以逗号分隔
        "planApproverDisPlayName": "admin", ---计划审核人全名，多个时以逗号分隔
        "planApprovalDate": "2023-03-31 15:26:21", ---计划审核时间戳，格式为 yyyy-MM-dd HH:mm:ss，多个时以逗号分隔，与审核人一一对应
        "addAndCompressApprovedLog": "0.0" ---压缩/补充已审核日志字段
    }
]

根据项目统计

[
    {
        "projectKey": "TP", ---项目key
        "projectName": "TimeWise Project", ---项目名称
        "logTime": "1.0",
        "planTime": "1.0",
        "logApproverUserName": "admin",
        "logApproverDisPlayName": "admin",
        "logApprovalDate": "2023-03-31 15:26:11",
        "planApproverUserName": "admin",
        "planApproverDisPlayName": "admin",
        "planApprovalDate": "2023-03-31 15:26:21",
        "addAndCompressApprovedLog": "0.0"
    }
]

根据问题统计

[
    {
        "issueKey": "TP-1", ---问题类型Key
        "issueName": "任务1", ---问题类型名称
        "logTime": "1.0",
        "planTime": "1.0",
        "logApproverUserName": "admin",
        "logApproverDisPlayName": "admin",
        "logApprovalDate": "2023-03-31 15:26:11",
        "planApproverUserName": "admin",
        "planApproverDisPlayName": "admin",
        "planApprovalDate": "2023-03-31 15:26:21",
        "addAndCompressApprovedLog": "0.0"
    }
]

根据问题类型统计

[
    {
        "issueTypeKey": "10002", ---问题Key
        "issueTypeName": "任务", ---问题概要
        "logTime": "1.0",
        "planTime": "1.0",
        "logApproverUserName": "admin",
        "logApproverDisPlayName": "admin",
        "logApprovalDate": "2023-03-31 15:26:11",
        "planApproverUserName": "admin",
        "planApproverDisPlayName": "admin",
        "planApprovalDate": "2023-03-31 15:26:21",
        "addAndCompressApprovedLog": "0.0"
    }
]

根据Epic统计

[
    {
        "epicKey": "JKDXM-13", ---史诗Key,问题没有绑定Epic则返回”“
        "epicName": "史诗名称2", ---史诗名称，问题没有绑定EpicName则返回”无Epic“
        "logTime": "1.0",
        "planTime": "1.0",
        "logApproverUserName": "admin",
        "logApproverDisPlayName": "admin",
        "logApprovalDate": "2023-03-31 15:26:11",
        "planApproverUserName": "admin",
        "planApproverDisPlayName": "admin",
        "planApprovalDate": "2023-03-31 15:26:21",
        "addAndCompressApprovedLog": "0.0"
    }
]

根据版本统计

[
    {
        "versionName": "版本1", ---版本名称，问题没有绑定版本则返回”无版本“
        "logTime": "1.0",
        "planTime": "1.0",
        "logApproverUserName": "admin",
        "logApproverDisPlayName": "admin",
        "logApprovalDate": "2023-03-31 15:26:11",
        "planApproverUserName": "admin",
        "planApproverDisPlayName": "admin",
        "planApprovalDate": "2023-03-31 15:26:21",
        "addAndCompressApprovedLog": "0.0"
    }
]

根据模块统计

[
    {
        "moduleName": "模块1", ---模块名称，问题没有绑定模块则返回”无模块“
        "logTime": "1.0",
        "planTime": "1.0",
        "logApproverUserName": "admin",
        "logApproverDisPlayName": "admin",
        "logApprovalDate": "2023-03-31 15:26:11",
        "planApproverUserName": "admin",
        "planApproverDisPlayName": "admin",
        "planApprovalDate": "2023-03-31 15:26:21",
        "addAndCompressApprovedLog": "0.0"
    }
]

根据Sprint统计

[
    {
        "sprintName": "TP Sprint 1", ---sprint名称，问题没有绑定sprint则返回”无sprint“
        "logTime": "1.0",
        "planTime": "1.0",
        "logApproverUserName": "admin",
        "logApproverDisPlayName": "admin",
        "logApprovalDate": "2023-03-31 15:26:11",
        "planApproverUserName": "admin",
        "planApproverDisPlayName": "admin",
        "planApprovalDate": "2023-03-31 15:26:21",
        "addAndCompressApprovedLog": "0.0"
    }
]

空间快捷链接

页面树结构

简要描述：

请求URL：

请求方式：

参数：

请求URL示例：

返回示例：