API de la MetaServlet de Talend Administration Center

EnrichVersion
6.4
EnrichProdName
Talend Big Data
Talend Data Integration
Talend Real-Time Big Data Platform
Talend ESB
Talend Data Services Platform
Talend MDM Platform
Talend Data Fabric
Talend Big Data Platform
Talend Data Management Platform
task
Administration et monitoring > Gestion des utilisateurs
Administration et monitoring > Gestion des référentiels
Administration et monitoring > Monitoring des exécutions
Administration et monitoring > Gestion des serveurs
Administration et monitoring > Gestion des projets
Déploiement > Ordonnancement > Ordonnancement de Jobs
EnrichPlatform
Talend Administration Center

Commandes de l'API de la MetaServlet de Talend Administration Center

Cet article documente toutes les commandes qui peuvent être exécutées dans la MetaServlet. Si vous n'utilisez pas la dernière version de la MetaServlet, certaines des commandes suivantes peuvent être indisponibles. Il est recommandé de consulter la commande d'aide de la version de votre MetaServlet.

Commande d'aide exhaustive

Pour afficher l'aide exhaustive de toutes les commandes, suivez cette syntaxe :
MetaservletCaller.bat --tac-url=http://<IP_address>:<port>/<WebApplicationName> --help all

Résultat

Résultat de la commande --help :

 Generic return codes    : 
       0: Success
       1: Unknown error
       2: Invalid request
       3: Authentication error
       4: License problem
       5: Invalid parameter
       6: Error formatting response
       7: Insufficient right

----------------------------------------------------------
  Command: addLocks
----------------------------------------------------------
Description             : Allow to lock a repository item. Mainly used by the Studio.
Requires authentication : false
Since                   : 4.2
Sample                  : 
{
  "actionName": "addLocks",
  "applicationName": "Studio",
  "authUser": "john.smith@company.com",
  "branch": "trunk",
  "locks": [{
    "itemId": "id1",
    "itemLabel": "label1",
    "itemType": "repository.process"
  }],
  "projectName": "P1"
}

----------------------------------------------------------
  Command: addServer
----------------------------------------------------------
Description             : Create a new execution server, parameter username/password (optional) are used
for user authentication to access the JobServer,
- For server type EC2, you must set the parameter "awsEC2Server":"true",
- For server type Runtime, you must provide the "instance" property,
- option "awsEC2Server" and "instance" are incompatible
- For "timezone" property, refer to http://joda-time.sourceforge.net/timezones.html for more details on
the syntax
Requires authentication : true
Since                   : 4.2
Sample                  : 
{
  "accessKeyId": "youraccesskeyid",
  "actionName": "addServer",
  "activeAmiSelection": "true",
  "adminConsolePort": 8040,
  "authPass": "admin",
  "authUser": "admin@company.com",
  "awsEC2Server": "true",
  "commandPort": 8000,
  "description": "Talend runtime server in production",
  "filePort": 8001,
  "host": "localhost",
  "instance": "trun",
  "instanceLogin": "ubuntu",
  "instanceType": "t1.micro",
  "jobServerZipName": "Talend-JobServer-r114559-V5.6.0NB.zip",
  "jobServerZipPath": "E:\\TUP\\56\\webapps\\org.talend.administrator\\WEB-INF\\jobServerToAwsEC2\\
Talend-JobServer-r114559-V5.6.0NB.zip",
  "keyPair": "zwli2",
  "label": "serverName1",
  "mgmtRegPort": 1099,
  "mgmtServerPort": 44444,
  "monitoringPort": 8888,
  "password": 111111,
  "privateKey": "yourprivatekeypair",
  "regionId": "us-west-2",
  "runtimePassword": "password",
  "runtimeUsername": "name",
  "secretAccessKey": "yoursecretaccesskey",
  "securityGroup": "gg",
  "selectedAmiOS": "Ubuntu 12.04 t1.micro",
  "shutdownBehavior": "Stop",
  "timeoutUnknownState": "120",
  "timezoneId": "US/Hawaii",
  "useSSL": true,
  "username": "test@company.com"
}
Specific error codes    : 
       235: The timezoneId value is not found.
       236: The "instance" and "awsEC2Server" properties are incompatible.

----------------------------------------------------------
  Command: addServersToVirtualServer
----------------------------------------------------------
Description             : Add servers to a virtual server
Requires authentication : true
Since                   : 5.6
Sample                  : 
{
  "actionName": "addServersToVirtualServer",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "servers": [
    {"serverId": "1"},
    {"serverId": "2"}
  ],
  "virtualServerId": "1"
}

----------------------------------------------------------
  Command: addUsersToUserGroup
----------------------------------------------------------
Description             : Add users to User Group
Requires authentication : true
Since                   : 6.2
Sample                  : 
{
  "actionName": "addUsersToUserGroup",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "id": "1",
  "users": [
    {"id": "10"},
    {"id": "21"}
  ]
}

----------------------------------------------------------
  Command: associatePreGeneratedJob
----------------------------------------------------------
Description             : Create a new execution task with a pre-generated zip file
- targetConductor: could be [JOBCONDUCTOR, BIGDATA_STREAMING]. "JOBCONDUCTOR" is the default value.
- nexusRepository: if create task from Nexus, using parameters:
nexusRepository/nexusGroupId/nexusArtifactId/nexusVersion[/nexusJobVersionSuffix].
- nexusJobVersionSuffix: [Optional] use it when job in nexus with named like test-1.0.0-20170516.043751-1.zip
- taskType: [Optional] Distinguish task type: Normal/Artifact, default: Normal
- importType: the position where select the zip file from; 'Nexus' or 'File', default value is 'File'
Requires authentication : true
Since                   : 5.2
Sample                  : 
{
  "actionName": "associatePreGeneratedJob",
  "active": true,
  "authPass": "admin",
  "authUser": "admin@company.com",
  "contextName": "Default",
  "description": "task1's description",
  "executionServerName": "serv1",
  "filePath": "'/home/talend/generatedJob.zip'",
  "importType": "Nexus",
  "logLevel": "Info",
  "nexusArtifactId": "test",
  "nexusGroupId": "org.example",
  "nexusJobVersionSuffix": "1.0.0-20170516.043751-1",
  "nexusRepository": "snapshots",
  "nexusVersion": "0.1.0-SNAPSHOT",
  "onUnknownStateJob": "WAIT",
  "pauseOnError": false,
  "taskName": "task1",
  "taskType": "Artifact",
  "timeout": 3600
}
Specific error codes    : 
       180: file is not a valid file or not exist
       181: nexus parameters may be not correct

