POSTAR / projeto/import

Importa um projeto de um arquivo de exportação

aplicação/json

corpo, corpo Obrigatório

objeto objeto

Propriedades adicionais são permitidas.

Respostas

  • 200 aplicação/json

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • name string Obrigatório

      O comprimento mínimo é 1, o comprimento máximo é 50.

    • type string Obrigatório

      Tipo de banco de dados ou tipo de banco de dados personalizado. Por exemplo, MYSQL, ORACLE, POSTGRESQL, SQL_SERVER, COCKROACHDB, DB2, SQLANYWHERE, SYBASE, SYBASEIQ ou YUGABYTE.

    • Última modificação string(data-hora)
    • schemasId string Obrigatório

      O formato deve corresponder ao seguinte padrão: ^[A-Za-z0-9\-]+$.

    • jdbcId string

      O formato deve corresponder ao seguinte padrão: ^[A-Za-z0-9\-]+$.

    • mongodbId string

      O formato deve corresponder ao seguinte padrão: ^[A-Za-z0-9\-]+$.

    • conteúdo objeto Obrigatório
      Ocultar atributos de conteúdo Mostrar atributos de conteúdo objeto
      • Configurações objeto Obrigatório

        Propriedades adicionais NÃO são permitidas.

        Ocultar atributos de configurações Mostrar atributos de configurações objeto
        • viewMode string

          Os valores são HORIZONTAL, VERTICAL, RELATIONAL ou MONGODB.

        • shouldRecommendSchema booleano
        • invólucro string

          Os valores são CAMEL_CASE, TITLE_CASE, KEBAB_CASE, SNAKE_CASE ou UPPER_SNAKE_CASE.

        • excludedJsonExportCollections array[string]
        • keyHandling string Obrigatório

          Os valores são WRAPPED, SINGLE ou GENERATED.

      • collections objeto Obrigatório
        Ocultar atributo de collections Mostrar atributo de collections objeto
        • * objeto Propriedades adicionais

          Propriedades adicionais NÃO são permitidas.

          Ocultar atributo * Mostrar atributo * objeto
          • name string Obrigatório
      • mapeamentos objeto Obrigatório
        Ocultar atributo de mapeamentos Mostrar atributo de mapeamentos objeto
        • * objeto Propriedades adicionais

          Propriedades adicionais NÃO são permitidas.

          Ocultar atributos * Mostrar atributos * objeto
          • Configurações objeto Obrigatório

            Propriedades adicionais NÃO são permitidas.

            Ocultar atributos de configurações Mostrar atributos de configurações objeto
            • type string Obrigatório

              Os valores são NEW_DOCUMENT, EMBEDDED_DOCUMENT ou EMBEDDED_DOCUMENT_ARRAY.

            • notas string
            • embeddedPath string
            • primitivo booleano
            • arrayConditions objeto

              Propriedades adicionais NÃO são permitidas.

              Ocultar atributos arrayConditions Mostrar atributos arrayConditions objeto
              • sortBy string Obrigatório
              • order string Obrigatório

                Os valores são ASC ou DESC.

              • limit integer(int32)
            • foreignKeyName string
            • ruleFilter string
          • Campos objeto Obrigatório
            Ocultar atributos de campos Mostrar atributo de campos objeto
            • * objeto Propriedades adicionais
              Ocultar atributos * Mostrar atributos * objeto
              • Alvo objeto Obrigatório

                Propriedades adicionais NÃO são permitidas.

                Ocultar atributos de destino Mostrar atributos de destino objeto
                • name string Obrigatório
                • incluído booleano Obrigatório
                • isNullExcluded booleano

                  O valor padrão é false.

                • type string Obrigatório

                  Os valores são AUTO, STRING, INTEGER, BOOL, DOUBLE, LONG, DECIMAL, ARRAY, DATE, TIMESTAMP, OBJECT, OBJECT_ID, BIN_DATA, MIN_KEY, MAX_KEY, JAVASCRIPT, REGEX ou NULL.

              • Fonte objeto Obrigatório

                Propriedades adicionais NÃO são permitidas.

                Ocultar atributos de origem Mostrar atributos de origem objeto
                • name string Obrigatório
                • databaseSpecificType string Obrigatório
                • isPrimaryKey booleano

                  O valor padrão é false.

          • modifiedFields objeto Obrigatório
            Ocultar atributo CalculatedFields Mostrar atributo calculateFields objeto
            • * objeto Propriedades adicionais

              Propriedades adicionais NÃO são permitidas.

              Ocultar atributos * Mostrar atributos * objeto
              • name string Obrigatório
              • isNullExcluded booleano

                O valor padrão é false.

              • type string

                Os valores são AUTO, STRING, INTEGER, BOOL, DOUBLE, LONG, DECIMAL, ARRAY, DATE, TIMESTAMP, OBJECT, OBJECT_ID, BIN_DATA, MIN_KEY, MAX_KEY, JAVASCRIPT, REGEX ou NULL.

              • expressão string Obrigatório
          • collectionId string Obrigatório
          • mesa string Obrigatório
      • relationships objeto Obrigatório

        Propriedades adicionais NÃO são permitidas.

        Ocultar atributos de relacionamentos Mostrar atributos de relacionamentos objeto
        • tables objeto Obrigatório
          Atributo de ocultar tabelas Mostrar atributo de tabelas objeto
          • * objeto Propriedades adicionais

            Propriedades adicionais NÃO são permitidas.

            Ocultar atributo * Mostrar atributo * objeto
            • mapeamentos array[string] Obrigatório

              O formato de cada um deve corresponder ao seguinte padrão: ^[A-Za-z0-9\-]+$.

        • collections objeto Obrigatório
          Ocultar atributo de collections Mostrar atributo de collections objeto
          • * objeto Propriedades adicionais

            Propriedades adicionais NÃO são permitidas.

            Ocultar atributo * Mostrar atributo * objeto
            • mapeamentos array[string] Obrigatório

              O formato de cada um deve corresponder ao seguinte padrão: ^[A-Za-z0-9\-]+$.

        • mapeamentos objeto Obrigatório
          Ocultar atributo de mapeamentos Mostrar atributo de mapeamentos objeto
          • * objeto Propriedades adicionais

            Propriedades adicionais NÃO são permitidas.

            Ocultar atributo * Mostrar atributo * objeto
            • crianças array[string] Obrigatório

              O formato de cada um deve corresponder ao seguinte padrão: ^[A-Za-z0-9\-]+$.

      • Diagramas objeto Obrigatório

        Propriedades adicionais NÃO são permitidas.

        Ocultar atributos de diagramas Mostrar atributos de diagramas objeto
        • ActiveTab string Obrigatório
        • tabs array[objeto] Obrigatório
          Ocultar atributos de guias Mostrar atributos de guias objeto
          • id string Obrigatório
          • name string Obrigatório
          • notas string
          • Relacional objeto Obrigatório
            Ocultar atributos relacionais Mostrar atributos relacionais objeto
            • Nós array[objeto] Obrigatório
              Ocultar atributos dos nós Mostrar atributos de nós objeto
              • id string Obrigatório
              • type string Obrigatório
              • Posição objeto Obrigatório
                Ocultar atributos de posição Mostrar atributos de posição objeto
                • X número Obrigatório
                • y número Obrigatório
              • largura número
              • altura número
              • escondida booleano Obrigatório
            • bordas array[objeto] Obrigatório
              Ocultar atributos de bordas Mostrar atributos das bordas objeto
              • id string Obrigatório
              • Fonte string Obrigatório
              • Alvo string Obrigatório
              • marcadorStart string

                Os valores são START_ONE ou START_ONE_OR_MANY.

              • marcadorEnd string

                Os valores são END_ONE, END_MANY ou END_ONE_OR_MANY.

          • collection objeto Obrigatório
            Ocultar atributos da coleção Mostrar atributos da collection objeto
            • Nós array[objeto] Obrigatório
              Ocultar atributos dos nós Mostrar atributos de nós objeto
              • id string Obrigatório
              • type string Obrigatório
              • Posição objeto Obrigatório
                Ocultar atributos de posição Mostrar atributos de posição objeto
                • X número Obrigatório
                • y número Obrigatório
              • largura número
              • altura número
              • escondida booleano Obrigatório
            • bordas array[objeto] Obrigatório
              Ocultar atributos de bordas Mostrar atributos das bordas objeto
              • id string Obrigatório
              • Fonte string Obrigatório
              • Alvo string Obrigatório
              • marcadorStart string

                Os valores são START_ONE ou START_ONE_OR_MANY.

              • marcadorEnd string

                Os valores são END_ONE, END_MANY ou END_ONE_OR_MANY.

      • tables objeto Obrigatório
        Atributo de ocultar tabelas Mostrar atributo de tabelas objeto
        • * objeto Propriedades adicionais

          Propriedades adicionais NÃO são permitidas.

          Ocultar atributo * Mostrar atributo * objeto
          • caminho objeto Obrigatório

            Propriedades adicionais NÃO são permitidas.

            Ocultar atributos de caminho Mostrar atributos do caminho objeto
            • database string Obrigatório
            • schema string Obrigatório
            • mesa string Obrigatório
    • detalhes da conexão objeto
      Ocultar atributo connectionDetails Mostrar atributo connectionDetails objeto
      • ddl objeto

        Propriedades adicionais NÃO são permitidas.

        Ocultar atributo ddl Mostrar atributo ddl objeto
        • type string Obrigatório

          Tipo de banco de dados ou tipo de banco de dados personalizado. Por exemplo, MYSQL, ORACLE, POSTGRESQL, SQL_SERVER, COCKROACHDB, DB2, SQLANYWHERE, SYBASE, SYBASEIQ ou YUGABYTE.

    • isSampleProject booleano
    • id string Obrigatório

      O formato deve corresponder ao seguinte padrão: ^[A-Za-z0-9\-]+$.

  • 485 aplicação/json

    Ocorreu um problema desconhecido durante a importação do projeto

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • jobId string

      O formato deve corresponder ao seguinte padrão: ^[A-Za-z0-9\-]+$.

    • mensagem string Obrigatório
    • Descrição string
    • timestamp string(data-hora) Obrigatório
  • 486 aplicação/json

    Campo não encontrado durante a importação do projeto

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • jobId string

      O formato deve corresponder ao seguinte padrão: ^[A-Za-z0-9\-]+$.

    • mensagem string Obrigatório
    • Descrição string
    • timestamp string(data-hora) Obrigatório
  • 487 aplicação/json

    Versão do projeto inválida durante a importação

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • jobId string

      O formato deve corresponder ao seguinte padrão: ^[A-Za-z0-9\-]+$.

    • mensagem string Obrigatório
    • Descrição string
    • timestamp string(data-hora) Obrigatório
POST /projeto/import
curl \
 --request POST 'http://127.0.0.1:8278/api/v1/project/import' \
 --header "Content-Type: application/json"
Exemplos de solicitação
{}
Exemplos de resposta (200)
{
  "name": "string",
  "type": "ORACLE",
  "lastModified": "2026-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"
}
Exemplos de resposta (485)
{
  "jobId": "string",
  "message": "string",
  "description": "string",
  "timestamp": "2026-05-04T09:42:00Z"
}
Exemplos de resposta (486)
{
  "jobId": "string",
  "message": "string",
  "description": "string",
  "timestamp": "2026-05-04T09:42:00Z"
}
Exemplos de resposta (487)
{
  "jobId": "string",
  "message": "string",
  "description": "string",
  "timestamp": "2026-05-04T09:42:00Z"
}