创建一个工作项 - PingCodeRESTAPI

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Body 参数application/json

project_id

string

项目的id。

必需

type_id

string

必需

工作项类型的id。目前工作项类型分为6种固定类型和一些自定义类型。固定类型用于scrum和kanban类型的项目。固定类型包括：史诗、特性、故事、任务、缺陷和事务（类型枚举值依次为epic，feature，story，task，bug和issue）。自定义类型用于waterfall类型的项目。自定义类型则可以通过获取全部工作项类型列表获得，目前系统内置了5个自定义类型：需求、任务、缺陷、阶段和里程碑。

title

string

工作项的标题。

必需

description

string

工作项的描述。

可选

start_at

number

可选

工作项的开始时间。当工作项类型为里程碑时，该参数无效

end_at

number

工作项的截止时间。

可选

priority_id

string

可选

工作项优先级的id。

state_id

string

可选

工作项状态的id。工作项状态的id在设置时必须同时满足工作项类型的工作项状态方案和工作项状态流转的状态值才能成功完成设置。工作项状态方案可以通过获取工作项状态方案列表获取。工作项状态流转则可以通过获取状态方案中的工作项状态流转列表获取。

assignee_id

string

可选

工作项负责人的id。

parent_id

string

可选

工作项的父工作项的id。当工作项类型为epic和issue时，该参数无效。当项目类型为scrum，并且工作项类型为task时，该参数必填。特性的父工作项类型必须为史诗。用户故事的父工作项类型必须为特性。任务的父工作项类型必须为用户故事，项目类型为kanban时该字段可选。缺陷的父工作项类型必须为用户故事。

sprint_id

string

可选

所属迭代id。该字段只有项目类型为scrum时有效。

version_id

string

可选

所属发布的id。当项目类型为waterfall，或者工作项类型为epic、task和issue时，该参数无效。

board_id

string

可选

看板的id。该字段只有项目类型为kanban时有效。

entry_id

string

可选

看板栏的id。该字段只有项目类型为kanban时有效。

swimlane_id

string

可选

泳道的id。该字段只有项目类型为kanban时有效。

story_points

number

可选

工作项的故事点。当项目类型为scrum和kanban，并且工作项类型为story和bug时，该参数有效。数值可以是整数和最多包含一位小数的正数，必须大于等于0。

estimated_workload

number

工作项的预估工时。

可选

remaining_workload

number

工作项的剩余工时。

可选

properties

object

可选

工作项属性的键值对集合，需要注意的是，当前工作项类型对应的工作项属性方案需要包含这些工作项属性，例如工作项属性方案中包含prop_a和prop_b。

prop_a

string

可选

工作项属性prop_a。

prop_b

string

可选

工作项属性prop_b。

participant_ids

array[string]

可选

工作项关注人的id列表。

示例

{
    "project_id": "5eb623f6a70571487ea47000",
    "type_id": "bug",
    "title": "这是一个缺陷",
    "description": "这是一个缺陷的描述",
    "start_at": 1583290309,
    "end_at": 1583290347,
    "state_id": "5c9b35de90ad7153c2062f18",
    "parent_id": "5edca112b06305c524cad2fa",
    "sprint_id": "5ecf7b74eaab845a2aa53138",
    "version_id": "5eb623f6a70571487ea47001",
    "board_id": "5eb623f6a70571487ea47222",
    "entry_id": "5ee1c4fac5b3c51206f0a861",
    "swimlane_id": "5ee1c4fac5b3c51206f0a866",
    "priority_id": "5eb623f6a70571487ea47111",
    "assignee_id": "a0417f68e846aae315c85d24643678a9",
    "participant_ids": [
        "a0417f68e846aae315c85d24643678a9"
    ],
    "story_points": 1,
    "estimated_workload": 1,
    "remaining_workload": 1,
    "properties": {
        "prop_a": "prop_a_value",
        "prop_b": "prop_b_value"
    }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://open.pingcode.com/v1/project/work_items' \
--header 'Content-Type: application/json' \
--data-raw '{
    "project_id": "5eb623f6a70571487ea47000",
    "type_id": "bug",
    "title": "这是一个缺陷",
    "description": "这是一个缺陷的描述",
    "start_at": 1583290309,
    "end_at": 1583290347,
    "state_id": "5c9b35de90ad7153c2062f18",
    "parent_id": "5edca112b06305c524cad2fa",
    "sprint_id": "5ecf7b74eaab845a2aa53138",
    "version_id": "5eb623f6a70571487ea47001",
    "board_id": "5eb623f6a70571487ea47222",
    "entry_id": "5ee1c4fac5b3c51206f0a861",
    "swimlane_id": "5ee1c4fac5b3c51206f0a866",
    "priority_id": "5eb623f6a70571487ea47111",
    "assignee_id": "a0417f68e846aae315c85d24643678a9",
    "participant_ids": [
        "a0417f68e846aae315c85d24643678a9"
    ],
    "story_points": 1,
    "estimated_workload": 1,
    "remaining_workload": 1,
    "properties": {
        "prop_a": "prop_a_value",
        "prop_b": "prop_b_value"
    }
}'

返回响应

🟢200成功

application/json

Body

project_id

string

必需

type_id

string

必需

title

string

必需

description

string

必需

start_at

integer

必需

end_at

integer

必需

state_id

string

必需

parent_id

string

必需

sprint_id

string

必需

version_id

string

必需

board_id

string

必需

entry_id

string

必需

swimlane_id

string

必需

priority_id

string

必需

assignee_id

string

必需

participant_ids

array[string]

必需

story_points

integer

必需

estimated_workload

integer

必需

remaining_workload

integer

必需

properties

object

必需

prop_a

string

必需

prop_b

string

必需

示例

{
    "project_id": "5eb623f6a70571487ea47000",
    "type_id": "bug",
    "title": "这是一个缺陷",
    "description": "这是一个缺陷的描述",
    "start_at": 1583290309,
    "end_at": 1583290347,
    "state_id": "5c9b35de90ad7153c2062f18",
    "parent_id": "5edca112b06305c524cad2fa",
    "sprint_id": "5ecf7b74eaab845a2aa53138",
    "version_id": "5eb623f6a70571487ea47001",
    "board_id": "5eb623f6a70571487ea47222",
    "entry_id": "5ee1c4fac5b3c51206f0a861",
    "swimlane_id": "5ee1c4fac5b3c51206f0a866",
    "priority_id": "5eb623f6a70571487ea47111",
    "assignee_id": "a0417f68e846aae315c85d24643678a9",
    "participant_ids": [
        "a0417f68e846aae315c85d24643678a9"
    ],
    "story_points": 1,
    "estimated_workload": 1,
    "remaining_workload": 1,
    "properties": {
        "prop_a": "prop_a_value",
        "prop_b": "prop_b_value"
    }
}