----------------------------------------------------------
  Command: branchExist
----------------------------------------------------------
Description             : Returns true if the project contains the branch.
Requires authentication : true
Since                   : 6.0
Sample                  : 
{
  "actionName": "branchExist",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "branch": "branches/branch1",
  "projectName": "project1"
}

----------------------------------------------------------
  Command: createAuthorization
----------------------------------------------------------
Description             : Add user/group authorization to a project.
- authorizationType can be [ReadWrite, ReadOnly]
- authorizationEntity can be [User, Group], default value is "User"
Requires authentication : true
Since                   : 3.2
Sample                  : 
{
  "actionName": "createAuthorization",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "authorizationEntity": "User",
  "authorizationType": "ReadWrite",
  "groupLabel": "group",
  "projectName": "project",
  "userLogin": "user@company.com"
}
Specific error codes    : 
       161: The authorizationType specified does not exist.
       162: The authorizationEntity specified does not exist.

----------------------------------------------------------
  Command: createBranch
----------------------------------------------------------
Description             : Create a branch into a project
Requires authentication : true
Since                   : 4.2
Sample                  : 
{
  "actionName": "createBranch",
  "addToWhiteList": "true",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "projectName": "project1",
  "source": "trunk",
  "target": "branches/branch1"
}
Specific error codes    : 
       150: Database error while creating branch.

----------------------------------------------------------
  Command: createProject
----------------------------------------------------------
Description             : Create a new SVN or GIT project and return the project ID. 'trunk',
'branches' & 'tags' folders will also be created when creaating a SVN project.
- TAC will get SVN/GIT url from configuration when 'projectSvnLocation/projectGitLocation' is not provided;
- When use 'projectSvnLocation/projectGitLocation', then 'svnLogin/gitLogin' and 'svnPassword/gitPassword'
must be provided
- setting for 'svnCommitMode/gitCommitMode', 'svnCommitMode/gitLockMode' and 'svnUserLog/gitUserLog'
is optional 
- 'svnCommitMode/gitCommitMode' : [AUTO|SEMI] AUTO for 'Automatic', SEMI for 'Unlocked Items', default value is AUTO
- 'svnLockMode/gitLockMode' : [AUTO|ASK|MANUAL] AUTO for 'Automatic', ASK for 'Ask user', MANUAL for 'Manual', 
default value is AUTO
- 'svnUserLog/gitUserLog' :[true|false], default value is false
Requires authentication : true
Since                   : 3.2
Sample                  : 
{
  "actionName": "createProject",
  "addTechNameAtURL": true,
  "authPass": "admin",
  "authUser": "admin@company.com",
  "projectName": "project1",
  "projectType": "[DI|DQ|MDM] (optional)",
  "storage": "[svn|git|none] (default is 'git')"
}
Specific error codes    : 
       10: Svn url not set in configuration
       11: Git url not set in configuration

----------------------------------------------------------
  Command: createProjectReference
----------------------------------------------------------
Description             : Create project references for the specified project and branch 
(referenceProjects should use technical label)
Requires authentication : true
Since                   : 5.3
Sample                  : 
{
  "actionName": "createProjectReference",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "branch": "trunk",
  "projectName": "project1",
  "referenceProjects": "Q1/trunk,Q2/branches/branch1,Q3/tags/tag1"
}

----------------------------------------------------------
  Command: createSandboxProject
----------------------------------------------------------
Description             : Allows to create a Sandbox project (internal use)
Requires authentication : false
Since                   : 4.2
Sample                  : 
{
  "actionName": "createSandboxProject",
  "projectName": "MetaProject2",
  "userFirstName": "David",
  "userLastName": "Bowie",
  "userLogin": "userSandbox4@talend.com",
  "userPassword": "admin"
}

----------------------------------------------------------
  Command: createServerProjectAuthorization
----------------------------------------------------------
Description             : Add server authorization to a project.
- application will retrive job server if argument'isVirtualServer' is omitted
Requires authentication : true
Since                   : 6.1
Sample                  : 
{
  "actionName": "createServerProjectAuthorization",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "isVirtualServer": false,
  "projectName": "projectA",
  "serverName": "jobServerA"
}

----------------------------------------------------------
  Command: createTag
----------------------------------------------------------
Description             : Create a tag into a project
Requires authentication : true
Since                   : 5.3
Sample                  : 
{
  "actionName": "createTag",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "projectName": "project1",
  "source": "trunk",
  "target": "tags/tag-1_0"
}
Specific error codes    : 
       151: Database error while creating tag.

----------------------------------------------------------
  Command: createTask
----------------------------------------------------------
Description             : Add a new execution task in TAC and return the task ID.
- projectName and jobName: the project and job must exist.
- onUnknownStateJob: could be [WAIT, KILL_TASK, RESTART_TASK, RECOVER_TASK]
- contextName: "Default" is the default value.
- pauseOnError :if set to true, pause all the triggers on the task when the task fail.
- targetConductor: could be [JOBCONDUCTOR, BIGDATA_STREAMING]. "JOBCONDUCTOR" is the default value.
Requires authentication : true
Since                   : 5.0
Sample                  : 
{
  "actionName": "createTask",
  "active": true,
  "applyContextToChildren": false,
  "authPass": "admin",
  "authUser": "admin@company.com",
  "branch": "trunk",
  "contextName": "Default",
  "description": "task1 for extracting data from DB1",
  "execStatisticsEnabled": false,
  "executionServerName": "serv1",
  "jobName": "job1",
  "jobVersion": "1.0",
  "onUnknownStateJob": "WAIT",
  "pauseOnError": false,
  "projectName": "tproject1",
  "regenerateJobOnChange": false,
  "taskName": "task1",
  "timeout": 3600
}

----------------------------------------------------------
  Command: createTrigger
