GMUS API: Launch G-Subset (formerly G-Migration+)

Description

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

REST Request

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

http://<ip>:port/rest/subset (new)

http://<ip> port/rest/migrate (old - will be deprecated March 27, 2026)

Method Type: POST

JSON Payload

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

{
  "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"
}

{ 
  "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" 
}

{  
  success": true,
}