YesDev / WebAPI / 创建新项目

创建新项目

接口描述: 创建新项目

HTTP/HTTPS
请求协议
GET/POST
请求方式
UTF-8
编码格式
JSON
返回格式

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
app_key字符串可选app_key,团队代码
sign字符串可选-动态签名,签名算法请联系我们技术客服获取
workgroup_id整型可选0工作组ID
project_name字符串必须-最大:200项目名称
project_template_id整型可选0项目模板id,0默认 100敏捷开发 200外包项目 300技术专项 400维护项目
custom_project_template_id整型可选0自定义模板id 优先级是自定义模板id,才到项目模板id
project_start_time字符串可选-项目开始时间,格式:2020-10-10
project_end_time字符串可选-项目结束时间,格式:2020-10-10
project_product_id整型可选0所属产品ID
project_desc字符串可选项目描述,支持富文本
project_status整型可选0项目状态,0规划中1进行中2已完成3挂起
charge_staff_id整型可选0项目负责人(员工ID)
project_need_ids数组用,分割可选-需求ID,多个用逗号分割
project_task_ids数组用,分割可选-任务ID,多个用逗号分割
project_url_ids数组用,分割可选-信息墙ID,多个用逗号分割
not_send_email整型可选0不发送邮件
from_channel字符串可选
project_level_type整型可选0项目级别类型:0-普通项目;1-高级项目
custom_field_value数组JSON格式可选-需求自定义字段,格式:{"系统KEY":"值","_CFKEY_1":"xxx"}

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.id整型新项目ID
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
app_key 可选
sign 可选
workgroup_id 可选
project_name 必须
project_template_id 可选
custom_project_template_id 可选
project_start_time 可选
project_end_time 可选
project_product_id 可选
project_desc 可选
project_status 可选
charge_staff_id 可选
project_need_ids 可选
project_task_ids 可选
project_url_ids 可选
not_send_email 可选
from_channel 可选
project_level_type 可选
custom_field_value 可选

客户端请求示例

# 暂无示例,可添加示例文件:./src/view/docs/demos/Platform.Projects.CreateNewProject.json

错误列表

错误状态码错误描述信息
400ret=400,客户端参数错误或非法请求
404表示接口服务不存在
406ret=406,access_token令牌校验不通过
407ret=407,app_key权限不足,或未知应用
408ret=408,当前用户禁止使用,或用户未登录
410权限不足
500表示服务端内部错误

本文档生成时间:2024-04-27 18:51:43 联系我们开通接入OpenAPI