----------------------------------------------------------
Description             : Create a trigger.
- 'taskId' : it could be the task id, exec plan id, esb publisher id
- 'timezoneOption': must be one of those values [JOBSERVER_TIMEZONE, TAC_TIMEZONE, CUSTOM_TIMEZONE]
- if this option is 'CUSTOM_TIMEZONE', the field 'timezone' becomes mandatory.
- For "timezone" property, refer to http://joda-time.sourceforge.net/timezones.html for more details
on the syntax
- 'pauseOnError' : if set to true, pause the trigger when the task fail.
Requires authentication : true
Since                   : 5.6
Sample                  : 
{"Samples": [
  {
    "actionName": "createTrigger",
    "authPass": "admin",
    "authUser": "admin@company.com",
    "description": "This is a simple trigger",
    "endTime": "2016-12-31 23:59:59",
    "label": "SimpleTrigger1",
    "pauseOnError": true,
    "repeatCount": 10,
    "repeatInterval": 120,
    "startTime": "2016-12-31 11:40:16",
    "taskId": 1,
    "timezone": "'Europe/Paris'",
    "timezoneOption": "CUSTOM_TIMEZONE",
    "triggerType": "SimpleTrigger"
  },
  {
    "actionName": "createTrigger",
    "authPass": "admin",
    "authUser": "admin@company.com",
    "daysOfMonth": "10",
    "description": "This is a cron trigger",
    "hours": "5,10",
    "label": "CronTrigger1",
    "minutes": "1,10",
    "months": "*",
    "pauseOnError": true,
    "taskId": 1,
    "timezoneOption": "JOBSERVER_TIMEZONE",
    "triggerType": "CronTrigger",
    "years": "2016"
  },
  {
    "actionName": "createTrigger",
    "authPass": "admin",
    "authUser": "admin@company.com",
    "checkTimeInterval": 120,
    "created": true,
    "description": "This is a file trigger",
    "executionServerId": 1,
    "exist": true,
    "fileMask": "*",
    "folderPath": "/home/tac",
    "label": "FileTrigger1",
    "modified": false,
    "pauseOnError": true,
    "taskId": 1,
    "triggerType": "FileTrigger"
  }
]}

----------------------------------------------------------
  Command: createUser
----------------------------------------------------------
Description             : create a new user.
- 'count_policy' : [NAMED|CONCURRENT] NAMED for 'Named users', CONCURRENT for 'Concurrent users',
default value is CONCURRENT
- 'userDn' : Distinguished Name. When LDAP enabled, only allow to create LDAP user.
Requires authentication : true
Since                   : 3.2
Sample                  : 
{
  "actionName": "createUser",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "bigData": true,
  "count_policy": "NAMED",
  "dataPrep": true,
  "dataPrepRole": [
    "Administrator",
    "Dataset Manager",
    "Data Preparator"
  ],
  "tds": true,
  "tdsRole": [
    "Data Steward",
    "Campaign Owner"
  ],
  "userDn": "cn=jsmith,ou=test,dc=company,dc=com",
  "userFirstName": "john",
  "userGitLogin": "jsmith",
  "userGitPassword": "7ob5iT3c",
  "userGroup": [],
  "userLastName": "smith",
  "userLogin": "john.smith@company.com",
  "userPassword": "kkE432",
  "userRole": [
    "Administrator",
    "Designer"
  ],
  "userSvnLogin": "jsmith",
  "userSvnPassword": "gvZ543uc",
  "userType": "DI"
}
Specific error codes    : 
       100: Database error while creating a new User.
       101: Not enough allowed users available against license.

----------------------------------------------------------
  Command: createUserGroup
----------------------------------------------------------
Description             : create a new user group. dataPrepRoles is only valid when type is DP.
tdsRoles is only valid when type is TDS
- 'type' : [DI_ESB|DQ|MDM|DP|TDS]
- 'dataPrepRoles' : [Administrator|Dataset Manager|Data Preparator]
- 'tdsRoles' : [Data Steward|Campaign Owner]
Requires authentication : true
Since                   : 6.2
Sample                  : 
{
  "actionName": "createUserGroup",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "description": "User group for testing perpose",
  "label": "Test Group",
  "type": "DI_ESB"
}

----------------------------------------------------------
  Command: createVirtualServer
----------------------------------------------------------
Description             : Create a virtual execution server
- For "timezone" property, refer to http://joda-time.sourceforge.net/timezones.html
for more details on the syntax
Requires authentication : true
Since                   : 5.6
Sample                  : 
{
  "actionName": "createVirtualServer",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "clusterGroup": "Cellar1",
  "description": "Talend virtual server in production",
  "label": "VirtualServerName",
  "timezone": "US/Pacific"
}
Specific error codes    : 
       238: The timezoneId value is not found.

----------------------------------------------------------
  Command: deleteBranch
----------------------------------------------------------
Description             : Delete branches/tags
Requires authentication : true
Since                   : 5.6
Sample                  : 
{
  "actionName": "deleteBranch",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "branchLabel": "branches/eva",
  "projectId": "1"
}
Specific error codes    : 
       237: A studio is connected to your project's branch

----------------------------------------------------------
  Command: deleteEsbTask
----------------------------------------------------------
Description             : Delete a Esb execution task in TAC.
- taskId: taskId must exist.
Requires authentication : true
Since                   : 6.1
Sample                  : 
{
  "actionName": "deleteEsbTask",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "taskId": 1
}

----------------------------------------------------------
  Command: deletePlan
----------------------------------------------------------
Description             : Delete a execution plan in TAC.
- planId: planId must exist.
- deleteRelatedData: true to remove all of the related logs and archives.
Requires authentication : true
Since                   : 5.6
Sample                  : 
{
  "actionName": "deletePlan",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "deleteAllRelatedData": true,
  "planId": "7"
}

----------------------------------------------------------
  Command: deleteProject
----------------------------------------------------------
Description             : Delete a project.
Requires authentication : true
Since                   : 3.2
Sample                  : 
{
  "actionName": "deleteProject",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "projectName": "project1"
}

----------------------------------------------------------
  Command: deleteProjectReference
----------------------------------------------------------
Description             : Delete project references for the specified project and branch
(referenceProjects should use technical label)
Requires authentication : true
Since                   : 5.6
Sample                  : 
{
  "actionName": "deleteProjectReference",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "branch": "trunk",
  "projectName": "project1",
  "referenceProjects": "Q1/trunk,Q2/branches/branch1,Q3/tags/tag1"
}

----------------------------------------------------------
  Command: deleteTask
----------------------------------------------------------
Description             : Delete a new execution task in TAC.
- taskId: taskId must exist.
- deleteRelatedData: true to remove all of the related logs and archives.
Requires authentication : true
Since                   : 5.4
Sample                  : 
{
  "actionName": "deleteTask",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "deleteAllRelatedData": true,
  "taskId": "7"
}
Specific error codes    : 
       5: No task with this taskId
       230: Task is processing during deletion

----------------------------------------------------------
  Command: deleteTrigger
----------------------------------------------------------
Description             : Delete a trigger
Requires authentication : true
Since                   : 5.6
Sample                  : 
{
  "actionName": "deleteTrigger",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "id": "1"
}

