# 8.1 - AIQ Rest APIs AIQ Rest APIs # Module: admin
Method Parameters HTTP Method Description URL Example
addUser String username, String password, String role POST Adds a new user to AIQ properties, allows only POST request http://localhost:8080/AppvanceServer/rest/admin/addUser?username=username&password=password&role=role
changeMyStatus String status Changes status for the current user
changePassword String password POST Used to change the password of the logged in user. http://localhost:8080/AppvanceServer/rest/admin/changePassword?password=password
changePasswordAsAdmin String username, String password Changes password for the username as admin account
deleteUser String username POST Deletes the mentioned user from the AIQ system. http://localhost:8080/AppvanceServer/rest/admin/deleteUser?username=userName
deleteUserAsAdmin String username Deletes the current user session from realm.properties
getActiveSessions Returns jsonArray with active sessions (username and lastTimeAccessed timestamp) http://localhost:8080/AppvanceServer/rest/admin/getActiveSessions
getAuthKey Generates an authentication key for the current user session http://localhost:8080/AppvanceServer/rest/admin/getAuthKey
getLogInHistory GET / POST Gets the last logins http://localhost:8080/AppvanceServer/rest/admin/getLogInHistory
getPagesRange String username gets the activity logs ranges http://localhost:8080/AppvanceServer/rest/admin/getPagesRange
getRemoteAddress GET/ POST Return the incoming request remote IP address http://localhost:8080/AppvanceServer/rest/admin/getRemoteAddress
getUserLogs String username gets the user logs http://localhost:8080/AppvanceServer/rest/admin/getUserLogs
getUserLogsByRange String username, String range get the activity logs by range and user name http://localhost:8080/AppvanceServer/rest/admin/getUserLogsByRange?username=appvance&range=1to87
getUsername GET/ POST Return the username http://localhost:8080/AppvanceServer/rest/admin/getUsername
getUserRole GET/ POST Return the role of the user. http://localhost:8080/AppvanceServer/rest/admin/getUserRole
isAdmin GET/ POST Return true is the current user session is an administrative user http://localhost:8080/AppvanceServer/rest/admin/isAdmin
isAdminOrOwner GET/ POST Return true is the current user session is either Admin or owner ruser http://localhost:8080/AppvanceServer/rest/admin/isAdminOrOwner
isLogged GET/ POST Checks whether the user is logged http://localhost:8080/AppvanceServer/rest/admin/isLogged
isOwner GET/ POST Return true is the current user session is an owner user http://localhost:8080/AppvanceServer/rest/admin/isOwner
isSaas GET/ POST Return true is the current user session is an saas user http://localhost:8080/AppvanceServer/rest/admin/isSaas
listUsers GET/ POST Lists all of the registered users http://localhost:8080/AppvanceServer/rest/admin/listUsers
listUsersByType String type GET/ POST Lists the users macthing the given type, type value can be \\"admin\\" or \\"user\\" http://localhost:8080/AppvanceServer/rest/admin/listUsersByType?type=type
loggin String username, String password POST Logs In a user with password based credentials, allows only POST requests http://localhost:8080/AppvanceServer/rest/admin/loggin?username=appvance&password=appvance
logginForServices String username, String password POST Logs In a user with password based credentials, allows only POST requests
logginWithCloseSession String username, String password, Boolean Anglicization POST Logs In a user with password based credentials, allows only POST requests
logInWithAuthKey String key Logs In a user with authentication key based crendentials. http://localhost:8080/AppvanceServer/rest/admin/logInWithAuthKey?key=334598.1410969613
logInWithToken String token Logs In a user with token based credential
logout GET/ POST Logs Out the current user session http://localhost:8080/AppvanceServer/rest/admin/logout
resetPassword String username Reset the user password to the default by the given user name. Allows only POST request
updateUser String username, String role POST Updates the user identified by the given user name with the given user role. Allows only POST request http://localhost:8080/AppvanceServer/rest/admin/updateUser?username=appvance&role=admin
updateUser String username, String role POST Updates the user identified by the given user name with the given user role. Allows only POST request
uploadFile String username, String fileName POST Allows to upload file to home repo, allows only POST requests http://localhost:8080/AppvanceServer/rest/file/uploadFiletoLocalRepository?username=username&dir=fileName
# Module: apps
## Module: apps
Method Parameters HTTP Method Description URL Example
AIQInstallPath GET gets AIQ Install Path http://localhost:8080/AppvanceServer/rest/apps/AIQInstallPath
AIQStatus GET gets AIQ status http://localhost:8080/AppvanceServer/rest/apps/AIQStatus
ChangePortAndRebootLocalDS3 Modify local ds3 global json with changed port and reboot
checkLocalDS3Path String location Checks the ds3 location is right or wrong
clearOutput String type Clears the required output
clearOutput String type Clears the required output
exportLogsContent String logType, int size GET/ POST Returns logs data of from requested file http://localhost:8080/AppvanceServer/rest/apps/exportLogsContent?logType=exportType&size=exportSize
gc GET/ POST Init garbage collector, the usage of this should be discouraged and only used if really knows what is being done http://localhost:8080/AppvanceServer/rest/apps/gc
getDS3 Returns the first Megabyte of the ds3 Server output http://localhost:8080/AppvanceServer/rest/apps/getDS3
getDS3Size GET Returns the DS3 output size http://localhost:8080/AppvanceServer/rest/apps/getDS3Size
getError GET/ POST Returns the first Megabyte of the error output http://localhost:8080/AppvanceServer/rest/apps/getError
getErrorSize GET/ POST Returns the error output size http://localhost:8080/AppvanceServer/rest/apps/getErrorSize
getOutput GET/ POST Returns the first Megabyte of console output http://localhost:8080/AppvanceServer/rest/apps/getOutput
getOutputSize GET/ POST Returns the console output size http://localhost:8080/AppvanceServer/rest/apps/getOutputSize
getOwasp GET/ POST Returns the first Megabyte of the OWASP Server output http://localhost:8080/AppvanceServer/rest/apps/getOwasp
getOwaspSize GET/ POST Returns the OWASP output size http://localhost:8080/AppvanceServer/rest/apps/getOwaspSize
getSahi GET/ POST Returns the first Megabyte of the sahi output http://localhost:8080/AppvanceServer/rest/apps/getSahi
getSahiSize GET/ POST Returns the sahi output size http://localhost:8080/AppvanceServer/rest/apps/getSahiSize
localDS3PortData String location read global json to get port data for local ds3
LRAppium GET gets LR/appium Running status http://localhost:8080/AppvanceServer/rest/apps/LRAppium
LRAppiumInstalledPath GET gets LR/appium isntalled path http://localhost:8080/AppvanceServer/rest/apps/LRAppiumInstalledPath
ping GET/ POST calling this method will return the word "running" if AIQ is running. http://localhost:8080/AppvanceServer/rest/apps/ping
reboot GET/ POST Reboots AIQ http://localhost:8080/AppvanceServer/rest/apps/reboot
restartDS3Server GET/ POST Stops and Starts up the test Designer Server http://localhost:8080/AppvanceServer/rest/apps/restartDS3Server
setSahiBrowserConfig String content GET/ POST Sets the Sahi browser (legacy) configuration running under localhost http://localhost:8080/AppvanceServer/rest/apps/setSahiBrowserConfig?content=//please see below content format for this string
shutdown GET/ POST Shuts down Appvance IQ. http://localhost:8080/AppvanceServer/rest/apps/shutdown
testNodePermission GET testnode permissions http://localhost:8080/AppvanceServer/rest/apps/testNodePermission
updateCertificate String domain updates Appvance certificate and reboots
# Module: grid
## Module: grid
Method Parameters HTTP Method Description URL Example
functionalMachines JSONObject json GET/ POST Provides the information(JSON format) for the available grid machines http://localhost:8080/AppvanceServer/rest/grid/functionalMachine?host=8080&value=value
# Module: labManagement
## Module: labManagement
Method Parameters HTTP Method Description URL Example
deleteCloud String cloudName GET/ POST Delete a cloud from the AIQ properties file. http://localhost:8080/AppvanceServer/rest/labManagment/deleteCloud?name=cloudName
getCloud String name GET/ POST Get an specific cloud from AIQ http://localhost:8080/AppvanceServer/rest/labManagment/getCloud?name=cloudName
getCloudCredentials String cloudName Returns crentials for selected cloudname if available.
getClouds Gets the list of clouds in memory
getListOfClouds GET/ POST Get the clouds from AIQ http://localhost:8080/AppvanceServer/rest/labManagment/getListOfClouds
getMachinesFromCloud String username, String cloudName Returns all the machines based on the cloud name, it will return only the machines stored in memory
hasLoggedIn String cloudName GET/ POST Returns true if the user has logged in using Lab Managment. http://localhost:8080/AppvanceServer/rest/labManagment/hasLoggedIn?name=cloudName
isCloudAvailable String name Returns true if the cloud name is Available.
isCloudNameAvailable String name GET/ POST Returns true if the cloud name is Available. http://localhost:8080/AppvanceServer/rest/labManagment/isCloudNameAvailable?name=cloudName
isLabManagmentAvailable Checks if LabManagment is Available
rebootMachines final JSONObject cloudSettings GET/ POST Reboots all the machines based on the cloud settings. http://localhost:8080/AppvanceServer/rest/labManagment/rebootMachines (JSON input with cloudSelected, type, location)
refreshMachinesInMemory \\ String cloudName GET/ POST Returns all the machines based on the cloud settings. http://localhost:8080/AppvanceServer/rest/labManagment/refreshMachinesInMemory?name=cloudName
saveCloud String name, String type, String location GET/ POST Save a new cloud in AIQ properties http://localhost:8080/AppvanceServer/rest/labManagment/saveCloud?name=name&type=type&location=location
updateCloud String oldName, String name, String type, String location GET/ POST Update a cloud in the AIQ properties file. http://localhost:8080/AppvanceServer/rest/labManagment/updateCloud?oldName=oldCloudName&name="newName&type=newType&location=newLocation,
updateCloudCredentials String username, String password, String cloudName POST Returns true if the user has logged in using Lab Management http://localhost:8080/AppvanceServer/rest/labManagment/updateCloudCredentials?username=username&password=password&cloudName=cloudSelected
upgradeAppvance final String cloudName, final String upgradeFilePath, final String keepBrowserTypes, final String keepLocalProperties GET/ POST Upgrade AIQ in the set of machines registered in a cloud configuration file http://localhost:8080/AppvanceServer/rest/labManagment/upgradeAppvance?cloudName=cloudName&upgradeFilePath=path&keepBrowserTypes=browserTypes&keepLocalProperties=properties
upgradeMachinesAux String username, final String cloudName, final String upgradeFilePath, final String keepBrowserTypes, final String keepLocalProperties Upgrades Appvance in all the set of machines registered in a cloud configuration file
# Module: license
## Module: license
Method Parameters HTTP Method Description URL Examples
getBasicLicense GET/ POST Gets the number of virtual user minutes that is left. http://localhost:8080/AppvanceServer/rest/license/getBasicLicense
getDisplayCreator
getDisplayCreatorNew
getLicense GET/ POST Gets the complete license details and the expiry details. http://localhost:8080/AppvanceServer/rest/license/getLicense
getLicenseDuration GET/ POST Gets the duration of the license and shows when it expires. http://localhost:8080/AppvanceServer/rest/license/getLicenseDuration
getLicenseTimeUsage GET/ POST Retrieves CSV License Time Line Usage and provides details like Date (MM/DD/YY, HH:MM:SS), VUM Spend, Scenario File http://localhost:8080/AppvanceServer/rest/license/getLicenseTimeUsage
getLicenseType GET/ POST Gets the license type. http://localhost:8080/AppvanceServer/rest/license/getLicenseType
getVersion GET/ POST Gets the Appvance AIQ version that is installed. http://localhost:8080/AppvanceServer/rest/license/getVersion
isLicenseExpired Checks license status
setLicense InputStream license GET/ POST Sets the license http://localhost:8080/AppvanceServer/rest/license/setLicense?license=filename
# Module: openStack
## Module: openStack
Method Parameters HTTP Method Description URL Examples
createOpenstackServer JSONObject json GET/ POST Launch a new openstack server http://localhost:8080/AppvanceServer/rest/openStack/createOpenstackServer?username=uname&endPoint=7&region=india&image=''&flavor=''&provider=openstack-nova&password=pass
getServersList JSONObject json GET/ POST Returns the OpenStack servers list from an OpenStack configuration http://localhost:8080/AppvanceServer/restgetServersList?username=uname&endPoint=7&region=india&image=''&flavor=''&provider=openstack-nova&password=pass
testConfiguration JSONObject json GET/ POST Test an OpenStack configuration from a given JSON configuration ject http://localhost:8080/AppvanceServer/rest/openStack/testConfiguration?username=uname&endPoint=7&region=india&image=''&flavor=''&provider=openstack-nova&password=pass
# Module: preferences
## Module: preferences
Method Parameters HTTP Method Description URL Example
addBookmark String path GET/ POST Adds a filepath bookmark http://localhost:8080/AppvanceServer/rest/preferences/addBookmark?path=path
createDB GET/ POST Creates database results repository http://localhost:8080/AppvanceServer/rest/preferences/createDB
deleteAppDynamics String name Delete an AppDynamics config
deleteBookmark String path GET/ POST Delete a bookmark http://localhost:8080/AppvanceServer/rest/preferences/deleteBookmark?path=path
deleteDynaTrace String name GET/ POST Delete a dynaTrace config http://localhost:8080/AppvanceServer/rest/preferences/deleteDynaTrace?name=name
deleteNewRelic String repositoryName GET/ POST Delete a new relic configuratin http://localhost:8080/AppvanceServer/rest/preferences/deleteNewRelic?name=name
deleteRepository String repositoryName GET/ POST Delete repository with the provided repository name. http://localhost:8080/AppvanceServer/rest/preferences/deleteRepository?name=repoName
deleteRepositoryByUser String repositoryName, String utpUserName GET/ POST Delete repository with the provided repository name based on a particular user. http://localhost:8080/AppvanceServer/rest/preferences/deleteRepositoryByUser?name=name&utpusername=username
downloadJiraSettings Download Jira Settings
getAllRepositoryByUser String username Returns repository names from AIQ UserName
getAPMConfigurations Gets the names of NewRelic and DynaTrace Configuration Names
getAppDynamicsConfiguration String name Gets a newRelic configuration details by name
getAppDynamicsConfigurationNames Returns AppDynamics names
getAppDynamicsConfigurations Gets the AppDynamics Configurations
getBookmarks GET/ POST Returns bookmarks http://localhost:8080/AppvanceServer/rest/preferences/getBookmarks
getBranches String username, String name GET/ POST Get list branches http://localhost:8080/AppvanceServer/rest/preferences/getBranches?username=username&name=RepositoryVal
getBrowsers Gets the browsers
getDBStatus Tests database connection
getDS3Port GET/ POST Gets the ds3ports http://localhost:8080/AppvanceServer/rest/preferences/getDS3Port
getDynaTraceConfiguration String name GET/ POST Gets a dynaTrace configuration details by name ttp://localhost:8080/AppvanceServer/rest/preferences/getDynaTraceConfiguration?name=configName
getDynaTraceConfigurationNames GET/ POST Returns dyna trace names http://localhost:8080/AppvanceServer/rest/preferences/getDynaTraceConfigurationNames
getDynaTraceConfigurations GET/ POST Gets the DynaTrace Configurations http://localhost:8080/AppvanceServer/rest/preferences/getDynaTraceConfigurations
getGitRepositoryAuthor String username, String name Returns repository author
getJiraSettings Gets Jira settings
getLatestTimeRefreshRepositories GET/ POST Get Latest Time Refresh Repositories http://localhost:8080/AppvanceServer/rest/preferences/getLatestTimeRefreshRepositories
getLoadRunnerPath GET/ POST Gets Load Runner Path http://localhost:8080/AppvanceServer/rest/preferences/getLoadRunnerPath
getNewRelicConfiguration String name GET/ POST Gets a newRelic configuration detailsby name http://localhost:8080/AppvanceServer/rest/preferences/getNewRelicConfiguration?name=newRelicCofigVal
getNewRelicConfigurationNames GET/ POST Returns new relic names http://localhost:8080/AppvanceServer/rest/preferences/getNewRelicConfigurationNames
getNewRelicConfigurations GET/ POST Gets the NewRelic Configurations http://localhost:8080/AppvanceServer/rest/preferences/getNewRelicConfigurations
getNotifications GET/ POST Checks notifications preferences http://localhost:8080/AppvanceServer/rest/preferences/getNotifications
getRepository String name GET/ POST Return repository details based on the repo name. http://localhost:8080/AppvanceServer/rest/preferences/getRepository?name=repoName
getRepositoryByUser String name, String utpUserName GET/ POST Returns repository names by individual users. http://localhost:8080/AppvanceServer/rest/preferences/getRepositoryByUser?name= repoName&utpusername=username
getRepositoryNames GET/ POST Returns all repository names http://localhost:8080/AppvanceServer/rest/preferences/getRepositoryNames
getRepositoryNamesByUser String utpUserName GET/ POST Returns all repository names based on users. http://localhost:8080/AppvanceServer/rest/preferences/getRepositoryNamesByUser?utpusername=username
getRepositoryPath allows to get repositories settings
getRepositoryStatus String RepositoryName GET/ POST Returns repository status http://localhost:8080/AppvanceServer/rest/preferences/getRepositoryStatus?name=repoName
getResultRepository GET/ POST Gets database results repository preferences http://localhost:8080/AppvanceServer/rest/preferences/getResultRepository
getSahi GET/ POST Gets sahi configuration http://localhost:8080/AppvanceServer/rest/preferences/getSahi
getScenarios Gets previous scenarios
getSchema GET/ POST Gets database schema http://localhost:8080/AppvanceServer/rest/preferences/getSchema
pullRepository String username, String name GET/ POST Pull current repository http://localhost:8080/AppvanceServer/rest/preferences/pullRepository?name=repoName
refreshRepositories Force refresh repositories
saveAppDynamicsConfiguration JSONObject config Save a AppDynamics configuration
saveBrowsers Saves the browsers list
saveDS3Port JSONObject ds3Ports, String username GET/ POST save DS3 port http://localhost:8080/AppvanceServer/rest/preferences/saveDS3Port?htpp=9090&https=9091
saveDynaTraceConfiguration JSONObject config GET/ POST Save a DynaTrace configuration http://localhost:8080/AppvanceServer/rest/preferences/saveDynaTraceConfiguration?name=relicName&url=url&id=id&dashboard=dashboard
saveJiraSettings Save Jira preferences
saveLoadRunnerPath JSONObject obj GET/ POST Save LoadRunner Path preferences http://localhost:8080/AppvanceServer/rest/preferences/saveLoadRunnerPath?path=path
saveNewRelicConfiguration JSONObject newRelic GET/ POST Save New Relic configurations. http://localhost:8080/AppvanceServer/rest/preferences/saveNewRelicConfiguration?name=relicName&url=url&id=id&dashboard=dashboard
saveNotifications JSONObject obj GET/ POST Checks notifications preferences http://localhost:8080/AppvanceServer/rest/preferences/saveNotifications?mailuser=username&mailuserpassword=password&mailhost=host&mailport=port&sslvalue=boolean
saveRepository JSONObject repository GET/ POST Save new or updates existing valid repository. http://localhost:8080/AppvanceServer/rest/preferences/saveRepository //please see below sample saveRepository JSON
saveRepositoryCommitMessage String username, String repositoryName, String commitMessage Save new or updates existing valid repository.
saveResultsRepository final JSONObject obj GET/ POST Saves database results repository preferences http://localhost:8080/AppvanceServer/rest/preferences/saveResultsRepository////please see below sample saveResultsRepository JSON
saveSahi JSONObject obj GET/ POST Gets sahi configuration http://localhost:8080/AppvanceServer/rest/preferences/saveSahi?path=path&mustrun=boolean
testConnection GET/ POST Tests database connection http://localhost:8080/AppvanceServer/rest/preferences/testConnection
testConnectionParams JSONObject config GET/ POST Tests database connection based on params http://localhost:8080/AppvanceServer/rest/preferences/testConnectionParams?username=name&password=password&engine=resultType&url=repoURL
testJiraSettings Test Jira Settings
testQuery String quer GET/ POST Tests query http://localhost:8080/AppvanceServer/rest/preferences/testQuery?query=sqlVal
### Sample:
``` var repository = {

type: $('#repositoryType').val(),

name: $('#repositoryName').val(),

url: $('#repositoryURL').val(),

username: $('#repositoryUsername').val(),

ssh: ssh,

auth: $('#repositoryAuth').val(),

password: password,

utpusername: username,

branch: $("#reposList").val() == undefined ? "master" : $("#reposList").val()

};

saveResultsRepository

var result = {

username: $('#resultsUsername').val(),

password: $('#resultsPassword').val(),

engine: $("#resultsType").val(),

url: $('#resultsURL').val(),

database: $('#resultsDatabase').val(),

maxActive: $('#resultsMaxActive').val(),

maxIdle: $('#resultsMaxIdle').val(),

maxWait: $('#resultsMaxWait').val(),

abandonedTimeout: $('#resultsRemoveAbandonedTimeout').val(),

autoCommit: $('#resultsAutoCommit').prop('checked'),

logAvandoned: $('#resultsLogAbandoned').prop('checked'),

removeAvandoned: $('#resultsRemoveAbandoned').prop('checked'),

enabled: $('#resultsEnabled').prop('checked')

};

```
# Module: reports
## Module: reports
Method Parameters HTTP Method Description URL Example
createConfig String url, String user, String pass, String driver, String database Creates a new configuration, returns the configuration id
createDefault Creates a new default data base configuration
deleteScenarioExecution JSONArray pArrayJSon GET/ POST Deletes a Scenario execution from database http://localhost:8080/AppvanceServer/rest/reports/deleteScenarioExecution?config=default&scenario=12345
getAeliusReportFromFile String path GET/ POST Gets Aelius report from the HTTP Proxy file that is being loaded. http://localhost:8080/AppvanceServer/rest/reports/getAeliusReportFromFile?path=browserPath
getAllSummaries String config, long exeid Gets all Summary Reports
getChartingTxDataProvider String config, int dbIterId, String testcaseName GET/ POST Gets charting tx details http://localhost:8080/AppvanceServer/rest/reports/getChartingTxDataProvider?config=default&testcaseName=testcase1&iterId=5
getConfigurationsCustomDataGraphics String config, int resourceId, int customDataId GET/ POST Gets the configuration custom data graphics http://localhost:8080/AppvanceServer/rest/reports/getConfigurationsCustomDataGraphics?config=default&resourceId=1525&customDataId=5
getCustomData String config, int resourceId GET/ POST Get custom data based on the resource id http://localhost:8080/AppvanceServer/rest/reports/getCustomData?config=default&resourceId=1525
getCustomDataGraphics String config, int resourceId, int customDataId GET/ POST Get custom data graphics http://localhost:8080/AppvanceServer/rest/reports/getCustomDataGraphics?config=default&resourceId=1525&customDataId=5
getData String blobType, String contentType, String config, int requestId Gets one transaction
getError String config, int nodeId GET/ POST Gets testnode error http://localhost:8080/AppvanceServer/rest/reports/getError?config=default&nodeId=12345
getExecution String config, long exeId GET/ POST Gets executions details http://localhost:8080/AppvanceServer/rest/reports/getExecution?config=default&exeId=12345
getExecutionDetails String config GET/ POST Gets execution from a configuration id http://localhost:8080/AppvanceServer/rest/reports/getExecutionDetails?config=default
getExecutionDetailsById String username, String config, long id Gets a specific execution details from the configured database and for an specific execution filtered by any of both id or date.
getExecutionDetailsByName String username, String config, String scenarioname Gets executions from a configuration id
getExecutionDetailsByRange String username, String config, long initialtime, long finaltime Gets a specific execution details from the configured data base for an specific time range
getExecutionDetailsByScenario String username, String config, String name Gets a specific execution details from the configured data base.
getExecutionDetailsNoLimits String username, String config Gets a specific execution details from the configured data base fetching all the rows.
getExecutionDetailsUntil String username, String config, long specifictime Gets a specific execution details from the configured database from the latest executions until an specific time.
getExecutions String config Gets executions from a configuration id
getFailures String config, int iterId, int offset GET/ POST Gets the HTML failures report for the given iteration. http://localhost:8080/AppvanceServer/rest/reports/getFailures?config=default&exeId=1334568&iterId=7&offset=timeFrame
getFullIterationInfo String config, int iterId GET/ POST Get full iteration information based on iteration id. http://localhost:8080/AppvanceServer/rest/reports/getFullIterationInfo?config=default&iterId=7
getFunctionalReport String config, long exeId Gets the functional report of the current execution (Only the first transaction, used for Functional Testing only)
getHarFromTestCaseExecution String config, int txI GET/ POST Gets har details from the test case execution. http://localhost:8080/AppvanceServer/rest/reports/getHarFromTestCaseExecution?config=default&txId=12345
getIntegrationReport String config, long exeId, int iterId, String integration, String format GET/ POST Gets one transaction http://localhost:8080/AppvanceServer/rest/reports/getIntegrationReport?config=default&exeId=1334568&iterId=7&integrator=integ&format=docx we can use pdf as well - for format
getIterationDetailsReport String config, int iterId GET/ POST Get Iteration Details CSV report http://localhost:8080/AppvanceServer/rest/reports/getIterationDetailsReport?config=default&iterId=7
getIterationInfo String config, int iterId GET/ POST Gets Iteration information based on the iteration id http://localhost:8080/AppvanceServer/rest/reports/getIterationInfo?config=default&iterId=7
getIterations String config, long exeId GET/ POST Gets iterations http://localhost:8080/AppvanceServer/rest/reports/getIterations?config=default&exeId=7
getIterationScalability String config, long exeId, String iterName GET/ POST Gets scalability for a single iteratio http://localhost:8080/AppvanceServer/rest/reports/getIterationScalability?config=default&exeId=7&iterName=iter1
getIterationSummary String config, int iterId, String template, String testcaseId, int offset GET/ POST gets iteration summary report http://localhost:8080/AppvanceServer/rest/reports/getIterationSummary?config=default&exeId=7&iterId=2&offset=off&testcaseId=11&template=functinal
getIterAverageHits String config, int iterId Gets the current iteration average hits data provider to plot controller average hits
getIterSuccessFailures String config, int iterId Gets the current iteration success and failures
getIterTotalHits String config, int iterId Gets the current iteration total hits data provider to plot controller total hits
getIterTotalThroughput String config, int iterId Gets the current iteration total throughput data provider to plot controller total throughput
getIterUserCount String config, int iterId Gets the current iteration active user count data provider to plot controller active users count
getJUnitReport String config, long exeId, int txId GET/ POST Gets one transaction report in xml format http://localhost:8080/AppvanceServer/rest/reports/getJUnitReport?config=default&exeId=7&txId=2
getJUnitWithIntegrations String config, long exeId, int txId Gets one transaction report in xml format
getLastExecutionInfo String config GET/ POST Gets last execution iters info http://localhost:8080/AppvanceServer/rest/reports/getLastExecutionInfo?config=default
getMonitorTemplates String config, int iterId, String target GET/ POST Gets Monitor Templates http://localhost:8080/AppvanceServer/rest/reports/getMonitorTemplates?config=default&iterId=7&target=2
getOutput String config, int nodeId GET/ POST Gets testnode output http://localhost:8080/AppvanceServer/rest/reports/getRecentExecutions?config=default&nodeId=7
getPoolStatus Gets the pool status
getRecentExecutions String config GET/ POST Gets executions from a configuration id http://localhost:8080/AppvanceServer/rest/reports/getRecentExecutions?config=default
getRequest String config, int requestId Download a request content. User must know the request content format
getResourceOnTime String config, int resourceId, String resourceType, boolean msec GET/ POST Gets the Results On Time metrics as a CSV report http://localhost:8080/AppvanceServer/rest/reports/getResourceOnTime?config=default&resourceId=7&resourceType=type&msec=false
getResourceUsageDataProvider String config, int execId, int iterId, String targetId, String templates GET/ POST Gets resource usage http://localhost:8080/AppvanceServer/rest/reports/getResourceUsageDataProvider?config=default&exeId=1524116442668&iterId=-725547514&targetId=localhost&templates=\["PC","Appvance Java"\]
getResourceUsageMetricsConfig String config, int iterId, String targetId, String templates, boolean getTxs GET/ POST Gets the test case executions (success and failures) and the given target metrics configurations http://localhost:8080/AppvanceServer/rest/reports/getResourceUsageMetricsConfig?config=default&exeId=exeId&iterId=iterId&targetId=targetName&templates=monitorTemplate&getTxs=getTxs
getResultsOnTimeDataProvider String config, int resourceId, String templates, boolean msec GET/ POST Get the Results On Time Charting data for the specified resource ID http://localhost:8080/AppvanceServer/rest/reports/getResultsOnTimeDataProvider?config=default&resourceId=7&templates=tname&msec=true
getResultsOnTimePlotData String config, int resourceId, String template, boolean msec Get the Results On Time Charting data for the specified resource ID
getScalabilityDataProvider String config, long exeId GET/ POST Gets scalability data provider. http://localhost:8080/AppvanceServer/rest/reports/getScalabilityDataProvider?config=default&exeId=7
getScenarioJUnitReport String config, long exeId, boolean integrations Gets scenario report in xml format
getSimpleReport String config, long execId, String name, String type Gets executions details
getStepsTimeDataProvider String config, int iterId, int testcaseId GET/ POST Gets the Data Provider required to plot Steps Time chart http://localhost:8080/AppvanceServer/rest/reports/getStepsTimeDataProvider?config=default&iterId=9&testcaseId=1
getStepsTimeReport String config, int iterId, int testcaseId GET/ POST Get Steps Time CSV report http://localhost:8080/AppvanceServer/rest/reports/getStepsTimeReport?config=default&iterId=9&testcaseId=1
getSummariesComparison String config, int iterId, long exeId, int offset, String path, String templates, int summaryID GET/ POST Gets Summaries comparison http://localhost:8080/AppvanceServer/rest/reports/getSummariesComparison?config=default&exeId=7&iterId=9&offset=timeFrame &path=fileName&templates=templates&summaryID=summaryID
getSummary String config, int iterId, int summaryId, String template, String testcaseId, int offset GET/ POST Gets summary http://localhost:8080/AppvanceServer/rest/reports/getSummary?config=default&iterId=9&offset=timeFrame &path=fileName&templates=templates&summaryID=summaryID
getTargets String config, int iterId GET/ POST Gets targets http://localhost:8080/AppvanceServer/rest/reports/getTargets?config=default&iterId=7
getTemplate String templateName, boolean steps GET/ POST Get the give custom report template entries http://localhost:8080/AppvanceServer/rest/reports/getTemplate?steps=false&template=heading
getTemplateNames GET/ POST Get current report templates http://localhost:8080/AppvanceServer/rest/reports/getTemplateNames
getTemplates GET/ POST Get current templates http://localhost:8080/AppvanceServer/rest/reports/getTemplates
getTestNodes String config, long exeId GET/ POST Gets testnodes from execution http://localhost:8080/AppvanceServer/rest/reports/getTestNodes?config=default&exeId=7
getTicks String config, int iterId GET/ POST Gets the list of ticksfor the given Iteration http://localhost:8080/AppvanceServer/rest/reports/getTicks?config=default&exeId=7
getTotalTx String config, long exeId GET/ POST Gets total tx http://localhost:8080/AppvanceServer/rest/reports/getTotalTx?config=default&exeId=7
getTotalTxIteration String config, int iter GET/ POST Gets total tx Iteration details http://localhost:8080/AppvanceServer/rest/reports/getTotalTxIteration?config=default&iterId=8
getTx String config, int txId, String filterFunctional GET/ POST Gets one transaction http://localhost:8080/AppvanceServer/rest/reports//getTx?config=default&txId=7&filterFunctional=functinalVal
getTXWithResourceUsageDataProvider String config, int iterId, String targetId, String templates GET/ POST Gets the test case executions (success and failures) with the given target resource usage http://localhost:8080/AppvanceServer/rest/reports/getTXWithResourceUsageDataProvider?config=default&iterId=4&targetId=15&templates=templates
isAppPenetration String config, long exeId GET/ POST Gets security integration ifexist http://localhost:8080/AppvanceServer/rest/reports//isAppPenetration?config=decoration&exeId=7
removeTemplate String templateName GET/ POST Remove report template based on name. http://localhost:8080/AppvanceServer/rest/reports/removeTemplate?template=templateName
saveTemplate JSONObject newJsonTemplate GET/ POST Save templates http://localhost:8080/AppvanceServer/rest/reports/saveTemplate Template added below for your example:
### Report Template Sample Object : `{"name":"newTemplate","reports":["functionalReport","stepTimes","iterationSummary","stepTimes_serverSideOnly","iterationSummary_testcaseName","securityReport"]}` If you want more reports, it must be added in the reports array ike this: `{"name":"newTemplate","reports":["functionalReport","stepTimes","iterationSummary","stepTimes_serverSideOnly","iterationSummary_testcaseName","securityReport", iterationSummary_requestName", "scalabilityReport"]}` # Module: RQM
## Module: RQM
Method Parameters HTTP Method Description URL Example
getRQM GET/ POST Get the RQM http://localhost:8080/AppvanceServer/rest/RQM/getRQM
getRQMStatus GET/ POST Get the RQM Status http://localhost:8080/AppvanceServer/rest/RQM/getRQMStatus
saveRQM String username, String password, String repositoryURL, String projectArea, String adapterName GET/ POST Save RQM http://localhost:8080/AppvanceServer/rest/RQM/saveRQM?adapterName=name&repositoryURL=url&username=uname&password=pass&projectArea=pArea
startStopRQM GET/ POST Start Stop RQM http://localhost:8080/AppvanceServer/rest/RQM/startStopRQM
# Module: softlayer
## Module: softlayer
Method Parameters HTTP Method Description URL Examples
functionalMachines JSONObject json, String imageDiskId, String domain GET/ POST Provides the information(JSON format) for the available machine http://localhost:8080/AppvanceServer/rest/softlayer/functionalMachines?ID=id&UserName=unameAPIKey=key&DataCenterName=data&MaxMemory=maxMemory&MaxNetworkSpeed=Maxspeed&StartCpus=2&Domain=domain&imageDiskId=discId
getAllDataCenters String username,String apiKey GET/ POST Gets all the data-centers available in Softlayer. http://localhost:8080/AppvanceServer/rest/softlayer/getAllDataCenters?username=appvance&apiKey=keyvalue
isSoftlayerAvailable GET/ POST Checks monitor preferences http://localhost:8080/AppvanceServer/rest/softlayer/isSoftlayerAvailable
rebootMachine JSONObject json, String machineId GET/ POST Reboots a specified machine. http://localhost:8080/AppvanceServer/rest/softlayer/rebootMachine?ID=id&UserName=unameAPIKey=key&DataCenterName=data&MaxMemory=maxMemory&MaxNetworkSpeed=Maxspeed&StartCpus=2&Domain=domain&machineId=78958
startMachine JSONObject json GET/ POST Start a new machine with the information provided by configuration file or JSON http://localhost:8080/AppvanceServer/rest/softlayer/startMachine?APIKey=key1234&DataCenterName=data&Domain=domain&ID=id&MaxMemory=maxMemory&MaxNetworkSpeed=Maxspeed&StartCpus=2&UserName=uname
terminateMachine JSONObject json, String machineId GET/ POST Requests a Softlayer machine deletion process http://localhost:8080/AppvanceServer/rest/softlayer/terminateMachine?ID=id&UserName=unameAPIKey=key&DataCenterName=data&MaxMemory=maxMemory&MaxNetworkSpeed=Maxspeed&StartCpus=2&Domain=domain&machineId=78958
testConfiguration JSONObject json GET/ POST Checks monitor preferences http://localhost:8080/AppvanceServer/rest/softlayer/testConfiguration?APIKey=key&DataCenterName=data&Domain=domain&ID=id&MaxMemory=maxMemory&MaxNetworkSpeed=Maxspeed&StartCpus=2&UserName=uname
# Module: AppvanceSG
## Module: AppvanceSG
Method Parameters HTTP Method Description URL Example
clearOutputPath String username, String pathToClear clear output path
clearScenarioGeneration String username Clear scenario generation
downloadSettings String username Downloads settings.cfg file
downloadSetupTemplate String username Downloads template setup.js file
generateScripts String username, String fields Creates a scenario using parameters on method
getScenarioGenerationStatus String username Get status for scenario generation
getUserData String username Returns user data
isScenarioGenerationRunning String username Checks if scenario generation is running
stopScenarioGeneration String username Stops scenario generation
validateEmptyOutputPath String username, String outputPath Validate outputPath
# Module: AISG
Method Paramters HTTP Method Description URL Example
addFile String username, String blueprintType, String path Adds external file
compareBlueprints String username, String baselinePath, String blueprintPath, int execution Compare Blueprints
createBlueprint String username, String fields Creates Web Blueprint with user parameters
createBlueprintFromTemplate String username, String template Creates Blueprint from Template file
createBlueprintFromTemplateUI String username, String templateFile Creates Blueprint from Template file
createBlueprintFromTemplateWithDataset String username, String template, String dataset Creates Blueprint from Template file after replacing with selected Dataset
createExecution String username, String fields Creates Execution
createJsonValidationReportCICD String username Downloads Json Validations Report file for CI/CD
createMobileBlueprint Creates Mobile Blueprint Creates Mobile Blueprint
createRequestTXTFile String username, int status Downloads Requests Report file for the Execution
createResponseTimesReport String username Downloads Response Times Report file for the Execution
createResponseTimesReportCICD String username, int code Downloads Response Times Report file for CI/CD
createSmartTagsReport String username Downloads SmartTags Report file for the Execution
createSmokeTestReport String username Downloads Smoke Test Report file for the Execution
createValidationReportCICD String username Downloads Validations Report file for CI/CD
createValidationsBP String username Create validations with a Blueprint
createValidationsReport String username Downloads Validations Report file for the Execution
deleteFile String username, String blueprintType, String fileName Deletes file
deleteSets String username, String name Deletes selected Dataset
downloadBlueprint String username Downloads Blueprint file
downloadBlueprintActions String username, int executionId, String fileType Downloads Blueprint Scripts
downloadCustomActions String username, int executionId, int stateId, String type Downloads Custom Actions for the Execution
downloadFailedActions String username, int executionId Downloads Failed Actions for the Execution
downloadFailedInconsistentActionsReport String username, int executionId, String type Downloads Failed and Inconsistent Actions Report file for the Execution
downloadFile String username, String blueprintType, String fileName Downloads external file
downloadInconsistentActions String username, int executionId Downloads Inconsistent Actions for the Execution
downloadMobileConfiguration String username Downloads Mobile Configuration file
downloadMobileConfigurationTemplate String username, String platform, String service, String device Downloads Mobile Configuration Template file
downloadRequestActions String username, String type, String actionIds Downloads Scripts for the Request
downloadValidationsActions String username, int executionId, String urlId, int id, String fileType, String type Downloads Scripts for failed Validations
exportDataSets String username, String path, String commitMessage Exports Dataset Names from Blueprint Template
exportDataSetsCSV String username, String path, String commitMessage Exports Dataset Names from Blueprint Template
exportSelfHealedSmartTagsLibrary String username, String path, String commitMessage Write SmartTags Library to user defined file
exportSmartTagsLibrary String username, String path, String commitMessage Write SmartTags Library to user defined file
exportTemplate String username, String path, String commitMessage Exports Blueprint Template
getAllStatusCodes String username Returns Status Codes of Requests
getBindings String username, int executionId, int page, String type Returns Bindings for the Execution
getBindingsCICD String username Returns Bindings for the Execution
getBlueprintResults String username Returns Blueprint Results
getBlueprintType String username Returns Blueprint type
getCustomActions String username, int executionId, int stateId Returns Custom Actions for the Binding
getDataSets String username Returns Datasets
getExecutionIDs String username Returns id and name of all Executions
getFieldVisualHint String username, int executionId, int stateId, String name, String type Returns Visual Hint bytes for selected field
getHTMLSmarttagsCICD String username, String filter Downloads SmartTags Report file for the Execution
getInteractive String username Returns Interactive mode
getMaxBindings String username, int executionId, String type Returns Max Bindings for the Execution
getPagesActionsCICD String username Gets the Pages and Actions for the CI CD Dashboard
getReportDuration String username Returns Request Duration for Response Times Report
getReportStatusCode String username Returns Request Status Code for Smoke Test Report
getRequestMaxDuration String username Returns Request Duration for Response Times Report
getRequestsWithStatusCode String username, int status Returns Requests with Status Code
getScanDetails String username Returns Global and each Execution details
getScanParameters String username, String blueprintType Returns Blueprint intial scan parameters
getSmartTagHints String username, String path Returns Visual Hint bytes
getSmartTags String username, int executionId Returns SmartTags for the Execution
getSmartTagVisualHint String username, int executionId, String urlId, String name Returns Visual Hint bytes for selected SmartTag
getSource String username, int executionId, int stateId Returns Source
getUseVisualHints String username Returns if uses Visual Hints
getValidations String username, int executionId Returns Validations for the Execution
getValidationsBP String username Create validations with a Blueprint
getValidationsCICD String username Gets Valiadation reports for CI/CD
getVersion String username Returns Blueprint version
getVisualHint String username, int executionId, int stateId Returns Visual Hint bytes
makeCustomActionsGlobal String username, int executionId, int caoId, boolean global Moves Custom Actions to stateId or -1
openBlueprint String username, String path Opens Blueprint
openTemplate String username, String path Opens Blueprint Template
pauseExecution String username, int executionId Pause Executions
playExecution String username, int executionId Play Executions of the blueprint
playWithBindings String username, String fields Play with Bindings
processBinding String username, String fields Creates Custom Actions for the Binding
processDPL String username, String filepath Returns Datasets from dpl file
removeBlueprint String username, String blueprintType Deletes Blueprint
removeCustomAction String username, int executionId, int actionId Removes Custom Action
retryFailed String username, int executionId Reprocess Failed Actions for the Execution
retryInconsistent String username, int executionId Reprocess Inconsistent Actions for the Execution
saveAsBlueprint String username, String fields, String commitMessage Writes to temporary and new user defined files
saveBlueprint String username, String fields, String commitMessage Writes to temporary and user defined files
saveBlueprintTemplate String username, String path, String content, String commitMessage Saves files to Disk
saveCustomActions String username, int executionId, int stateId, String type, String path Saves Custom Actions for the Execution
saveToServer String username, String content Saves Mobile Configuration file
serverConfig String username, String path Returns Mobile Configuration file
setInteractive String username, boolean interactive Changes Interactive mode
setReportDuration String username, int milliseconds Sets Request Duration for Response Times Report
setReportStatusCode String username, int status Sets Request Status Code for Smoke Test Report
setRequestMaxDuration String username, int milliseconds Sets Request maximum Duration for Response Times Report
stopAllRunnings String username Stops Blueprint
stopByExecId String username, int executionId Stops Execution
updateDataSets String username, String set Updates selected Dataset
uploadFile String username, String blueprintType, String path, String fileName Uploads external file
# Module: JavaScriptDPLManager
## Module: JavaScriptDPLManager
Method Parameters HTTP Method Description URL Example
addDplFile String username, String path Adds a DPL file into memory
checkJsSyntax String jsContent Returns empty if Syntax is correct
decryptDPL String username , String path, String destination ,String password, String commitMessage Decrypt DPL
downloadDpl String fileName, String content Downloads the transform csv
encryptDPL String username , String path, String destination ,String password, String commitMessage Encrypt DPL
evaluateFunctions String username,String content Evaluates the functions that is written in JS
getDplContent String username Returns the dpl file processed
removeDplFile String username Remove a DPL from memory
saveDplFile String username,String path,String content, String commitMessage Saves a DPL
# Module: Library
## Module: Library
Method Parameters HTTP Method Description URL Example
addDict String dict, String path add New dictionary to properties
addEntryToDict String path, String entryname, String values Add entry to a dictionary
deleteDict String dict Delete Dictionary
getDictionaries Get Dictionaries
getDictionaryNames Get Dictionary Names
getDictionaryPaths Get Dictionary Paths
getEntryAccessors String entryName, String dictName Get accessors from a dictionary entry
updateDictPath String dict, String path Update Dictionary Paths