创建模型工程
功能介绍
创建模型工程。
URI
POST /v1/modelproject
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 所属项目id,传参查询项目下工程,不传则查询用户加入的所有项目下的工程。 通过查询用户的项目获取。 约束限制: 由数字、字母、'-'组成。 取值范围: 1-50位。 默认取值: 不涉及。 |
| model_project_name | 是 | String | 参数解释: 工程名称。 约束限制: 头尾不支持空格,开头只支持中文、字母、数字,只能包含中文、字母、数字、空格、_.,()+-/[]%&® 取值范围: 1-128位 默认取值: 不涉及。 |
| description | 否 | String | 参数解释: 描述。 约束限制: 不涉及。 取值范围: 0-200位字符 默认取值: 不涉及 |
| language | 是 | String | 参数解释: 创建工程目录的模板语言,当前支持英文和中文。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及 |
| catalog_type | 否 | String | 参数解释: 初始化目录的类型,不传默认则不生成目录。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及 |
响应参数
状态码: 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 接口返回的状态信息 取值范围: success:执行成功, failed:执行失败。 |
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及。 |
| result | Object | 参数解释: 响应对象。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| content | Object | 参数解释: 模型工程响应体内容。 取值范围: 不涉及。 |
| count | Integer | 参数解释: 分页返回的总条数。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| project_id | String | 参数解释: 项目id。 取值范围: 不涉及。 |
| project_name | String | 参数解释: 项目名称。 取值范围: 不涉及。 |
| model_project_uuid | String | 参数解释: 软件建模工程id。 取值范围: 不涉及。 |
| model_project_name | String | 参数解释: 模型工程名称。 取值范围: 不涉及。 |
| description | String | 参数解释: 描述 取值范围: 不涉及。 |
请求示例
POST https://{endpoint}/v1/modelproject
body参数
{
"project_id": "gc78f32c56498490cb17678354eb6dc29",
"model_project_name": "hyf-createTest111",
"description": "123",
"language": "cn",
"catalog_type": "4+1View"
} 响应示例
状态码: 200
success
{
"status": "success",
"error_code": null,
"error_msg": null,
"result": {
"content": {
"project_id": "gc78f32c56498490cb17678354eb6dc29",
"project_name": "Hyf-工作空间切换测试",
"model_project_uuid": "e7cbb4fd9177402986ce56853d39b91b",
"model_project_name": "hyf-createTest111",
"description": "123"
}
"count": null
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | success |
错误码
参考错误码。