----------------------------------------------------------
  Command: deleteUser
----------------------------------------------------------
Description             : Delete one user
Requires authentication : true
Since                   : 3.2
Sample                  : 
{
  "actionName": "deleteUser",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "userLogin": "john.smith@company.com"
}
Specific error codes    : 
       92: Database error while deleting User.
       93: The user is the last administrator, he can't be removed.

----------------------------------------------------------
  Command: enableSandboxProject
----------------------------------------------------------
Description             : Tells if Sandbox project feature is enabled in configuration.
Requires authentication : false
Since                   : 4.2
Sample                  : 
{"actionName": "enableSandboxProject"}

----------------------------------------------------------
  Command: getArtifactLocation
----------------------------------------------------------
Description             : Get the Nexus/Archiva artifact location informations
Requires authentication : true
Since                   : 6.4
Sample                  : 
{
  "actionName": "getArtifactLocation",
  "authPass": "admin",
  "authUser": "admin@company.com"
}
Specific error codes    : 
       172: The artifact type is illegal..

----------------------------------------------------------
  Command: getCmdLineInfo
----------------------------------------------------------
Description             : Displays the host/port of the active command line.
At least primary or secondary command line must be running.
Requires authentication : true
Since                   : 3.2
Sample                  : 
{
  "actionName": "getCmdLineInfo",
  "authPass": "admin",
  "authUser": "admin@company.com"
}
Specific error codes    : 
       20: Both command line are down

----------------------------------------------------------
  Command: getDroolsKey
----------------------------------------------------------
Description             : Return a key to be used for Drools
Requires authentication : true
Since                   : 5.2
Sample                  : 
{
  "actionName": "getDroolsKey",
  "authPass": "admin",
  "authUser": "admin@company.com"
}

----------------------------------------------------------
  Command: getEsbTaskIdByName
----------------------------------------------------------
Description             : Get esb task id by given taskName
Requires authentication : true
Since                   : 6.1
Sample                  : 
{
  "actionName": "getEsbTaskIdByName",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "taskName": "task1"
}

----------------------------------------------------------
  Command: getEsbTaskNameById
----------------------------------------------------------
Description             : Get esb task name by given id
Requires authentication : true
Since                   : 6.1
Sample                  : 
{
  "actionName": "getEsbTaskNameById",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "taskId": 1
}

----------------------------------------------------------
  Command: getEsbTaskStatus
----------------------------------------------------------
Description             : Return the statuses of a specific esb task.
Requires authentication : true
Since                   : 6.1
Sample                  : 
{
  "actionName": "getEsbTaskStatus",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "taskId": 1
}

----------------------------------------------------------
  Command: getLibLocation
----------------------------------------------------------
Description             : Get the SVN/Nexus lib location infomations
Requires authentication : true
Since                   : 5.4
Sample                  : 
{
  "actionName": "getLibLocation",
  "authPass": "admin",
  "authUser": "admin@company.com"
}

----------------------------------------------------------
  Command: getLicenseKey
----------------------------------------------------------
Description             : Get license key and customer name.
- 'projectName': [Optional. Since 6.4.0] If you want to get license by project name,
you have to provide this parameter.
Requires authentication : true
Since                   : 5.2
Sample                  : 
{
  "actionName": "getLicenseKey",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "projectName": "project1"
}

----------------------------------------------------------
  Command: getNameByTaskId
----------------------------------------------------------
Description             : Get task name by given id
Requires authentication : true
Since                   : 5.1
Sample                  : 
{
  "actionName": "getNameByTaskId",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "taskId": 1
}

----------------------------------------------------------
  Command: getTaskExecutionStatus
----------------------------------------------------------
Description             : Return the statuses of a specific task execution.
Specify as parameter the response value 'execRequestId' returned previously by the command 'runTask'.
The returned object contains the key 'jobExitCode' only if the job is ended.
Requires authentication : true
Since                   : 5.6
Sample                  : 
{
  "actionName": "getTaskExecutionStatus",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "execRequestId": "1406705428611_7swji"
}

----------------------------------------------------------
  Command: getTaskIdByName
----------------------------------------------------------
Description             : Get task id by given taskName
Requires authentication : true
Since                   : 5.1
Sample                  : 
{
  "actionName": "getTaskIdByName",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "taskName": "task1"
}

----------------------------------------------------------
  Command: getTaskStatus
----------------------------------------------------------
Description             : Return the statuses of a specific task.
Requires authentication : true
Since                   : 4.2
Sample                  : 
{
  "actionName": "getTaskStatus",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "taskId": 1
}

----------------------------------------------------------
  Command: getTasksRelatedToJobs
----------------------------------------------------------
Description             : Return the complete list of tasks defined in the jobconductor
Requires authentication : true
Since                   : 5.0
Sample                  : 
{
  "actionName": "getTasksRelatedToJobs",
  "authPass": "admin",
  "authUser": "admin@company.com"
}

----------------------------------------------------------
  Command: getUpdateRepositoryUrl
----------------------------------------------------------
Description             : Returns Artifact repository connection information
Requires authentication : true
Since                   : 5.0
Sample                  : 
{
  "actionName": "getUpdateRepositoryUrl",
  "authPass": "admin",
  "authUser": "admin@company.com"
}
Specific error codes    : 
       42: Artifact repository url is not setup

----------------------------------------------------------
  Command: getUserInfo
----------------------------------------------------------
Description             : Return user information
Requires authentication : true
Since                   : 6.4
Sample                  : 
{
  "actionName": "getUserInfo",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "userLogin": "john.smith@company.com"
}

----------------------------------------------------------
  Command: help
----------------------------------------------------------
Description             : Displays the help
 - commandName is optional: <all> will print all the commands,<any command>
will print the detailed info of this command
Requires authentication : false
Since                   : 5.2
Sample                  : 
{
  "actionName": "help",
  "commandName": "help"
}

----------------------------------------------------------
  Command: importExecutionPlan
----------------------------------------------------------
Description             : Import the complete list of execution plans and tasks
related defined in the execution plan to DB
Requires authentication : true
Since                   : 5.4
Sample                  : 
{
  "actionName": "importExecutionPlan",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "result": {"ExecutionPlan": [{
    "desc": "desc",
    "errorStatus": "OK",
    "execPlanRollBack": "task1",
    "execPlanTimeOut": "3600",
    "idQuartzJob": "35",
    "label": "plan1",
    "requestId": "1382949884395_xLiwB",
    "status": "STOPPED"
  }]}
}
Specific error codes    : 
       223: Task not exist in the DB.
       224: Error appears when parsing the date.

