Difference between revisions of "Command Center API Reference"

From Lingoport Wiki
Jump to: navigation, search
(Created page with "= Introduction = = List Command Center projects = curl "COMMAND_CENTER_URL/api/listprojects" -d '{"username":"API_USER","token":"API_TOKEN"}' --header "Content-Type: ap...")
 
(Command Center Translate)
 
(10 intermediate revisions by 2 users not shown)
Line 10: Line 10:
   
 
or
 
or
curl "https://dockertest2.lingoport.io/command-center/api/listprojects" -d @listprojects.json --header "Content-Type: application/json"
+
curl "https://dockertest2.lingoport.io/command-center/api/listprojects" -d @'''listprojects.json''' --header "Content-Type: application/json"
   
listprojects.json:
+
'''listprojects.json''':
 
{
 
{
 
"username":"figmaAPI",
 
"username":"figmaAPI",
Line 18: Line 18:
 
}
 
}
   
= Get Command Center Project Status =
+
= Command Center Project Status =
   
   
Line 28: Line 28:
   
 
or
 
or
curl "http://localhost:8080/command-center/api/getStatus" -d @getStatus.json --header "Content-Type: application/json"
+
curl "http://localhost:8080/command-center/api/getStatus" -d @'''getStatus.json''' --header "Content-Type: application/json"
   
getStatus.json:
+
'''getStatus.json:'''
  +
{
  +
"username":"figmaAPI",
  +
"token":"CTMNzj**********CP",
  +
"source":{
  +
"group_name": "Lingport",
  +
"project_name": "CET-WorldWindExplorer",
  +
"module_name": "lili"
  +
}
  +
}
  +
  +
= Command Center Translate =
  +
  +
  +
curl "COMMAND_CENTER_URL/api/translate" -d '{"username":"API_USER","token":"API_TOKEN", "source":{"group_name": "GROUP","project_name": "PROJECT","module_name": "MODULE"}}' --header "Content-Type: application/json"
  +
  +
  +
Example:
  +
curl "http://localhost:8080/command-center/api/translate" -d '{"username":"figmaAPI","token":"CTMNzj**********CP", "source":{"group_name": "Lingoport","project_name": "CET-WorldWindExplorer","module_name": "lili"}}' --header "Content-Type: application/json"
  +
  +
or
  +
curl "http://localhost:8080/command-center/api/translate" -d @'''translate.json''' --header "Content-Type: application/json"
  +
  +
'''translate.json:'''
  +
{
  +
"username":"figmaAPI",
  +
"token":"CTMNzj**********CP",
  +
"source":{
  +
"group_name": "Lingport",
  +
"project_name": "CET-WorldWindExplorer",
  +
"module_name": "lili"
  +
}
  +
}
  +
  +
= Pseudo-localize a Command Center Project =
  +
  +
  +
curl "COMMAND_CENTER_URL/api/pseudoloc" -d '{"username":"API_USER","token":"API_TOKEN", "source":{"group_name": "GROUP","project_name": "PROJECT","module_name": "MODULE"}}' --header "Content-Type: application/json"
  +
  +
  +
Example:
  +
curl "http://localhost:8080/command-center/api/pseudoloc" -d '{"username":"figmaAPI","token":"CTMNzj**********CP", "source":{"group_name": "Lingoport","project_name": "CET-WorldWindExplorer","module_name": "lili"}}' --header "Content-Type: application/json"
  +
  +
or
  +
curl "http://localhost:8080/command-center/api/pseudoloc" -d @'''project.json''' --header "Content-Type: application/json"
  +
  +
'''project.json:'''
 
{
 
{
 
"username":"figmaAPI",
 
"username":"figmaAPI",
Line 53: Line 99:
   
 
Example:
 
Example:
For a target repository name https://github.com/Lingoport/Command-Center, branch 'liliDev', with a template called Lingoport Command-Center liliDev in Command Center using https://github.com, the following call would be make:
+
For a target repository name https://github.com/Lingoport/Command-Center, branch 'liliDev', with a template called '''Lingoport Command-Center dev''' in Command Center using https://github.com, the following call would be make:
   
 
curl "http://localhost:8080/command-center/api/createFromTemplateProject" -d '{"username":"figmaAPI","token":"CTMNzj**********CP","source": {"group_name": "Lingoport","project_name": "Command-Center","module_name": "dev"},"target": {"group_name":"Lingoport","project_name": "Command-Center","module_name": "liliDev"}}' --header "Content-Type: application/json"
 
curl "http://localhost:8080/command-center/api/createFromTemplateProject" -d '{"username":"figmaAPI","token":"CTMNzj**********CP","source": {"group_name": "Lingoport","project_name": "Command-Center","module_name": "dev"},"target": {"group_name":"Lingoport","project_name": "Command-Center","module_name": "liliDev"}}' --header "Content-Type: application/json"
Line 59: Line 105:
 
or
 
or
   
curl "COMMAND_CENTER_URLapi/createFromTemplateProject" -d @dupProject.json --header "Content-Type: application/json"
+
curl "COMMAND_CENTER_URLapi/createFromTemplateProject" -d '''@dupProject.json''' --header "Content-Type: application/json"
   
dupProject.json:
+
'''dupProject.json''':
 
{
 
{
 
"username":"figmaAPI",
 
"username":"figmaAPI",
Line 67: Line 113:
 
"source":{
 
"source":{
 
"group_name": "Lingport",
 
"group_name": "Lingport",
"project_name": "CET-WorldWindExplorer",
+
"project_name": "Command-Center",
"module_name": "lili"
+
"module_name": "dev"
 
},
 
},
 
"target": {
 
"target": {
 
"group_name":"Lingoport",
 
"group_name":"Lingoport",
"project_name": "CET-WorldWindExplorer",
+
"project_name": "Command-Center",
"module_name": "testing"
+
"module_name": "liliDev"
 
}
 
}
 
}
 
}

Latest revision as of 16:44, 18 April 2024

Introduction

List Command Center projects

 curl "COMMAND_CENTER_URL/api/listprojects" -d '{"username":"API_USER","token":"API_TOKEN"}'  --header "Content-Type: application/json"

Example:

 curl "http://localhost:8080/command-center/api/listprojects" -d '{"username":"figmaAPI","token":"CTMNzj**********CP"}'  --header "Content-Type: application/json"

or

 curl "https://dockertest2.lingoport.io/command-center/api/listprojects" -d @listprojects.json --header "Content-Type: application/json"
 listprojects.json:
 {
  "username":"figmaAPI",
  "token":"CTMNzj**********CP"
 }

Command Center Project Status

 curl "COMMAND_CENTER_URL/api/getStatus" -d '{"username":"API_USER","token":"API_TOKEN", "source":{"group_name": "GROUP","project_name": "PROJECT","module_name": "MODULE"}}'  --header "Content-Type: application/json"


Example:

 curl "http://localhost:8080/command-center/api/getStatus" -d '{"username":"figmaAPI","token":"CTMNzj**********CP", "source":{"group_name": "Lingoport","project_name": "CET-WorldWindExplorer","module_name": "lili"}}'  --header "Content-Type: application/json"

or

 curl "http://localhost:8080/command-center/api/getStatus" -d @getStatus.json  --header "Content-Type: application/json"
 getStatus.json: 
 {
    "username":"figmaAPI",
    "token":"CTMNzj**********CP",
    "source":{
        "group_name": "Lingport",
        "project_name": "CET-WorldWindExplorer",
        "module_name": "lili"
     }
 }

Command Center Translate

 curl "COMMAND_CENTER_URL/api/translate" -d '{"username":"API_USER","token":"API_TOKEN", "source":{"group_name": "GROUP","project_name": "PROJECT","module_name": "MODULE"}}'  --header "Content-Type: application/json"


Example:

 curl "http://localhost:8080/command-center/api/translate" -d '{"username":"figmaAPI","token":"CTMNzj**********CP", "source":{"group_name": "Lingoport","project_name": "CET-WorldWindExplorer","module_name": "lili"}}'  --header "Content-Type: application/json"

or

 curl "http://localhost:8080/command-center/api/translate" -d @translate.json  --header "Content-Type: application/json"
 translate.json: 
 {
    "username":"figmaAPI",
    "token":"CTMNzj**********CP",
    "source":{
        "group_name": "Lingport",
        "project_name": "CET-WorldWindExplorer",
        "module_name": "lili"
     }
 }

Pseudo-localize a Command Center Project

 curl "COMMAND_CENTER_URL/api/pseudoloc" -d '{"username":"API_USER","token":"API_TOKEN", "source":{"group_name": "GROUP","project_name": "PROJECT","module_name": "MODULE"}}'  --header "Content-Type: application/json"


Example:

 curl "http://localhost:8080/command-center/api/pseudoloc" -d '{"username":"figmaAPI","token":"CTMNzj**********CP", "source":{"group_name": "Lingoport","project_name": "CET-WorldWindExplorer","module_name": "lili"}}'  --header "Content-Type: application/json"

or

 curl "http://localhost:8080/command-center/api/pseudoloc" -d @project.json  --header "Content-Type: application/json"
 project.json: 
 {
    "username":"figmaAPI",
    "token":"CTMNzj**********CP",
    "source":{
        "group_name": "Lingport",
        "project_name": "CET-WorldWindExplorer",
        "module_name": "lili"
     }
 }

Duplicate Command Center project

 curl "COMMAND_CENTER_URLapi/createFromTemplateProject" -d '{"username":"API_USER","token":"API_TOKEN","source": {"group_name": "source_group","project_name": "source_project","module_name": "source_module"},"target": {"group_name":"target_group","project_name": "target_project","module_name": "target_module"}}'  --header "Content-Type: application/json"


  • For Git projects:
    • The target group name is the name of the Git organization
    • The target project name is the name of the Git project in that organization
    • The target module name is the branch of the Git Project in the organization


Example: For a target repository name https://github.com/Lingoport/Command-Center, branch 'liliDev', with a template called Lingoport Command-Center dev in Command Center using https://github.com, the following call would be make:

 curl "http://localhost:8080/command-center/api/createFromTemplateProject" -d '{"username":"figmaAPI","token":"CTMNzj**********CP","source": {"group_name": "Lingoport","project_name": "Command-Center","module_name": "dev"},"target": {"group_name":"Lingoport","project_name": "Command-Center","module_name": "liliDev"}}'  --header "Content-Type: application/json"

or

 curl "COMMAND_CENTER_URLapi/createFromTemplateProject" -d @dupProject.json  --header "Content-Type: application/json"
 dupProject.json:
  {
    "username":"figmaAPI",
    "token":"CTMNzj**********CP",
    "source":{
        "group_name": "Lingport",
        "project_name": "Command-Center",
        "module_name": "dev"
     },
     "target": {
         "group_name":"Lingoport",
         "project_name": "Command-Center",
         "module_name": "liliDev"
      }
  }

The dupProject.json file can be used for all the commands. Only the required values will be used.