Create a task for pre-migration analysis

POST /analysis/{projectId}/task

Create a task for pre-migration analysis.

Path parameters

  • projectId string Required

    Project ID

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

application/json

Body Required

  • jdbcConnectionDetails object Required

    Additional properties are NOT allowed.

    Hide jdbcConnectionDetails attributes Show jdbcConnectionDetails attributes object
    • id string
    • type string Required

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

    • url string Required
    • user string
    • password string
    • savePassword boolean

      Default value is false.

    • existingConnectionId string
    • oraclePdbName string
    • isManualUri boolean

      Default value is false.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • projectId string Required

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

    • status string Required

      Values are RUNNING, FAILED, CANCELLED, or COMPLETED.

    • submittedAt string(date-time) Required
  • 433 application/json

    Trouble connecting to SQL database with provided information

    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 /analysis/{projectId}/task 
curl \
 --request POST 'http://127.0.0.1:8278/api/v1/analysis/{projectId}/task' \
 --header "Content-Type: application/json" \
 --data '{"jdbcConnectionDetails":{"id":"string","type":"ORACLE","url":"string","user":"string","password":"string","savePassword":false,"existingConnectionId":"string","oraclePdbName":"string","isManualUri":false}}'
Request examples 
{
  "jdbcConnectionDetails": {
    "id": "string",
    "type": "ORACLE",
    "url": "string",
    "user": "string",
    "password": "string",
    "savePassword": false,
    "existingConnectionId": "string",
    "oraclePdbName": "string",
    "isManualUri": false
  }
}
Response examples (200) 
{
  "projectId": "string",
  "status": "RUNNING",
  "submittedAt": "2025-05-04T09:42:00Z"
}
Response examples (433) 
{
  "jobId": "string",
  "message": "string",
  "description": "string",
  "timestamp": "2025-05-04T09:42:00Z"
}