----------------------------------------------------------
  Command: listConnection
----------------------------------------------------------
Description             : List dashboard connections
Requires authentication : false
Since                   : 4.2
Sample                  : 
{"actionName": "listConnection"}

----------------------------------------------------------
  Command: listEsbTasks
----------------------------------------------------------
Description             : Return the complete list of esb tasks defined in the esb conductor
Requires authentication : true
Since                   : 5.4
Sample                  : 
{
  "actionName": "listEsbTasks",
  "authPass": "admin",
  "authUser": "admin@company.com"
}

----------------------------------------------------------
  Command: listExecutionPlans
----------------------------------------------------------
Description             : Return the complete list of execution plans and tasks related
defined in the execution plan
Requires authentication : true
Since                   : 5.4
Sample                  : 
{
  "actionName": "listExecutionPlans",
  "authPass": "admin",
  "authUser": "admin@company.com"
}

----------------------------------------------------------
  Command: listLocks
----------------------------------------------------------
Description             : Returns all locked items for the specified project and branch
Requires authentication : false
Since                   : 4.2
Sample                  : 
{
  "actionName": "listLocks",
  "branch": "trunk",
  "projectName": "project1"
}

----------------------------------------------------------
  Command: listProjects
----------------------------------------------------------
Description             : Returns list of all projects
Requires authentication : true
Since                   : 5.4
Sample                  : 
{
  "actionName": "listProjects",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "onlyActive": true,
  "onlyGit": false,
  "onlySvn": false,
  "withReference": false
}

----------------------------------------------------------
  Command: listServer
----------------------------------------------------------
Description             : List all servers in tac.
Requires authentication : true
Since                   : 5.4
Sample                  : 
{
  "actionName": "listServer",
  "authPass": "admin",
  "authUser": "admin@company.com"
}

----------------------------------------------------------
  Command: listTasks
----------------------------------------------------------
Description             : Return the complete list of tasks defined in the jobconductor
Requires authentication : true
Since                   : 5.2
Sample                  : 
{
  "actionName": "listTasks",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "fastMode": "true"
}

----------------------------------------------------------
  Command: listTrigger
----------------------------------------------------------
Description             : List all trigger.
-taskId: if the taskId not provided, it list all the triggers; if it is provided,
it list all triggers related to the taskId
Requires authentication : true
Since                   : 5.6
Sample                  : 
{
  "actionName": "listTrigger",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "taskId": "1"
}

----------------------------------------------------------
  Command: listUserGroups
----------------------------------------------------------
Description             : List all user groups
Requires authentication : true
Since                   : 6.2
Sample                  : 
{
  "actionName": "listUserGroups",
  "authPass": "admin",
  "authUser": "admin@company.com"
}

----------------------------------------------------------
  Command: listUsers
----------------------------------------------------------
Description             : Returns list of users of the specified type.
If type is not specified, returns all users.
Requires authentication : true
Since                   : 5.3
Sample                  : 
{
  "actionName": "listUsers",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "type": "MDM"
}

----------------------------------------------------------
  Command: listVirtualServers
----------------------------------------------------------
Description             : List all virtual servers
Requires authentication : true
Since                   : 5.6
Sample                  : 
{
  "actionName": "listVirtualServers",
  "authPass": "admin",
  "authUser": "admin@company.com"
}

----------------------------------------------------------
  Command: migrateDatabase
----------------------------------------------------------
Description             : Database migration. 
- 'skipBackup' is optional, when set to true, be sure your database has been backed up.
Requires authentication : false
Since                   : 5.6
Sample                  : 
{"Samples": [
  {
    "actionName": "migrateDatabase",
    "dbConfigPassword": "admin",
    "mode": "synchronous",
    "skipBackup": false,
    "sourcePasswd": "dbPassword",
    "sourceUrl": "jdbc:mysql://127.0.0.1:3306/tac",
    "sourceUser": "dbUser"
  },
  {
    "actionName": "migrateDatabase",
    "dbConfigPassword": "admin",
    "mode": "synchronous",
    "sourcePasswd": "srcPassword",
    "sourceUrl": "jdbc:mysql://127.0.0.1:3306/tac",
    "sourceUser": "srcUser",
    "targetPasswd": "tagPassword",
    "targetUrl": "jdbc:oracle:thin:@192.168.31.110:1521:orcl",
    "targetUser": "tagUser"
  }
]}

----------------------------------------------------------
  Command: pauseTask
----------------------------------------------------------
Description             : Pause all the triggers of a specified task.
Requires authentication : true
Since                   : 5.1
Sample                  : 
{
  "actionName": "pauseTask",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "taskId": 1
}

----------------------------------------------------------
  Command: projectExist
----------------------------------------------------------
Description             : Returns true if the project exist.
Requires authentication : true
Since                   : 4.1
Sample                  : 
{
  "actionName": "projectExist",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "projectName": "project1"
}

----------------------------------------------------------
  Command: removeLocks
----------------------------------------------------------
Description             : Allow to unlock a repository item. Mainly used by the Studio.
Requires authentication : false
Since                   : 4.2
Sample                  : 
{
  "actionName": "removeLocks",
  "applicationName": "studio",
  "authUser": "john.smith@company.com",
  "branch": "trunk",
  "locks": [{
    "itemId": "_AMyZYFcAEeCQ34gn79PTjQ",
    "itemLabel": "BM2",
    "itemType": "repository.businessProcess"
  }],
  "projectName": "project1"
}

----------------------------------------------------------
  Command: removeServer
----------------------------------------------------------
Description             : Remove an execution server.
Requires authentication : true
Since                   : 4.2
Sample                  : 
{
  "actionName": "removeServer",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "serverId": 101
}

----------------------------------------------------------
  Command: removeServerProjectAuthorization
----------------------------------------------------------
Description             : Remove server authorization to a project.
- application will retrive job server if argument'isVirtualServer' is omitted
Requires authentication : true
Since                   : 6.1
Sample                  : 
{
  "actionName": "removeServerProjectAuthorization",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "isVirtualServer": false,
  "projectName": "projectA",
  "serverName": "jobServerA"
}

----------------------------------------------------------
  Command: removeServersFromVirtualServer
