Description

The API in this article can be used to launch G-Migration+ through GMUS.


REST Request

A REST request is made to the GMUS to launch G-Migration+.

http://<ip>:port/rest/migrate


Method Type: POST


JSON Payload

JSON Payload to launch G-Migration+. Please note that the schemaName parameter must be included. Otherwise, the migration will not run successfully.


Example 1 - whereClause and Limit

{
  "clientAppId" : "XXXXXXXX-1e47-abcd-ba66-XXXXXXXXXXXX",
  "clientUserId": "XXXXXXXX-abcd-4284-aa45-XXXXXXXXXXXX",
  "username" : "jane.doe@gmail.com",
  "configPath": "home/username/output"
  "configName": "sample.gredb",
  "debug": true,
  "whereClause": "user.id<101",
  "limitType": "NUMBER",
  "limitValue": "300",
  "schemaName": "Company",
  "tableName": "user"
}


Example 2 - whereClause Only

{ 
  "clientAppId" : "XXXXXXXX-1e47-abcd-ba66-XXXXXXXXXXXX", 
  "clientUserId": "XXXXXXXX-abcd-4284-aa45-XXXXXXXXXXXX", 
  "username" : "jane.doe@gmail.com", 
  "configPath": "home/username/output" 
  "configName": "sample.gredb", 
  "whereClause": "user.id<101", 
  "schemaName": "Company",
  "tableName": "user" 
}


Example success response:


{  
  success": true,
}