Sorry, we didn't find any relevant articles for you.

Send us your queries using the form below and we will get back to you with a solution.

GMUS API - Create XTS File

April Hatton
·
Updated May 16th, 2026
·
0.7 min read

Description

You can use the REST API to create an XTS file using a GMUS request. The request is put in the queue and will create an XTS file in the output directory, which you can then download using the Download API.

Prerequisites

REST Request

A REST request is made to the GMUS to create an XTS file.

Method Type: POST

Request URL

http://<IP ADDRESS>:<port>/rest/createXTS

Example URL

http://0.0.0.0:8090/rest/createXTS

JSON Payload

{
  "clientAppId" : <Client App Id>
  "clientUserId": <Client User Id>
  "username" : <GenRocket Username>
  "profileId": <PROFILE_ID>
  "configFilePath": <CONFIG_FILE_PATH>,
  "configFileSubDir": <CONFIG_FILE_SUB_DIR Optional>,
  "configName": <CONFIG_FILE_NAME>,
  "tables": "<Comma separated table names (Optional)>",
  "excludeTables": "<Comma separated Exclude table names (Optional)>",
  "excludeFilePath": "<Exclude File path Optional. Override excludeTables>"
}

Payload Example

An XTS file will be created for the Customer and Address tables.

{
  "clientAppId" : "XXXXXXXX-1e47-abcd-ba66-XXXXXXXXXXXX",
  "clientUserId": "XXXXXXXX-abcd-4284-aa45-XXXXXXXXXXXX",
  "username" : "jane.doe@gmail.com",
  "profileId": "GR100002",
  "configFilePath": "home/username/output",
  "configFileSubDir": "config",
  "configName": "config.properties",
  "tables": "Customer, Address"
}