----------------------------------------------------------
Description             : Remove servers from a virtual Server
Requires authentication : true
Since                   : 5.6
Sample                  : 
{
  "actionName": "removeServersFromVirtualServer",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "servers": [
    {"serverId": "1"},
    {"serverId": "2"}
  ],
  "virtualServerId": "1"
}

----------------------------------------------------------
  Command: removeUsersFromUserGroup
----------------------------------------------------------
Description             : Remove Users from a User Group
Requires authentication : true
Since                   : 6.2
Sample                  : 
{
  "actionName": "removeUsersFromUserGroup",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "id": "1",
  "users": [
    {"id": "10"},
    {"id": "21"}
  ]
}

----------------------------------------------------------
  Command: removeVirtualServer
----------------------------------------------------------
Description             : remove virtual execution server
Requires authentication : true
Since                   : 5.6
Sample                  : 
{
  "actionName": "removeVirtualServer",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "id": "1"
}

----------------------------------------------------------
  Command: requestDeploy
----------------------------------------------------------
Description             : Deploy the job linked to the task given in parameter.
Requires authentication : true
Since                   : 5.0
Sample                  : 
{
  "actionName": "requestDeploy",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "taskId": 1
}
Specific error codes    : 
       170: Error while deploying the task

----------------------------------------------------------
  Command: requestDeployEsbTask
----------------------------------------------------------
Description             : Deploy the job linked to the esb task given in parameter.
Requires authentication : true
Since                   : 6.1
Sample                  : 
{
  "actionName": "requestDeployEsbTask",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "taskId": 1
}

----------------------------------------------------------
  Command: requestGenerate
----------------------------------------------------------
Description             : Generate the job linked to the task given in parameter.
Requires authentication : true
Since                   : 5.0
Sample                  : 
{
  "actionName": "requestGenerate",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "taskId": 1
}

----------------------------------------------------------
  Command: requestPauseTriggers
----------------------------------------------------------
Description             : Request to pause all the triggers of a task.
Requires authentication : true
Since                   : 5.0
Sample                  : 
{
  "actionName": "requestPauseTriggers",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "taskId": 1
}

----------------------------------------------------------
  Command: requestResumeTriggers
----------------------------------------------------------
Description             : Request to resume all the triggers of a task.
Requires authentication : true
Since                   : 5.0
Sample                  : 
{
  "actionName": "requestResumeTriggers",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "taskId": 1
}

----------------------------------------------------------
  Command: requestUndeployEsbTask
----------------------------------------------------------
Description             : Undeploy the job linked to the esb task given in parameter.
Requires authentication : true
Since                   : 6.1
Sample                  : 
{
  "actionName": "requestUndeployEsbTask",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "taskId": 1
}

----------------------------------------------------------
  Command: resetPassword
----------------------------------------------------------
Description             : Send a reset password link to the user login email address.
Requires authentication : false
Since                   : 6.2
Sample                  : 
{
  "actionName": "resetPassword",
  "userLogin": "john.smith@company.com"
}

----------------------------------------------------------
  Command: revokeLicenseKeyByValue
----------------------------------------------------------
Description             : revoke license for Talend Administrator Center from RM
Requires authentication : true
Since                   : 6.0
Sample                  : 
{
  "actionName": "revokeLicenseKeyByValue",
  "authPass": "admin",
  "authUser": "admin@company.com"
}

----------------------------------------------------------
  Command: runPlan
----------------------------------------------------------
Description             : Allow to run defined plan. Parameter 'queueIfNecessary'
- optional, and set false if not provided.
Requires authentication : true
Since                   : 6.4
Sample                  : 
{
  "actionName": "runPlan",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "planId": "1",
  "queueIfNecessary": "false"
}
Specific error codes    : 
       241: Error occurred while running the plan

----------------------------------------------------------
  Command: runPlanFromNode
----------------------------------------------------------
Description             : Allow to run a plan from a defined plan part node
Requires authentication : true
Since                   : 5.6
Sample                  : 
{
  "actionName": "runPlanFromNode",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "planId": "1",
  "planPartId": 5
}
Specific error codes    : 
       240: Error occurred while running the plan from plan part

----------------------------------------------------------
  Command: runTask
----------------------------------------------------------
Description             : Allows to run a task defined in Job conductor by its id.
Mode can be 'asynchronous' or 'synchronous'
Requires authentication : true
Since                   : 4.2
Sample                  : 
{
  "actionName": "runTask",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "jvmParams": [
    "-Xmx256m",
    "-Xms64m"
  ],
  "mode": "synchronous",
  "taskId": 1
}
Specific error codes    : 
       30: Error while launching task
       31: Thread interupted while running
       32: No right to run this task
       33: The parameter 'mode' must have the value 'synchronous' or 'asynchronous'

----------------------------------------------------------
  Command: saveEsbTask
----------------------------------------------------------
Description             : Add a new esb execution task in TAC and return the task ID.
- featureType: could be [ROUTE, SERVICE, GENERIC]
- runtimeContext: "Default" is the default value.
Requires authentication : true
Since                   : 5.4
Sample                  : 
{
  "actionName": "saveEsbTask",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "description": "esbTask1's description",
  "featureName": "DemoRESTConsumer-feature",
  "featureType": "ROUTE",
  "featureUrl": "mvn:org.example/DemoRESTConsumer-feature/0.1.0-SNAPSHOT/xml",
  "featureVersion": "0.1.0-SNAPSHOT",
  "repository": "repo-snapshot",
  "runtimeContext": "Default",
  "runtimePropertyId": "DemoRESTConsumer",
  "runtimeServerName": "serv1",
  "tag": "tag1",
  "taskName": "esbTask1"
}

----------------------------------------------------------
  Command: setLicenseKey
----------------------------------------------------------
Description             : Set a new license for Talend Administrator Center
Requires authentication : true
Since                   : 5.2
Sample                  : 
{
  "actionName": "setLicenseKey",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "licenseKeyPath": "c:/temp/TDQ_EE.license"
}
Specific error codes    : 
       110: license is not file or not exist
       111: license file operation failed

----------------------------------------------------------
  Command: setLicenseKeyByValue
----------------------------------------------------------
Description             : set license for Talend Administrator Center from RM
Requires authentication : true
Since                   : 6.0
Sample                  : 
{
  "actionName": "setLicenseKeyByValue",
  "authPass": "admin",
  "authUser": "admin@company.com"
}

----------------------------------------------------------
  Command: setRoleLimitation
