从导出文件导入项目

以 Markdown 形式查看
发布 / 项目/import

从导出文件导入项目

application/json

body 必需

对象 对象

允许使用其他属性。

响应

  • 200 application/json

    正常

    隐藏响应属性 显示响应属性 对象
    • 名称 字符串 必需

      最小长度为 1,最大长度为 50

    • 类型 字符串 必需

      数据库类型或自定义数据库类型。示例,MYSQLORACLEPOSTGRESQLSQL_SERVERCOCKROACHDBDB2SQLANYWHERESYBASESYBASEIQYUGABYTE

    • 最近修改 string(date-time)
    • schemasId 字符串 必需

      格式应符合以下模式:^[A-Za-z0-9\-]+$

    • jdbcId 字符串

      格式应符合以下模式:^[A-Za-z0-9\-]+$

    • mongodbId 字符串

      格式应符合以下模式:^[A-Za-z0-9\-]+$

    • 内容 对象 必需
      隐藏内容属性 显示内容属性 对象
      • 设置 对象 必需

        不允许使用其他属性。

        隐藏设置属性 显示设置属性 对象
        • viewMode 字符串

          取值为 HORIZONTALVERTICALRELATIONALMONGODB

        • shouldRecommendSchema 布尔
        • 大小写 字符串

          取值为 CAMEL_CASETITLE_CASEKEBAB_CASESNAKE_CASEUPPER_SNAKE_CASE

        • 排除JsonExportCollections array[string]
        • keyHandling 字符串 必需

          值为 WRAPPEDSINGLEGENERATED

      • collections 对象 必需
        隐藏集合属性 显示集合属性 对象
        • * 对象 additionalProperties

          不允许使用其他属性。

          隐藏 * 属性 显示 * 属性 对象
          • 名称 字符串 必需
      • mappings 对象 必需
        隐藏映射属性 显示映射属性 对象
        • * 对象 additionalProperties

          不允许使用其他属性。

          隐藏 * 属性 显示 * 属性 对象
          • 设置 对象 必需

            不允许使用其他属性。

            隐藏设置属性 显示设置属性 对象
            • 类型 字符串 必需

              值为 NEW_DOCUMENTEMBEDDED_DOCUMENTEMBEDDED_DOCUMENT_ARRAY

            • 注意事项 字符串
            • embeddedPath 字符串
            • 原始 布尔
            • arrayConditions 对象

              不允许使用其他属性。

              隐藏 arrayConditions 属性 显示 arrayConditions 属性 对象
              • sortBy 字符串 必需
              • 来自一个购物车应用的order文档, 字符串 必需

                值为 ASCDESC

              • limit integer(int32)
            • foreignKeyName 字符串
            • ruleFilter 字符串
          • 字段 对象 必需
            隐藏字段属性 显示字段属性 对象
            • * 对象 additionalProperties
              隐藏 * 属性 显示 * 属性 对象
              • 目标 对象 必需

                不允许使用其他属性。

                隐藏目标属性 显示目标属性 对象
                • 名称 字符串 必需
                • 包含 布尔 必需
                • isNullExcluded 布尔

                  默认值为false

                • 类型 字符串 必需

                  值为 AUTOSTRINGINTEGERBOOLDOUBLELONGDECIMALARRAYDATETIMESTAMPOBJECTOBJECT_IDBIN_DATAMIN_KEYMAX_KEYJAVASCRIPTREGEXNULL

              • 来源 对象 必需

                不允许使用其他属性。

                隐藏源属性 显示源属性 对象
                • 名称 字符串 必需
                • databaseSpecificType 字符串 必需
                • isPrimaryKey 布尔

                  默认值为false

          • ComputedFields 对象 必需
            隐藏计算字段属性 显示计算字段属性 对象
            • * 对象 additionalProperties

              不允许使用其他属性。

              隐藏 * 属性 显示 * 属性 对象
              • 名称 字符串 必需
              • isNullExcluded 布尔

                默认值为false

              • 类型 字符串

                值为 AUTOSTRINGINTEGERBOOLDOUBLELONGDECIMALARRAYDATETIMESTAMPOBJECTOBJECT_IDBIN_DATAMIN_KEYMAX_KEYJAVASCRIPTREGEXNULL

              • 表达式(expression) 字符串 必需
          • collectionId 字符串 必需
          • 数据表(table) 字符串 必需
      • 关系 对象 必需

        不允许使用其他属性。

        隐藏关系属性 显示关系属性 对象
        • tables 对象 必需
          隐藏表属性 显示表属性 对象
          • * 对象 additionalProperties

            不允许使用其他属性。

            隐藏 * 属性 显示 * 属性 对象
            • mappings array[string] 必需

              每个的格式应符合以下模式:^[A-Za-z0-9\-]+$

        • collections 对象 必需
          隐藏集合属性 显示集合属性 对象
          • * 对象 additionalProperties

            不允许使用其他属性。

            隐藏 * 属性 显示 * 属性 对象
            • mappings array[string] 必需

              每个的格式应符合以下模式:^[A-Za-z0-9\-]+$

        • mappings 对象 必需
          隐藏映射属性 显示映射属性 对象
          • * 对象 additionalProperties

            不允许使用其他属性。

            隐藏 * 属性 显示 * 属性 对象
            • 子项 array[string] 必需

              每个的格式应符合以下模式:^[A-Za-z0-9\-]+$

      • 图表 对象 必需

        不允许使用其他属性。

        隐藏图表属性 显示图表属性 对象
        • ActiveTab 字符串 必需
        • tabs 大量[对象] 必需
          隐藏标签页属性 显示标签页属性 对象
          • id 字符串 必需
          • 名称 字符串 必需
          • 注意事项 字符串
          • 关系 对象 必需
            隐藏关系属性 显示关系属性 对象
            • 节点 大量[对象] 必需
              隐藏节点属性 显示节点属性 对象
              • id 字符串 必需
              • 类型 字符串 必需
              • Position 对象 必需
                隐藏位置属性 显示职位属性 对象
                • X 数字 必需
                • y 数字 必需
              • 宽度 数字
              • 高度 数字
              • 隐藏 布尔 必需
            • 边缘 大量[对象] 必需
              隐藏边属性 显示边属性 对象
              • id 字符串 必需
              • 来源 字符串 必需
              • 目标 字符串 必需
              • markerStart 字符串

                值为 START_ONESTART_ONE_OR_MANY

              • markerEnd 字符串

                值为 END_ONEEND_MANYEND_ONE_OR_MANY

          • 集合 对象 必需
            隐藏集合属性 显示集合属性 对象
            • 节点 大量[对象] 必需
              隐藏节点属性 显示节点属性 对象
              • id 字符串 必需
              • 类型 字符串 必需
              • Position 对象 必需
                隐藏位置属性 显示职位属性 对象
                • X 数字 必需
                • y 数字 必需
              • 宽度 数字
              • 高度 数字
              • 隐藏 布尔 必需
            • 边缘 大量[对象] 必需
              隐藏边属性 显示边属性 对象
              • id 字符串 必需
              • 来源 字符串 必需
              • 目标 字符串 必需
              • markerStart 字符串

                值为 START_ONESTART_ONE_OR_MANY

              • markerEnd 字符串

                值为 END_ONEEND_MANYEND_ONE_OR_MANY

      • tables 对象 必需
        隐藏表属性 显示表属性 对象
        • * 对象 additionalProperties

          不允许使用其他属性。

          隐藏 * 属性 显示 * 属性 对象
          • 路径 对象 必需

            不允许使用其他属性。

            隐藏路径属性 显示路径属性 对象
            • database 字符串 必需
            • 模式 字符串 必需
            • 数据表(table) 字符串 必需
    • connectionDetails 对象
      隐藏 connectionDetails 属性 显示 connectionDetails 属性 对象
      • ddl 对象

        不允许使用其他属性。

        隐藏 ddl 属性 显示 ddl 属性 对象
        • 类型 字符串 必需

          数据库类型或自定义数据库类型。示例,MYSQLORACLEPOSTGRESQLSQL_SERVERCOCKROACHDBDB2SQLANYWHERESYBASESYBASEIQYUGABYTE

    • isSampleProject 布尔
    • id 字符串 必需

      格式应符合以下模式:^[A-Za-z0-9\-]+$

  • 485 application/json

    项目导入期间出现未知问题

    隐藏响应属性 显示响应属性 对象
    • jobId 字符串

      格式应符合以下模式:^[A-Za-z0-9\-]+$

    • message 字符串 必需
    • 描述 字符串
    • timestamp string(date-time) 必需
  • 486 application/json

    项目导入期间未找到字段

    隐藏响应属性 显示响应属性 对象
    • jobId 字符串

      格式应符合以下模式:^[A-Za-z0-9\-]+$

    • message 字符串 必需
    • 描述 字符串
    • timestamp string(date-time) 必需
  • 487 application/json

    项目版本在导入期间无效

    隐藏响应属性 显示响应属性 对象
    • jobId 字符串

      格式应符合以下模式:^[A-Za-z0-9\-]+$

    • message 字符串 必需
    • 描述 字符串
    • timestamp string(date-time) 必需
