Apps API · Tasks
Tasks: 8 个接口
GET /api/v1/issues/{issue_id}/tasks
List issue tasks
权限(scope): work:task:read · 调用方式: appToken · operationId: list-issue-tasks
Required app scope: work:task:read.
Returns tasks for an issue. Response wrapped in standard envelope.
参数
| 名字 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
issue_id |
path | string (uuid) | 是 | Issue UUID |
page |
query | integer (int32) | Page number (default: 1) | |
page_size |
query | integer (int32) | Items per page (default: 20, max: 100) | |
order_by |
query | string | Sort expression, e.g. created_at:desc | |
status |
query | string: pending, assigned, running, done, failed, cancelled |
Filter by status | |
include_archived |
query | boolean | Include tasks archived through project cascade |
回包
200OK —application/json·PageListResponseTaskItemBodydefaultError —application/problem+json·D8Error
POST /api/v1/projects/{project_id}/issues/{issue_id}/tasks
Create task
权限(scope): work:task:write · 调用方式: appToken · operationId: create-task
Required app scope: work:task:write.
Creates a task within an issue. Response wrapped in standard envelope.
参数
| 名字 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
project_id |
path | string (uuid) | 是 | Project UUID |
issue_id |
path | string (uuid) | 是 | Issue UUID |
请求体
application/json · CreateTaskRequestBody
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
assignee_id |
string (uuid) | Assignee member UUID | |
blueprint_step_id |
string (uuid) | Blueprint step UUID | |
depends_on |
array of string (uuid) | Task dependency UUIDs | |
description |
string | Task description | |
title |
string | 是 | Task title |
回包
200OK —application/json·DataResponseTaskItemBodydefaultError —application/problem+json·D8Error
GET /api/v1/tasks
List tasks
权限(scope): work:task:read · 调用方式: appToken · operationId: list-tasks
Required app scope: work:task:read.
Returns filtered tasks. Response wrapped in standard envelope.
参数
| 名字 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
page |
query | integer (int32) | Page number (default: 1) | |
page_size |
query | integer (int32) | Items per page (default: 20, max: 100) | |
order_by |
query | string | Sort expression, e.g. created_at:desc | |
project_id |
query | string (uuid) | Filter by project UUID | |
issue_id |
query | string (uuid) | Filter by issue UUID | |
status |
query | string: pending, assigned, running, done, failed, cancelled |
Filter by status | |
include_archived |
query | boolean | Include tasks archived through project cascade |
回包
200OK —application/json·PageListResponseTaskItemBodydefaultError —application/problem+json·D8Error
GET /api/v1/tasks/{task_id}
Get task
权限(scope): work:task:read · 调用方式: appToken · operationId: get-task
Required app scope: work:task:read.
Returns a task by ID. Response wrapped in standard envelope.
参数
| 名字 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
task_id |
path | string (uuid) | 是 | Task UUID |
回包
200OK —application/json·DataResponseTaskItemBodydefaultError —application/problem+json·D8Error
POST /api/v1/tasks/{task_id}/claim
Claim task
权限(scope): work:task:write · 调用方式: appToken · operationId: claim-task
Required app scope: work:task:write.
Assigns a task to the caller (pending → assigned). Does NOT start work or open an attempt — call start-task for that. Response wrapped in standard envelope.
参数
| 名字 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
task_id |
path | string (uuid) | 是 | Task UUID |
回包
200OK —application/json·DataResponseTaskItemBodydefaultError —application/problem+json·D8Error
POST /api/v1/tasks/{task_id}/reassign
Reassign task
权限(scope): work:task:write · 调用方式: appToken · operationId: reassign-task
Required app scope: work:task:write.
Reassigns a task to another member. Response wrapped in standard envelope.
参数
| 名字 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
task_id |
path | string (uuid) | 是 | Task UUID |
请求体
application/json · ReassignTaskRequestBody
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
new_assignee_id |
string (uuid) | 是 | New assignee member UUID |
回包
200OK —application/json·DataResponseTaskItemBodydefaultError —application/problem+json·D8Error
POST /api/v1/tasks/{task_id}/start
Start task
权限(scope): work:task:write · 调用方式: appToken · operationId: start-task
Required app scope: work:task:write.
Starts an assigned task (assigned → running) and opens an attempt. Dependency gate (depends_on all done) is enforced here. Response wrapped in standard envelope.
参数
| 名字 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
task_id |
path | string (uuid) | 是 | Task UUID |
回包
200OK —application/json·DataResponseStartTaskDataBodydefaultError —application/problem+json·D8Error
POST /api/v1/tasks/{task_id}/transition
Transition task
权限(scope): work:task:write · 调用方式: appToken · operationId: transition-task
Required app scope: work:task:write.
Transitions a task to a target status. Response wrapped in standard envelope.
参数
| 名字 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
task_id |
path | string (uuid) | 是 | Task UUID |
请求体
application/json · TransitionTaskRequestBody
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
target_status |
string: done, failed, cancelled |
是 | Terminal target task status |
回包
200OK —application/json·DataResponseTaskItemBodydefaultError —application/problem+json·D8Error