----------------------------------------------------------
Description             : Remove or add module's right restriction to a role.
- userRole: must be one of those values [SECURITY_ADMIN_ROLE, ADMIN_ROLE,
DESIGNER_ROLE, OPERATION_MANAGER_ROLE, VIEWER_ROLE, CUSTOM_ROLE_1, CUSTOM_ROLE_2,
CUSTOM_ROLE_3, CUSTOM_ROLE_4, CUSTOM_ROLE_5, CUSTOM_ROLE_6, CUSTOM_ROLE_7,
CUSTOM_ROLE_8, CUSTOM_ROLE_9, CUSTOM_ROLE_10]
- rightKey: must be one of those values [LICENSE, CONFIG_MANAGMENT, CONFIG_READ,
SECURITY_CONFIG_MANAGMENT, SECURITY_CONFIG_READ, USERS_MANAGMENT, USERS_READ,
PROJECTS_MANAGMENT, PROJECTS_READ, LOCK_MANAGMENT, LOCK_READ, SERVERS_MANAGMENT,
SERVERS_READ, JOB_CONDUCTOR_MANAGMENT, JOB_CONDUCTOR_READ, AUDIT_MANAGMENT, AUDIT_READ,
SOA_MANAGMENT, DASH_SOA_MANAGMENT, SOA_READ, DASH_CONNECTIONS, DASH_JOBS, STUDIO,
STUDIO_ALL_READ, STUDIO_READ_MAX, NOTIFICATIONS_MANAGMENT, NOTIFICATIONS_READ,
DROOLS_READ, COMMANDLINE_MANAGMENT, BUSINESS_MODELER_MANAGMENT, BUSINESS_MODELER_READ,
DOCUMENTATION_MANAGMENT, SOFTWAREUPDATE, TAGS_CREATION, ESB_CONDUCTOR_READ,
ESB_CONDUCTOR_MGT, ESB_PUBLISHER_READ, ESB_PUBLISHER_MGT, ESB_SL_READ, ESB_SL_MGT,
ESB_SAM_READ, ESB_AUTH_READ, ESB_AUTH_MGT, ESB_SR_READ, ESB_SR_MGT, ESB_PROVI_READ,
ESB_PROVI_MGT, CONFIG_RIGHTS_MGT, DATABASE_BACKUP, PROJECT_REFERENCES_MGT]
- limitation: true if a restriction must applied, false otherwise.
Requires authentication : true
Since                   : 5.3
Sample                  : 
{
  "actionName": "setRoleLimitation",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "limitation": true,
  "rightKey": "SERVERS_READ",
  "userRole": "DESIGNER_ROLE"
}

----------------------------------------------------------
  Command: startEsbTask
----------------------------------------------------------
Description             : Start the execution of a given esb task
Requires authentication : true
Since                   : 6.1
Sample                  : 
{
  "actionName": "startEsbTask",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "taskId": 1
}

----------------------------------------------------------
  Command: stopEsbTask
----------------------------------------------------------
Description             : Stop the execution of a given esb task
Requires authentication : true
Since                   : 6.1
Sample                  : 
{
  "actionName": "stopEsbTask",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "taskId": 1
}

----------------------------------------------------------
  Command: stopTask
----------------------------------------------------------
Description             : Stop the execution of a given task
Requires authentication : true
Since                   : 5.1
Sample                  : 
{
  "actionName": "stopTask",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "taskId": 1
}

----------------------------------------------------------
  Command: taskLog
----------------------------------------------------------
Description             : Retrieve the logs of the specified task
- lastExecution: true/false(default). Get the lastest execution log or not.
Requires authentication : true
Since                   : 5.1
Sample                  : 
{
  "actionName": "taskLog",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "endTime": "\"2016-03-24 13:00:00\"",
  "lastExecution": false,
  "startTime": "\"2016-03-24 12:00:00\"",
  "taskId": 1
}
Specific error codes    : 
       220: Error happened when reading logs.
       225: Error happened when date range is illegal.
       226: Error appears when parsing the date.

----------------------------------------------------------
  Command: updateEsbTask
----------------------------------------------------------
Description             : Update and existing esb execution task in TAC and return the task ID.
- featureType: could be [ROUTE, SERVICE, GENERIC]
- runtimeContext: "Default" is the default value.
Requires authentication : true
Since                   : 6.1
Sample                  : 
{
  "actionName": "updateEsbTask",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "description": "esbTask1's description",
  "featureName": "DemoRESTConsumer-feature",
  "featureType": "ROUTE",
  "featureUrl": "mvn:org.example/DemoRESTConsumer-feature/0.1.0-SNAPSHOT/xml",
  "featureVersion": "0.1.0-SNAPSHOT",
  "repository": "repo-snapshot",
  "runtimeContext": "Default",
  "runtimePropertyId": "DemoRESTConsumer",
  "runtimeServerName": "serv1",
  "tag": "tag1",
  "taskId": 1,
  "taskName": "esbTask1"
}

----------------------------------------------------------
  Command: updateProject
----------------------------------------------------------
Description             : Update a project based on id.
- 'svnCommitMode/gitCommitMode' : [AUTO|SEMI] AUTO for 'Automatic', SEMI for 'Unlocked Items'
- 'svnLockMode/gitLockMode' : [AUTO|ASK|MANUAL] AUTO for 'Automatic', ASK for 'Ask user', MANUAL for 'Manual'
Requires authentication : true
Since                   : 5.6
Sample                  : 
{
  "actionName": "updateProject",
  "active": "true",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "description": "project description",
  "id": "1",
  "projectSvnLocation": "svn://127.0.0.1/test",
  "reference": "false",
  "svnCommitMode": "SEMI",
  "svnLockMode": "ASK",
  "svnLogin": "root",
  "svnPassword": "root",
  "svnUserLog": "true"
}

----------------------------------------------------------
  Command: updateServer
