Skip to content

获取周期任务(全部用户)

批量获取周期下所有用户的任务信息。支持传入任务分类、任务截止时间参数删选周期内任务数据。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/performance/v1/stage_tasks/find_by_page
HTTP MethodPOST
接口频率限制20 次/分钟
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可performance:performance 管理绩效数据 performance:performance:readonly 查看绩效数据
字段权限要求> Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称类型必填描述
Authorizationstringtenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token
Content-Typestring固定值:"application/json; charset=utf-8"

查询参数

名称类型必填描述
user_id_typestring用户 ID 类型
示例值:open_id
可选值有
- open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多:如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多:如何获取 Union ID? - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多:如何获取 User ID? - people_admin_id: 以people_admin_id来识别用户
默认值open_id
当值为 user_id,字段权限要求contact:user.employee_id:readonly 获取用户 user ID

请求体

名称类型必填描述
semester_idstring周期 ID,可通过获取周期接口获取
示例值:"7033710017401751071"
task_option_listsint\[\]任务分类,填写则获取指定分类的任务
可选项有: - 1:待完成 - 2:已完成 - 3:已逾期(仅当租户设置不允许逾期提交时才有此分类)
示例值:[1, 2, 3]
数据校验规则
- 最大长度:3
after_timestring任务截止时间最小值,毫秒时间戳,填写则查询在此时间之后截止的任务
示例值:"1630425599999"
before_timestring任务截止时间最大值,毫秒时间戳,填写则查询在此时间之前截止的任务
示例值:"1630425599999"
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:"AQD9/Rn9eij9Pm39ED40/dk53s4Ebp882DYfFaPFbz00L4CMZJrqGdzNyc8BcZtDbwVUvRmQTvyMYicnGWrde9X56TgdBuS+JKiSIkdexPw="
page_sizeint分页大小
示例值:30
默认值20
数据校验规则
- 最大值:50

请求体示例

json
{
  "semester_id": "7235911950407352321",
  "task_option_lists": [1, 2, 3],
  "after_time": "1717142243000",
  "before_time": "1717142245000",
  "page_size": 30,
  "page_token": "84I9nKzkGJjwv1FrJ1sIveEE2ij7xnes6nhcmxNOXLaLLe52sFVu8S0NPxRFkMhLFCMutL9a6Eod7kzOqWQeu47R7NWiZEmBKJ93Asg5VZv1oJkrG318reCJlrljfaeR"
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ basesemester_base_info周期基本信息
    └ semester_idstring周期 ID,详情可查看获取周期
    └ semester_namei18n周期名称
      └ zh-CNstring周期中文名称
      └ en-USstring周期英文名称
    └ start_timestring周期开始时间,毫秒时间戳
    └ end_timestring周期结束时间,毫秒时间戳
  └ itemsstage_task\[\]周期任务
    └ user_idstring用户 ID,与入参 user_id_type 类型一致
    └ stage_num_listsstage_task_status_num\[\]各分类的任务数
      └ task_option_idint任务分类
可选值有
- 1: 待完成 - 2: 已完成 - 3: 已逾期(此分类仅在租户系统设置为不允许逾期提交时存在)
      └ stage_numint环节任务数量
    └ stage_task_info_listsstage_task_info\[\]环节任务信息
      └ stage_idstring环节 ID
      └ namei18n环节名称
        └ zh-CNstring环节中文名称
        └ en-USstring环节英文名称
      └ deadlinestring环节截止时间,毫秒时间戳
      └ need_todo_countint未完成的任务数量
      └ jump_urlstring处理任务的系统页面链接
      └ stage_task_statusstring环节任务状态
可选值有
- need_todo: 还有待完成的任务 - overdue: 剩余未完成的任务均已逾期 - all_done: 全部任务均已完成 - stage_pause: 环节被暂停
      └ task_option_idint任务分类
可选值有
- 1: 待完成 - 2: 已完成 - 3: 已逾期(此分类仅在租户系统设置为不允许逾期提交时存在)
  └ has_moreboolean是否还有更多项
  └ page_tokenstring分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token

响应体示例

json
{
    "code": 0,
    "data": {
        "base": {
            "end_time": "1748707140000",
            "semester_id": "7235911950407352321",
            "semester_name": {
                "en-US": "Demo Semester",
                "zh-CN": "示例周期"
            },
            "start_time": "1684684800000"
        },
        "items": [
            {
                "stage_num_lists": [
                    {
                        "task_option_id": 1,
                        "stage_num": 1
                    },
                    {
                        "task_option_id": 2,
                        "stage_num": 1
                    },
                    {
                        "task_option_id": 3,
                        "stage_num": 0
                    }
                ],
                "stage_task_info_lists": [
                    {
                        "deadline": "1717142244000",
                        "jump_url": "https://performance.feishu-pre.cn/perf/review/7235911950407352321/7235906557915987996/members",
                        "name": {
                            "en-US": "confirm_invitation",
                            "zh-CN": "360° 确认"
                        },
                        "need_todo_count": 10,
                        "stage_id": "7270346432875692033",
                        "stage_task_status": "need_todo",
                        "task_option_id": 1
                    },
                    {
                        "deadline": "1717142244000",
                        "jump_url": "https://performance.feishu-pre.cn/perf/review/7235911950407352321/7235906557916086300",
                        "name": {
                            "en-US": "pdt_manager_review",
                            "zh-CN": "pdt项目经理上级评估"
                        },
                        "need_todo_count": 2,
                        "stage_id": "7270346432875741185",
                        "stage_task_status": "all_done",
                        "task_option_id": 2
                    }
                ],
                "user_id": "bega29ca"
            }
        ]
    },
    "has_more": true,
    "page_token": "84I9nKzkGJjwv1FrJ1sIveEE2ij7xnes6nhcmxNOXLaLLe52sFVu8S0NPxRFkMhLFCMutL9a6Eod7kzOqWQeu47R7NWiZEmBKJ93Asg5VZv1oJkrG318reCJlrljfaeR",
    "msg": ""
}

错误码

HTTP状态码错误码描述排查建议
5001580101internal error请根据实际报错信息定位或咨询技术支持
4001580102param is invalid检查参数是否正确,例如类型,大小

更多错误码信息,参见通用错误码

内容来源:飞书开放平台 · 自动爬取整理