Support

Description

The APIs in this article can be used to create a G-Repository Client Repo for a Project Version and check to see when the process has been completed. The method type is POST for these requests.

In This Article

• Create Client Repo for a Project Version
• Check Client Repo Creation Progress

Create Client Repo for a Project Version

A REST request is made to the GMUS to create a G-Reposiotry Client Repository for a Project Version.

http://<IPAddress>:<Port>/rest/repoClientCreate

JSON Payloads to create repo for project version:

{
  "profileId": "GR2XXXXXX",
  "repoName": "BankDemo",
  "serverURL": "localhost",
  "serverPort": "8020",
  "downloadPort": "8021",
  "projectName": "SampleProject",
  "projectVersion": "1.0",
  "baseDirectory": "#{homeDir}/Desktop/output/repoC"
}

Example success response: 

{
  success": true,
  "message": "G-Repository Client is currently in the process of creating <repoName>"
}

Check Client Repo Creation Progress

A REST request is made to the GMUS to check if G-Repository Client Repo creation has been completed or not. 

http://<IPAddress>:<Port>/rest/repoClientCheck

JSON Payloads to check for repo: 

{
  "username": "username@genrocket.com",
  "clientAppId": "XXXXXXXX-XXXX-4265-98d2-XXXXXXXXXXXX",
  "clientUserId": "XXXXXXXX-XXXX-4270-8474-XXXXXXXXXXXX",
  "repoName": "BankDemo",
  "baseDirectory": "#{homeDir}/Desktop/output/repoC"
}

Example success response: 

{
  "success": true,
  "message": "G-Repository Client is ready"
}

If the client repo is being created and not completed, the user will receive the following response: 

{
  "success": true,
  "message": "G-Repository Client is not ready yet for repo name, <repoName>"
}