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"]}

 

Revision #1
Created 2026-07-24 14:30:40 UTC by Admin
Updated 2026-07-24 14:30:40 UTC by Admin