查询任务 - Teambition API

该接口用于根据条件查询任务。

请求参数说明 ：

根据任务 ID 查询：


参数	类型	是否必须	说明
taskId	string	是	任务 ID

根据父任务 ID 查询子任务：


参数	类型	是否必须	说明
parentTaskId	string	是	父任务 ID

或者根据组合条件查询：


参数	类型	是否必须	说明
userId	string	是	用户 ID
organizationId	string	是	要查任务的企业id
condition	string	是	查询条件，取值为：executor：查询用户执行的任务（默认值）creator：查询用户创建的任务participant：查询用户参与的任务
isDone	int	否	是否完成，默认查询所有未完成和已完成的任务
projectId	string	否	查询指定项目下的任务
pageToken	string	否	分页 token，首次获取数据时为空
pageSize	int	否	返回结果数量，默认 30，最大 1000

curl --location --request GET 'https://open.teambition.com/api/task/query' \ --header 'Authorization: Bearer <appAccessToken>' \ --header 'X-Tenant-Id: 50c32af35a87e6b2...' \ --header 'X-Tenant-Type: organization'

{ "code": 200, "errorMessage": "", "count": "50", "nextPageToken": "dd28c9aa-e056-4f57-9f6c-ed5c3b2d7200", "result": [ { "taskId": "5e141eaf7fd0daf8...", "projectId": "5e0d98527d161c00...", "templateId": "5e1421647fd0daf8...", "tasklistId": "5d5798a2d4268209...", "taskgroupId": "5d5798a2d4268209...", "content": "第一个任务", "executorId": "5a28e2036176bbde...", "statusId": "5e142164aef01b07...", "startDate": "2019-12-01T10:30:00Z", "dueDate": "2019-12-05T18:00:00Z", "note": "第一个任务", "priority": 0, "visible": "projectMembers", "parentTaskId": "", "ancestorIds": [], "participants": [ "5a28e2036176bbde..." ], "customfields": [ { "cfId": "5e11b2b7ed69f340...", "value": [ "abc" ] } ], "isDone": 0, "creatorId": "5a28e2036176bbde...", "created": "2019-12-01T10:30:00Z", "modifierId": "5a28e2036176bbde...", "updated": "2020-01-07T11:00:00Z" } ] }

请求参数

Query 参数

taskId

string

任务 ID

可选

parentTaskId

string

父任务 ID

可选

userId

string

要查任务的企业id

可选

condition

string

可选

查询条件，取值为： executor：查询用户执行的任务（默认值） creator：查询用户创建的任务 participant：查询用户参与的任务

isDone

string

可选

是否完成，默认查询所有未完成和已完成的任务

projectId

string

可选

查询指定项目下的任务

pageToken

string

可选

分页 token，首次获取数据时为空

pageSize

string

可选

返回结果数量，默认 30，最大 1000

Header 参数

Authorization

string

可选

默认值:

X-Tenant-Id

string

企业 ID

可选

默认值:

X-Tenant-Type

string

可选

默认值:

organization

返回响应

🟢200成功

application/json

Body

code

integer

必需

返回码，200 表示成功

errorMessage

string

必需

调用失败时的错误信息

count

string

接口返回的数据量

必需

nextPageToken

string

必需

下一页的分页 token

result

array[object (result) {24}]

必需

taskId

string

任务 ID

必需

projectId

string

项目 ID

必需

templateId

string

任务类型 ID

必需

tasklistId

string

任务列表 ID

必需

taskgroupId

string

任务分组 ID

必需

content

string

任务内容

必需

executorId

string

执行者的用户 ID

必需

statusId

string

工作流状态 ID

必需

sprintId

string

迭代 ID

必需

startDate

string

开始时间

必需

dueDate

string

截止时间

必需

accomplishDate

string

完成时间

必需

note

string

任务备注

必需

priority

integer

必需

优先级： 0：普通（默认值） 1：紧急 2：非常紧急

visible

string

必需

可见性： participants：任务参与者可见 projectMembers：项目成员可见（默认值）

parentTaskId

string

父任务 ID

必需

ancestorIds

array[string]

必需

所有祖先任务，ancestorIds[0] 为直接父任务，ancestorIds[1] 为父任务的父任务，以此类推

participants

array[string]

必需

参与者的用户 ID 列表

customfields

array[object (customfields) {2}]

自定义字段列表

必需

isDone

integer

是否完成

必需

creatorId

string

创建人的用户 ID

必需

created

string

任务创建时间

必需

modifierId

string

必需

最近一次执行更新操作的用户 ID

updated

string