----------------------------------------------------------
Description             : Update a new execution server, parameter username/password (optional)
are used for user authentication to access the JobServer,
- For update server type EC2, you must set the parameter "awsEC2Server":"true",
- For update server type Runtime, you must provide the "isTalendRunTime":true or false to enable
or disable runtime update.
- option "awsEC2Server" and "instance" are incompatible
- For "timezone" property, refer to http://joda-time.sourceforge.net/timezones.html for more details
on the syntax
Requires authentication : true
Since                   : 5.6
Sample                  : 
{
  "accessKeyId": "youraccesskeyid",
  "actionName": "updateServer",
  "activeAmiSelection": "true",
  "adminConsolePort": 8040,
  "authPass": "admin",
  "authUser": "admin@company.com",
  "awsEC2Server": "true",
  "commandPort": 8000,
  "description": "Talend runtime server in production",
  "filePort": 8001,
  "host": "localhost",
  "instance": "trun",
  "instanceLogin": "ubuntu",
  "instanceType": "t1.micro",
  "isTalendRunTime": "true",
  "keyPair": "zwli2",
  "label": "serverName1",
  "mgmtRegPort": 1099,
  "mgmtServerPort": 44444,
  "monitoringPort": 8888,
  "password": 111111,
  "privateKey": "yourprivatekeypair",
  "regionId": "us-west-2",
  "runtimePassword": "password",
  "runtimeUsername": "name",
  "secretAccessKey": "yoursecretaccesskey",
  "securityGroup": "gg",
  "selectedAmiOS": "Ubuntu 12.04 t1.micro",
  "shutdownBehavior": "Stop",
  "timeoutUnknownState": "120",
  "timezoneId": "US/Hawaii",
  "useSSL": true,
  "username": "test@company.com"
}

----------------------------------------------------------
  Command: updateTask
----------------------------------------------------------
Description             : Allows to update an existing execution task from TAC.
- projectName and jobName: the project and job must exist;
- onUnknownStateJob: could be [WAIT, KILL_TASK, RESTART_TASK, RECOVER_TASK]
- contextName: "Default" is the default value for it;
- context: can customize value and make it enabled for context.
- targetConductor: could be [JOBCONDUCTOR, BIGDATA_STREAMING]. "JOBCONDUCTOR" is the default value.
- nexusRepository: if update task from Nexus, using parameters:
nexusRepository/nexusGroupId/nexusArtifactId/nexusVersion[/nexusJobVersionSuffix]
like 'AssociatePreGeneratedJob' command.
- nexusJobVersionSuffix: [Optional] use it when job in nexus with named like test-1.0.0-20170516.043751-1.zip
- Notice: As this command is for File/Nexus/SVN&Git: decide which one by parameter
( filePath > nexusRepository > ... ) exists or not.
Requires authentication : true
Since                   : 5.0
Sample                  : 
{
  "actionName": "updateTask",
  "active": true,
  "applyContextToChildren": false,
  "authPass": "admin",
  "authUser": "admin@company.com",
  "branch": "trunk",
  "contextName": "Default",
  "description": "task1 for extracting data from DB1",
  "execStatisticsEnabled": false,
  "executionServerName": "serv1",
  "filePath": "'/home/talend/generatedJob.zip'",
  "jobName": "job1",
  "jobVersion": "1.0",
  "logLevel": "Info",
  "nexusArtifactId": "test",
  "nexusGroupId": "org.example",
  "nexusJobVersionSuffix": "1.0.0-20170516.043751-1",
  "nexusRepository": "snapshots",
  "nexusVersion": "0.1.0-SNAPSHOT",
  "onUnknownStateJob": "WAIT",
  "pauseOnError": false,
  "projectName": "tproject1",
  "regenerateJobOnChange": false,
  "taskId": 1,
  "taskName": "task1",
  "timeout": 3600
}

----------------------------------------------------------
  Command: updateTrigger
----------------------------------------------------------
Description             : Modify a trigger
- only fields to update are mandatory, field not used in method call will be left as is.
- 'timezoneOption': must be one of those values [JOBSERVER_TIMEZONE, TAC_TIMEZONE, CUSTOM_TIMEZONE]
- if this option is 'CUSTOM_TIMEZONE', the field 'timezoneId' becomes mandatory.
- For "timezone" property, refer to http://joda-time.sourceforge.net/timezones.html
for more details on the syntax
- 'pauseOnError' : if set to true, pause the trigger when the task fail.
Requires authentication : true
Since                   : 5.6
Sample                  : 
{"Samples": [
  {
    "actionName": "updateTrigger",
    "authPass": "admin",
    "authUser": "admin@company.com",
    "description": "This is a simple trigger",
    "endTime": "2016-12-31 23:59:59",
    "id": 1,
    "label": "SimpleTrigger1",
    "pauseOnError": true,
    "repeatCount": 10,
    "repeatInterval": 120,
    "startTime": "2016-12-31 11:40:16",
    "timezone": "'Europe/Paris'",
    "timezoneOption": "CUSTOM_TIMEZONE"
  },
  {
    "actionName": "updateTrigger",
    "authPass": "admin",
    "authUser": "admin@company.com",
    "daysOfMonth": "10",
    "description": "This is a cron trigger",
    "hours": "5,10",
    "id": 1,
    "label": "CronTrigger1",
    "minutes": "1,10",
    "months": "*",
    "pauseOnError": true,
    "timezoneOption": "JOBSERVER_TIMEZONE",
    "years": "2016"
  },
  {
    "actionName": "updateTrigger",
    "authPass": "admin",
    "authUser": "admin@company.com",
    "checkTimeInterval": 120,
    "created": true,
    "description": "This is a file trigger",
    "executionServerId": 1,
    "exist": true,
    "fileMask": "*",
    "folderPath": "/home/tac",
    "id": 1,
    "label": "FileTrigger1",
    "modified": false,
    "pauseOnError": true
  }
]}

----------------------------------------------------------
  Command: updateUserGroup
----------------------------------------------------------
Description             : Update a user group. dataPrepRoles is only valid when type is DP.
tdsRoles is only valid when type is TDS
- 'label' : [DI_ESB|DQ|MDM|DP|TDS]
- 'type' : [DI_ESB|DQ|MDM|DP|TDS]
- 'dataPrepRoles' : [Administrator|Dataset Manager|Data Preparator]
- 'tdsRoles' : [Data Steward|Campaign Owner]
Requires authentication : true
Since                   : 6.2
Sample                  : 
{
  "actionName": "updateUserGroup",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "description": "User group for testing perpose",
  "id": "1",
  "label": "Test Group",
  "type": "DQ"
}

----------------------------------------------------------
  Command: updateVirtualServer
----------------------------------------------------------
Description             : Update a virtual execution server
Requires authentication : true
Since                   : 5.6
Sample                  : 
{
  "actionName": "updateVirtualServer",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "clusterGroup": "Cellar1",
  "description": "Talend virtual server in production",
  "id": "1",
  "label": "VirtualServerName",
  "timezone": "US/Pacific"
}

----------------------------------------------------------
  Command: userExist
----------------------------------------------------------
Description             : Return true if a user exist
Requires authentication : true
Since                   : 3.2
Sample                  : 
{
  "actionName": "userExist",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "userLogin": "john.smith@company.com"
}