获取工作项基础信息配置

GET

/open_api/{project_key}/work_item/type/{work_item_type_key}

请求参数

Header 参数

返回响应

🟢200成功

application/json

Body

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET '/open_api//work_item/type/' \
--header 'X-PLUGIN-TOKEN: {{plugin_token}}' \
--header 'X-USER-KEY: {{user_key}}'

响应示例

{
    "data": {
        "type_key": "story", // 工作项类型key
        "name": "需求", //工作项类型名称
        "flow_mode": "workflow", //流程模式，节点流workflow ，状态流stateflow
        "api_name": "story", // 系统标识
        "description": "管理需求的全生命周期", //描述
        "is_disabled": false, //是否禁用该工作项，false-未禁用  true-禁用
        "is_pinned": true, //是否设置为导航入口，false-未设置 true-设置为导航入口
        "enable_schedule": true, // 是否支持工作项整体排期，true-支持，true时下面所有字段才生效，false-不支持，仅状态流工作项支持该设置
        "schedule_field_key": "", // 排期字段的key
        "schedule_field_name": "", // 排期字段名称
        "estimate_point_field_key": "", // 估分字段key
        "estimate_point_field_name": "", // 估分字段名称
        "actual_work_time_field_key": "", // 实际工时字段key
        "actual_work_time_field_name": "", // 实际工时字段名称
        "belong_roles": [ // 所属角色
            {
                "id": "RD BM", //角色id
                "name": "RD BM", //角色名称
                "key": "role_658b9f05809f644bebd6613a_version_RD BM"
            }
        ],
        "actucal_work_time_switch": false // 工作项工时 参考获取工作项的工时记录列表 。开放开关，True代表开关打开（工作项工时通过工作项工时相关的Open API进行管理），False代表开关关闭（工作项工时通过平台标准功能进行管理）
    },
    "err": {},
    "err_msg": "",
    "err_code": 0
}

修改于 2025-06-28 20:45:42

删除工作项关系

更新工作项基础信息配置