创建一个工作项 - PingCodeRESTAPI

用于创建一个工作项。

权限：企业令牌/用户令牌

Scopes：pcp:write:pjm:workitem

Body 参数说明：

project_id (String, 必填): 项目的id。

type_id (String, 必填): 工作项类型的id。工作项类型分为9种系统类型和一些自定义类型。系统类型包括：史诗、特性、用户故事、阶段、里程碑、需求、任务、缺陷和事务。可以通过获取全部工作项类型列表获得。

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。当前工作项类型支持的父工作类型包含 parent_id 对应的工作项类型时，该参数有效。具体配置见属性与视图子工作项配置。

sprint_id (String, 选填): 所属迭代id。该字段只有项目类型为 scrum 和 hybrid 时有效。

version_ids (String[], 选填): 所属发布的id列表。

board_id (String, 选填): 看板的id。该字段只有项目类型为 kanban 和 hybrid 时有效。

entry_id (String, 选填): 看板栏的id。该字段只有项目类型为 kanban 和 hybrid 时有效。

swimlane_id (String, 选填): 泳道的id。该字段只有项目类型为 kanban 和 hybrid 时有效。

story_points (Number, 选填): 工作项的故事点。当工作项的属性在视图中配置了故事点属性时，该参数生效。故事点数值必须是大于等于0的整数或最多包含一位小数的正数。

estimated_workload (Number, 选填): 工作项的预估工时。

remaining_workload (Number, 选填): 工作项的剩余工时。

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

properties.prop_a (Object, 选填): 工作项属性 prop_a 。

properties.prop_b (Object, 选填): 工作项属性 prop_b 。

participant_ids (String[], 选填): 工作项关注人的id列表。

请求参数

Header 参数

Body 参数application/json

示例

{
  "project_id": "5eb623f6a70571487ea47000",
  "type_id": "bug",
  "title": "这是一个缺陷",
  "description": "这是一个缺陷的描述",
  "start_at": 1583290309,
  "end_at": 1583290347,
  "state_id": "5c9b35de90ad7153c2062f18",
  "parent_id": "5edca112b06305c524cad2fa",
  "sprint_id": "5ecf7b74eaab845a2aa53138",
  "version_ids": [
    "5eb623487ea47001f6a70571"
  ],
  "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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200响应示例：

application/json

Bodyapplication/json

示例

{
    "id": "5edca524cad2fa1125cb0630",
    "url": "https://{rest_api_root}/v1/pjm/work_items/5edca524cad2fa1125cb0630",
    "project": {
        "id": "5eb623f6a70571487ea47000",
        "url": "https://{rest_api_root}/v1/pjm/projects/5eb623f6a70571487ea47000",
        "identifier": "SCR",
        "name": "Scrum项目",
        "type": "scrum",
        "is_archived": 0,
        "is_deleted": 0
    },
    "identifier": "SCR-5",
    "title": "这是一个缺陷",
    "type": "bug",
    "start_at": 1583290309,
    "end_at": 1583290347,
    "parent_id": "5edca112b06305c524cad2fa",
    "short_id": "1bAqLmTG",
    "html_url": "https://yctech.pingcode.com/pjm/workitems/1bAqLmTG",
    "parent": {
        "id": "5edca112b06305c524cad2fa",
        "url": "https://{rest_api_root}/v1/pjm/work_items/5edca112b06305c524cad2fa",
        "identifier": "SCR-3",
        "title": "这是一个用户故事",
        "type": "story",
        "start_at": 1583290309,
        "end_at": 1583290347,
        "parent_id": "5edca524cad2fa112b06309c",
        "properties": {
            "prop_a": "prop_a_value",
            "prop_b": "prop_b_value",
            "risk": null,
            "business_value": null,
            "effort": null,
            "backlog_type": null,
            "backlog_from": null
        }
    },
    "assignee": {
        "id": "a0417f68e846aae315c85d24643678a9",
        "url": "https://{rest_api_root}/v1/directory/users/a0417f68e846aae315c85d24643678a9",
        "name": "john",
        "display_name": "John",
        "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
    },
    "versions": [
       {
          "id": "5eb623487ea47001f6a70571",
          "url": "https://{rest_api_root}/v1/pjm/projects/5eb623f6a70571487ea47000/versions/5eb623487ea47001f6a70571",
          "name": "1.0.1",
          "start_at": 1565255712,
          "end_at": 1565255879,
          "stage": {
              "id": "5f44a8f8bb347b14b49624a1",
              "url": "https://{rest_api_root}/v1/pjm/stages/5f44a8f8bb347b14b49624a1",
              "name": "未开始",
              "type": "pending",
              "color": "#FA8888"
          }
       }
    ],
    "sprint": {
        "id": "5ecf7b74eaab845a2aa53138",
        "url": "https://{rest_api_root}/v1/pjm/projects/5eb623f6a70571487ea47000/sprints/5ecf7b74eaab845a2aa53138",
        "name": "Sprint 1",
        "start_at": 1589791860,
        "end_at": 1589791860,
        "status": "completed"
    },
    "state": {
        "id": "5c9b35de90ad7153c2062f18",
        "url": "https://{rest_api_root}/v1/pjm/work_item_states/5c9b35de90ad7153c2062f18",
        "name": "新建",
        "type": "pending",
        "color": "#ff7575"
    },
    "priority": {
        "id": "5eb623f6a70571487ea47111",
        "url": "https://{rest_api_root}/v1/pjm/work_item_priorities/5eb623f6a70571487ea47111",
        "name": "最高"
    },
    "board": null,
    "entry": null,
    "swimlane": null,
    "phase": null,
    "description": "这是一个缺陷的描述",
    "completed_at": 1583290347,
    "story_points": 1,
    "estimated_workload": 1,
    "remaining_workload": 1,
    "properties": {
        "prop_a": "prop_a_value",
        "prop_b": "prop_b_value",
        "severity": null,
        "replay_version": null,
        "reappear_probability": null,
        "bug_type": null,
        "reason": null,
        "solution": null,
        "replay_step": null
    },
    "tags": [],
    "participants": [
        {
            "id": "a0417f68e846aae315c85d24643678a9",
            "url": "https://{rest_api_root}/v1/participants/a0417f68e846aae315c85d24643678a9?principal_type=work_item&principal_id=5edca524cad2fa1125cb0630",
            "type": "user",
            "user": {
                "id": "a0417f68e846aae315c85d24643678a9",
                "url": "https://{rest_api_root}/v1/directory/users/a0417f68e846aae315c85d24643678a9",
                "name": "john",
                "display_name": "John",
                "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
            }
        }
    ],
    "created_at": 1583290300,
    "created_by": {
        "id": "a0417f68e846aae315c85d24643678a9",
        "url": "https://{rest_api_root}/v1/directory/users/a0417f68e846aae315c85d24643678a9",
        "name": "john",
        "display_name": "John",
        "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
    },
    "updated_at": 1583290300,
    "updated_by": {
        "id": "a0417f68e846aae315c85d24643678a9",
        "url": "https://{rest_api_root}/v1/directory/users/a0417f68e846aae315c85d24643678a9",
        "name": "john",
        "display_name": "John",
        "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
    },
    "is_archived": 0,
    "is_deleted": 0
}