Imports a project from an export file

View as Markdown
POST /project/import

Imports a project from an export file

application/json

Body Required

object object

Additional properties are allowed.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • name string Required

      Minimum length is 1, maximum length is 50.

    • type string Required

      Database type or a custom database type. For example, MYSQL, ORACLE, POSTGRESQL, SQL_SERVER, COCKROACHDB, DB2, SQLANYWHERE, SYBASE, SYBASEIQ, or YUGABYTE.

    • lastModified string(date-time)
    • schemasId string Required

      Format should match the following pattern: ^[A-Za-z0-9\-]+$.

    • jdbcId string

      Format should match the following pattern: ^[A-Za-z0-9\-]+$.

    • mongodbId string

      Format should match the following pattern: ^[A-Za-z0-9\-]+$.

    • content object Required
      Hide content attributes Show content attributes object
      • settings object Required

        Additional properties are NOT allowed.

        Hide settings attributes Show settings attributes object
        • viewMode string

          Values are HORIZONTAL, VERTICAL, RELATIONAL, or MONGODB.

        • shouldRecommendSchema boolean
        • casing string

          Values are CAMEL_CASE, TITLE_CASE, KEBAB_CASE, SNAKE_CASE, or UPPER_SNAKE_CASE.

        • excludedJsonExportCollections array[string]
        • keyHandling string Required

          Values are WRAPPED, SINGLE, or GENERATED.

      • collections object Required
        Hide collections attribute Show collections attribute object
        • * object Additional properties

          Additional properties are NOT allowed.

          Hide * attribute Show * attribute object
          • name string Required
      • mappings object Required
        Hide mappings attribute Show mappings attribute object
        • * object Additional properties

          Additional properties are NOT allowed.

          Hide * attributes Show * attributes object
          • settings object Required

            Additional properties are NOT allowed.

            Hide settings attributes Show settings attributes object
            • type string Required

              Values are NEW_DOCUMENT, EMBEDDED_DOCUMENT, or EMBEDDED_DOCUMENT_ARRAY.

            • notes string
            • embeddedPath string
            • primitive boolean
            • arrayConditions object

              Additional properties are NOT allowed.

              Hide arrayConditions attributes Show arrayConditions attributes object
              • sortBy string Required
              • order string Required

                Values are ASC or DESC.

              • limit integer(int32)
            • foreignKeyName string
            • ruleFilter string
          • fields object Required
            Hide fields attribute Show fields attribute object
            • * object Additional properties
              Hide * attributes Show * attributes object
              • target object Required

                Additional properties are NOT allowed.

                Hide target attributes Show target attributes object
                • name string Required
                • included boolean Required
                • isNullExcluded boolean

                  Default value is false.

                • type string Required

                  Values are AUTO, STRING, INTEGER, BOOL, DOUBLE, LONG, DECIMAL, ARRAY, DATE, TIMESTAMP, OBJECT, OBJECT_ID, BIN_DATA, MIN_KEY, MAX_KEY, JAVASCRIPT, REGEX, or NULL.

              • source object Required

                Additional properties are NOT allowed.

                Hide source attributes Show source attributes object
                • name string Required
                • databaseSpecificType string Required
                • isPrimaryKey boolean

                  Default value is false.

          • calculatedFields object Required
            Hide calculatedFields attribute Show calculatedFields attribute object
            • * object Additional properties

              Additional properties are NOT allowed.

              Hide * attributes Show * attributes object
              • name string Required
              • isNullExcluded boolean

                Default value is false.

              • type string

                Values are AUTO, STRING, INTEGER, BOOL, DOUBLE, LONG, DECIMAL, ARRAY, DATE, TIMESTAMP, OBJECT, OBJECT_ID, BIN_DATA, MIN_KEY, MAX_KEY, JAVASCRIPT, REGEX, or NULL.

              • expression string Required
          • collectionId string Required
          • table string Required
      • relationships object Required

        Additional properties are NOT allowed.

        Hide relationships attributes Show relationships attributes object
        • tables object Required
          Hide tables attribute Show tables attribute object
          • * object Additional properties

            Additional properties are NOT allowed.

            Hide * attribute Show * attribute object
            • mappings array[string] Required

              Format of each should match the following pattern: ^[A-Za-z0-9\-]+$.

        • collections object Required
          Hide collections attribute Show collections attribute object
          • * object Additional properties

            Additional properties are NOT allowed.

            Hide * attribute Show * attribute object
            • mappings array[string] Required

              Format of each should match the following pattern: ^[A-Za-z0-9\-]+$.

        • mappings object Required
          Hide mappings attribute Show mappings attribute object
          • * object Additional properties

            Additional properties are NOT allowed.

            Hide * attribute Show * attribute object
            • children array[string] Required

              Format of each should match the following pattern: ^[A-Za-z0-9\-]+$.

      • diagrams object Required

        Additional properties are NOT allowed.

        Hide diagrams attributes Show diagrams attributes object
        • activeTab string Required
        • tabs array[object] Required
          Hide tabs attributes Show tabs attributes object
          • id string Required
          • name string Required
          • notes string
          • relational object Required
            Hide relational attributes Show relational attributes object
            • nodes array[object] Required
              Hide nodes attributes Show nodes attributes object
              • id string Required
              • type string Required
              • position object Required
                Hide position attributes Show position attributes object
                • x number Required
                • y number Required
              • width number
              • height number
              • hidden boolean Required
            • edges array[object] Required
              Hide edges attributes Show edges attributes object
              • id string Required
              • source string Required
              • target string Required
              • markerStart string

                Values are START_ONE or START_ONE_OR_MANY.

              • markerEnd string

                Values are END_ONE, END_MANY, or END_ONE_OR_MANY.

          • collection object Required
            Hide collection attributes Show collection attributes object
            • nodes array[object] Required
              Hide nodes attributes Show nodes attributes object
              • id string Required
              • type string Required
              • position object Required
                Hide position attributes Show position attributes object
                • x number Required
                • y number Required
              • width number
              • height number
              • hidden boolean Required
            • edges array[object] Required
              Hide edges attributes Show edges attributes object
              • id string Required
              • source string Required
              • target string Required
              • markerStart string

                Values are START_ONE or START_ONE_OR_MANY.

              • markerEnd string

                Values are END_ONE, END_MANY, or END_ONE_OR_MANY.

      • tables object Required
        Hide tables attribute Show tables attribute object
        • * object Additional properties

          Additional properties are NOT allowed.

          Hide * attribute Show * attribute object
          • path object Required

            Additional properties are NOT allowed.

            Hide path attributes Show path attributes object
            • database string Required
            • schema string Required
            • table string Required
    • connectionDetails object
      Hide connectionDetails attribute Show connectionDetails attribute object
      • ddl object

        Additional properties are NOT allowed.

        Hide ddl attribute Show ddl attribute object
        • type string Required

          Database type or a custom database type. For example, MYSQL, ORACLE, POSTGRESQL, SQL_SERVER, COCKROACHDB, DB2, SQLANYWHERE, SYBASE, SYBASEIQ, or YUGABYTE.

    • isSampleProject boolean
    • id string Required

      Format should match the following pattern: ^[A-Za-z0-9\-]+$.
  • 485 application/json

    Unknown issue occurred during project import

    Hide response attributes Show response attributes object
    • jobId string

      Format should match the following pattern: ^[A-Za-z0-9\-]+$.

    • message string Required
    • description string
    • timestamp string(date-time) Required
  • 486 application/json

    Field not found during project import

    Hide response attributes Show response attributes object
    • jobId string

      Format should match the following pattern: ^[A-Za-z0-9\-]+$.

    • message string Required
    • description string
    • timestamp string(date-time) Required
  • 487 application/json

    Project version invalid during import

    Hide response attributes Show response attributes object
    • jobId string

      Format should match the following pattern: ^[A-Za-z0-9\-]+$.

    • message string Required
    • description string
    • timestamp string(date-time) Required
POST /project/import 
curl \
 --request POST 'http://127.0.0.1:8278/api/v1/project/import' \
 --header "Content-Type: application/json"
Request examples 
{}
Response examples (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"
}
Response examples (485) 
{
  "jobId": "string",
  "message": "string",
  "description": "string",
  "timestamp": "2025-05-04T09:42:00Z"
}
Response examples (486) 
{
  "jobId": "string",
  "message": "string",
  "description": "string",
  "timestamp": "2025-05-04T09:42:00Z"
}
Response examples (487) 
{
  "jobId": "string",
  "message": "string",
  "description": "string",
  "timestamp": "2025-05-04T09:42:00Z"
}