POST /项目/import
curl \
 --request POST 'http://127.0.0.1:8278/api/v1/project/import' \
 --header "Content-Type: application/json"
请求示例
{}
响应示例 (200)
{
  "name": "string",
  "type": "ORACLE",
  "lastModified": "2025-05-04T09:42:00Z",
  "schemasId": "string",
  "jdbcId": "string",
  "mongodbId": "string",
  "content": {
    "settings": {
      "viewMode": "HORIZONTAL",
      "shouldRecommendSchema": true,
      "casing": "CAMEL_CASE",
      "excludedJsonExportCollections": [
        "string"
      ],
      "keyHandling": "WRAPPED"
    },
    "collections": {
      "additionalProperty1": {
        "name": "string"
      },
      "additionalProperty2": {
        "name": "string"
      }
    },
    "mappings": {
      "additionalProperty1": {
        "settings": {
          "type": "NEW_DOCUMENT",
          "notes": "string",
          "embeddedPath": "string",
          "primitive": true,
          "arrayConditions": {
            "sortBy": "string",
            "order": "ASC",
            "limit": 42
          },
          "foreignKeyName": "string",
          "ruleFilter": "string"
        },
        "fields": {
          "additionalProperty1": {
            "target": {
              "name": "string",
              "included": true,
              "isNullExcluded": false,
              "type": "AUTO"
            },
            "source": {
              "name": "string",
              "databaseSpecificType": "string",
              "isPrimaryKey": false
            }
          },
          "additionalProperty2": {
            "target": {
              "name": "string",
              "included": true,
              "isNullExcluded": false,
              "type": "AUTO"
            },
            "source": {
              "name": "string",
              "databaseSpecificType": "string",
              "isPrimaryKey": false
            }
          }
        },
        "calculatedFields": {
          "additionalProperty1": {
            "name": "string",
            "isNullExcluded": false,
            "type": "AUTO",
            "expression": "string"
          },
          "additionalProperty2": {
            "name": "string",
            "isNullExcluded": false,
            "type": "AUTO",
            "expression": "string"
          }
        },
        "collectionId": "string",
        "table": "string"
      },
      "additionalProperty2": {
        "settings": {
          "type": "NEW_DOCUMENT",
          "notes": "string",
          "embeddedPath": "string",
          "primitive": true,
          "arrayConditions": {
            "sortBy": "string",
            "order": "ASC",
            "limit": 42
          },
          "foreignKeyName": "string",
          "ruleFilter": "string"
        },
        "fields": {
          "additionalProperty1": {
            "target": {
              "name": "string",
              "included": true,
              "isNullExcluded": false,
              "type": "AUTO"
            },
            "source": {
              "name": "string",
              "databaseSpecificType": "string",
              "isPrimaryKey": false
            }
          },
          "additionalProperty2": {
            "target": {
              "name": "string",
              "included": true,
              "isNullExcluded": false,
              "type": "AUTO"
            },
            "source": {
              "name": "string",
              "databaseSpecificType": "string",
              "isPrimaryKey": false
            }
          }
        },
        "calculatedFields": {
          "additionalProperty1": {
            "name": "string",
            "isNullExcluded": false,
            "type": "AUTO",
            "expression": "string"
          },
          "additionalProperty2": {
            "name": "string",
            "isNullExcluded": false,
            "type": "AUTO",
            "expression": "string"
          }
        },
        "collectionId": "string",
        "table": "string"
      }
    },
    "relationships": {
      "tables": {
        "additionalProperty1": {
          "mappings": [
            "string"
          ]
        },
        "additionalProperty2": {
          "mappings": [
            "string"
          ]
        }
      },
      "collections": {
        "additionalProperty1": {
          "mappings": [
            "string"
          ]
        },
        "additionalProperty2": {
          "mappings": [
            "string"
          ]
        }
      },
      "mappings": {
        "additionalProperty1": {
          "children": [
            "string"
          ]
        },
        "additionalProperty2": {
          "children": [
            "string"
          ]
        }
      }
    },
    "diagrams": {
      "activeTab": "string",
      "tabs": [
        {
          "id": "string",
          "name": "string",
          "notes": "string",
          "relational": {
            "nodes": [
              {
                "id": "string",
                "type": "string",
                "position": {
                  "x": 42.0,
                  "y": 42.0
                },
                "width": 42.0,
                "height": 42.0,
                "hidden": true
              }
            ],
            "edges": [
              {
                "id": "string",
                "source": "string",
                "target": "string",
                "markerStart": "START_ONE",
                "markerEnd": "END_ONE"
              }
            ]
          },
          "collection": {
            "nodes": [
              {
                "id": "string",
                "type": "string",
                "position": {
                  "x": 42.0,
                  "y": 42.0
                },
                "width": 42.0,
                "height": 42.0,
                "hidden": true
              }
            ],
            "edges": [
              {
                "id": "string",
                "source": "string",
                "target": "string",
                "markerStart": "START_ONE",
                "markerEnd": "END_ONE"
              }
            ]
          }
        }
      ]
    },
    "tables": {
      "additionalProperty1": {
        "path": {
          "database": "string",
          "schema": "string",
          "table": "string"
        }
      },
      "additionalProperty2": {
        "path": {
          "database": "string",
          "schema": "string",
          "table": "string"
        }
      }
    }
  },
  "connectionDetails": {
    "ddl": {
      "type": "ORACLE"
    }
  },
  "isSampleProject": true,
  "id": "string"
}
响应示例 (485)
{
  "jobId": "string",
  "message": "string",
  "description": "string",
  "timestamp": "2025-05-04T09:42:00Z"
}
响应示例 (486)
{
  "jobId": "string",
  "message": "string",
  "description": "string",
  "timestamp": "2025-05-04T09:42:00Z"
}
响应示例 (487)
{
  "jobId": "string",
  "message": "string",
  "description": "string",
  "timestamp": "2025-05-04T09:42:00Z"
}