更新时间:2025-12-27 GMT+08:00
分享

创建工程 - CreateProject

功能介绍

创建接口测试工程,成功返回工程id,失败返回原因。若工程已存在,则直接返回该工程ID

调用方法

请参见如何调用API

URI

POST /v1/projects/{project_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

项目uuid应符合如下规则:长度等于32位,包含大小写字母、数字

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

必传。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

activity_id

String

活动唯一标识

name

String

名称

stage_id

String

测试阶段唯一标识

stage_name

String

测试阶段名

tmss_version_name

String

测试管理版本名

tmss_version_uri

String

测试管理版本uri

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

code

String

参数解释

错误码

error

CommonResponseErrorObject object

参数解释

统一错误返回

reason

String

参数解释

失败原因

result

Object

参数解释

结果

status

String

参数解释

响应状态

  • success,请求成功

  • error,请求报错

表5 CommonResponseErrorObject

参数

参数类型

描述

code

String

参数解释

错误码

reason

String

参数解释

错误原因

状态码:201

Created

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

12-18个字符组成的字符串

error_msg

String

参数解释

接口调用失败错误信息

取值范围

3-1000个字符组成的字符串

状态码:403

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

12-18个字符组成的字符串

error_msg

String

参数解释

接口调用失败错误信息

取值范围

3-1000个字符组成的字符串

状态码:404

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

12-18个字符组成的字符串

error_msg

String

参数解释

接口调用失败错误信息

取值范围

3-1000个字符组成的字符串

请求示例

{
  "stage_id" : "1",
  "stage_name" : "alpha",
  "activity_id" : "1",
  "name" : "API接口测试项目_VFc86y",
  "tmss_version_uri" : "v92s00010hrjump3",
  "tmss_version_name" : "基线"
}

响应示例

状态码:200

OK

{
  "status" : "ok",
  "result" : {
    "id" : "2c758908456540cca948a29c46027101"
  },
  "reason" : null,
  "error" : null,
  "code" : null
}

状态码

状态码

描述

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码

相关文档