文档首页/ 工业数字模型驱动引擎/ API参考/ API/ 应用管理/ 创建应用
更新时间：2024-11-04 GMT+08:00
查看PDF
分享

创建应用

功能介绍

本接口用于创建工业数字模型驱动引擎（Industrial Digital Model Engine，简称iDME）的应用。

URI

POST /v1/{project_id}/apps

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为[1-36]个字符。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

IAM用户的token。

获取方法请参见获取IAM用户Token。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

app_name_cn

是

String

参数解释：

应用的中文名称。

约束限制：

不涉及。

取值范围：

应用名称只能包含中文、英文字母、数字、“_”、“-”，且不能为XDM，最大长度128字符。

默认取值：

不涉及。

app_name_en

是

String

参数解释：

应用的英文名称。

约束限制：

不涉及。

取值范围：

英文长度128个字符以内，只允许大写字母开头，且不能为XDM，且只包含字母和数字。

默认取值：

不涉及。

app_desc

否

String

参数解释：

应用的中文描述。

约束限制：

不涉及。

取值范围：

只能包含中文、大小写英文字母、数字、括号、“_”、“-”、空格、标点符号，最大长度1024个字符。

默认取值：

不涉及。

app_desc_en

否

String

参数解释：

应用的中文描述。

约束限制：

不涉及。

取值范围：

只能包含大小写英文字母、数字、“_”、“-”、空格、标点符号，最大长度1024个字符。

默认取值：

不涉及。

operate_type

否

String

参数解释：

操作类型。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

app_env

是

String

参数解释：

环境标识。

约束限制：

不涉及。

取值范围：

  • dev：用于开发环境。

  • sit：用于功能测试环境。

  • uat：用于用户测试环境。

  • train：用于培训环境。

  • beta：用于灰度部署环境。

  • production：用于生产环境。

默认取值：

不涉及。

database_type

是

String

参数解释：

数据库类型。

约束限制：

不涉及。

取值范围：

支持MySQL和PostgreSQL。

默认取值：

不涉及。

app_user_list

是

Array of AppUserList objects

参数解释：

应用责任人。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

integration_mode

是

String

参数解释

集成模式。

约束限制：

不涉及。

取值范围：

  • API

  • SDK

默认取值：

不涉及。

metadata_synchronization

否

Boolean

参数解释：

元模型同步。

约束限制：

不涉及。

取值范围：

true：同步元模型

false： 不同步元模型

默认取值：

不涉及。
表4 AppUserList

参数

是否必选

参数类型

描述

id

否

String

参数解释：

用户ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为36个字符。

默认取值：

不涉及。

name

否

String

参数解释：

用户名。

约束限制：

不涉及。

取值范围：

最大长度255个字符。

默认取值：

不涉及。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

id

String

参数解释：

应用ID。

取值范围：

不涉及。

默认取值：

不涉及。

project_id

String

参数解释：

项目ID。

取值范围：

只能由英文字母、数字组成，且长度为36个字符。

默认取值：

不涉及。

mark_for_delete

Integer

参数解释：

删除标记。

取值范围：

  • 0：未删除

  • 1：删除

默认取值：

不涉及。

create_by

String

参数解释：

创建人。

取值范围：

不涉及。

默认取值：

不涉及。

create_time

Long

参数解释：

创建时间。

取值范围：

不涉及。

默认取值：

不涉及。

update_by

String

参数解释：

更新人。

取值范围：

不涉及。

默认取值：

不涉及。

update_time

Long

参数解释：

更新时间。

取值范围：

不涉及。

默认取值：

不涉及。

name_cn

String

参数解释：

应用的中文名称。

取值范围：

应用名称只能包含中文、英文字母、数字、“_”、“-”，且不能为XDM，最大长度128字符。

默认取值：

不涉及。

name_en

String

参数解释：

应用的英文名称。

取值范围：

英文长度128个字符以内，只允许大写字母开头，且不能为XDM，且只包含字母和数字。

默认取值：

不涉及。

desc_cn

String

参数解释：

应用的中文描述。

取值范围：

只能包含中文、大小写英文字母、数字、括号、“_”、“-”、空格、标点符号，最大长度1024个字符。

默认取值：

不涉及。

desc_en

String

参数解释：

应用的英文描述。

取值范围：

只能包含大小写英文字母、数字、“_”、“-”、空格、标点符号，最大长度1024个字符。

默认取值：

不涉及。

database_type

String

参数解释：

应用的数据库类型。

取值范围：

支持MySQL和PostgreSQL。

默认取值：

不涉及。

environment

String

参数解释：

运行服务的环境标识。

取值范围：

  • dev：用于开发环境。

  • sit：用于功能测试环境。

  • uat：用于用户测试环境。

  • train：用于培训环境。

  • beta：用于灰度部署环境。

  • production：用于生产环境。

默认取值：

不涉及。

versions

String

参数解释：

应用责任人。

取值范围：

不涉及。

默认取值：

不涉及。

migrating

Boolean

参数解释：

判断是否在迁移中。

取值范围：

true:迁移中。

false:未迁移。

默认取值：

不涉及。

请求示例

无

响应示例

状态码： 200

OK

{
  "id" : "",
  "project_id" : "",
  "mark_for_delete" : 0,
  "create_by" : "",
  "create_time" : 1685987901000,
  "update_by" : "",
  "update_time" : 1685987901000,
  "name_cn" : "wdqw222",
  "name_en" : "QDwqwq222",
  "desc_cn" : "QDwqwq222",
  "desc_en" : "qewqew222",
  "database_type" : "mysql",
  "environment" : "dev",
  "versions" : null
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 应用管理

相关文档