This is the multi-page printable view of this section. Click here to print.
The portal server has four APIs:
All APIs - except the public API - require a so-called “Authentication Token” to verify the access authorization. If 5 or more invalid “Authentication Tokens” are sent within 60 seconds, the corresponding remote IP address is blocked for 15 minutes.
The public API can be accessed without authentication.
Don’t stress this API. If you make more than 8 calls per minute, the corresponding remote IP address will be blocked for 15 minutes.
The API supports the following functions (so-called “actions”):
| URL | HTTP Method |
|---|---|
| https://portal.realload.com/PublicAPI | POST |
| All data are sent and received in JSON data format. The “action” must always be sent when an API call is made. |
curl -v --request POST --header "Content-Type: application/json" --data "@getPortalServerInfo.json" https://portal.realload.com/PublicAPI
{
"action": "getPortalServerInfo"
}
{
"portalServerInfo": {
"portalServerVersion": "4.8.39",
"minRequiredMeasuringAgentVersion": "4.5.12",
"minRequiredClusterControllerVersion": "4.5.12",
"minRequiredRemoteProxyRecorderVersion": "1.1.3",
"currentTimestamp": 1714509839204
},
"isError": false
}
If the API call is successful, then the response field “isError” is false. If a numeric field has a value of -1 (minus one), this means “no data” or “unlimited” depending on the context.
Specific Request Fields:
Specific Error Flags:
JSON Request Example:
{
"action":"getPortalServerInfo"
}
JSON Response Example (Success Case):
{
"portalServerInfo": {
"portalServerVersion": "4.8.39",
"minRequiredMeasuringAgentVersion": "4.5.12",
"minRequiredClusterControllerVersion": "4.5.12",
"minRequiredRemoteProxyRecorderVersion": "1.1.3",
"currentTimestamp": 1714509839204
},
"isError": false
}
Specific Request Fields:
Specific Error Flags:
JSON Request Example:
{
"action":"getAllExternalHelpLinks"
}
JSON Response Example (Success Case):
{
"externalHelpLinksArray": [
{
"helpKey": "HelpKey_DesktopCompanionAwsAvailableAmisList",
"keyEnabled": true,
"hrefTitle": "Available AWS AMIs",
"href": "https://kb.realload.com/docs/desktop-companion/measuring_agents/",
"targetBlank": true
},
{
"helpKey": "HelpKey_DesktopCompanionAwsInstancesInMyRegionsList",
"keyEnabled": true,
"hrefTitle": "Running AWS Images in \"My Regions\"",
"href": "https://kb.realload.com/docs/desktop-companion/measuring_agents/#listing-running-ec2-instances",
"targetBlank": true
},
{
"helpKey": "HelpKey_DesktopCompanionAwsPortalAgentsList",
"keyEnabled": true,
"hrefTitle": "Portal Agents De-register",
"href": "https://kb.realload.com/docs/desktop-companion/measuring_agents/#de-register-an-instance",
"targetBlank": true
},
{
"helpKey": "HelpKey_DesktopCompanionEditorRequestDetails",
"keyEnabled": true,
"hrefTitle": "Request Details",
"href": "https://kb.realload.com/docs/desktop-companion/editor/",
"targetBlank": true
},
{
"helpKey": "HelpKey_DesktopCompanionEditorSession",
"keyEnabled": true,
"hrefTitle": "HTTP Requests",
"href": "https://kb.realload.com/docs/desktop-companion/editor/",
"targetBlank": true
},
{
"helpKey": "HelpKey_DesktopCompanionEditorUniqueDomainsList",
"keyEnabled": true,
"hrefTitle": "Unique Domains",
"href": "https://kb.realload.com/docs/desktop-companion/editor/#domain-based-selection",
"targetBlank": true
},
{
"helpKey": "HelpKey_DesktopCompanionPreferencesAWS",
"keyEnabled": true,
"hrefTitle": "AWS Settings",
"href": "https://kb.realload.com/docs/desktop-companion/settings/#aws-settings",
"targetBlank": true
},
{
"helpKey": "HelpKey_DesktopCompanionPreferencesGeneral",
"keyEnabled": true,
"hrefTitle": "General Settings",
"href": "https://kb.realload.com/docs/desktop-companion/settings/#general-settings",
"targetBlank": true
},
{
"helpKey": "HelpKey_DesktopCompanionPreferencesProxyRecorder",
"keyEnabled": true,
"hrefTitle": "Proxy Recorder Settings",
"href": "https://kb.realload.com/docs/desktop-companion/settings/#proxy-recorder-settings",
"targetBlank": true
},
{
"helpKey": "HelpKey_HttpsRemoteProxyRecorderImportRootCertificate",
"keyEnabled": true,
"hrefTitle": "Import Proxy Recorder Root Certificate",
"href": "https://kb.realload.com/docs/userguide/remoteproxyrecorder/#importing-the-proxy-recorder-ca-root-certificate-into-the-web-browser",
"targetBlank": true
},
{
"helpKey": "HelpKey_HttpsRemoteProxyRecorderRecordingSession",
"keyEnabled": true,
"hrefTitle": "Recording a Web Surfing Session",
"href": "https://kb.realload.com/docs/userguide/recordingwebsurfingsession/",
"targetBlank": true
},
{
"helpKey": "HelpKey_HttpsRemoteProxyRecordersMenu",
"keyEnabled": true,
"hrefTitle": "HTTP/S Remote Proxy Recorder",
"href": "https://kb.realload.com/docs/userguide/remoteproxyrecorder/",
"targetBlank": true
},
{
"helpKey": "HelpKey_HTTPTestWizard_Debugger",
"keyEnabled": true,
"hrefTitle": "HTTP Test Wizard Debugger",
"href": "https://kb.realload.com/docs/userguide/httptestwizard/#debugger",
"targetBlank": true
},
{
"helpKey": "HelpKey_HTTPTestWizard_Main",
"keyEnabled": true,
"hrefTitle": "HTTP Test Wizard",
"href": "https://kb.realload.com/docs/userguide/httptestwizard/",
"targetBlank": true
},
{
"helpKey": "HelpKey_HTTPTestWizard_Plugins",
"keyEnabled": true,
"hrefTitle": "HTTP Test Wizard Plug-Ins",
"href": "https://kb.realload.com/docs/userguide/httptestwizard/#plug-ins",
"targetBlank": true
},
{
"helpKey": "HelpKey_LaunchedCloudInstancesByCloudCredits",
"keyEnabled": true,
"hrefTitle": "Launched Cloud Instances",
"href": "https://kb.realload.com/docs/userguide/#launched-cloud-instances-by-cloud-credits",
"targetBlank": true
},
{
"helpKey": "HelpKey_LoadTestJobsMenu",
"keyEnabled": true,
"hrefTitle": "Load Test Jobs",
"href": "https://kb.realload.com/docs/userguide/#load-test-jobs-menu",
"targetBlank": true
},
{
"helpKey": "HelpKey_MeasuringAgentsAndClusterControllersMenu",
"keyEnabled": true,
"hrefTitle": "Measuring Agents and Cluster Controllers",
"href": "https://kb.realload.com/docs/userguide/#measuring-agents--cluster-controllers",
"targetBlank": true
},
{
"helpKey": "HelpKey_MobileCompanionApp",
"keyEnabled": true,
"hrefTitle": "Mobile Companion App",
"href": "https://kb.realload.com/docs/mobile-companion/",
"targetBlank": true
},
{
"helpKey": "HelpKey_ProjectsMenu",
"keyEnabled": true,
"hrefTitle": "Projects Menu",
"href": "https://kb.realload.com/docs/userguide/#projects-menu",
"targetBlank": true
},
{
"helpKey": "HelpKey_RealTimeViewMenu",
"keyEnabled": true,
"hrefTitle": "Real Time View",
"href": "https://kb.realload.com/docs/userguide/#real-time-view-menu",
"targetBlank": true
},
{
"helpKey": "HelpKey_SyntheticMonitoring",
"keyEnabled": true,
"hrefTitle": "Synthetic Monitoring",
"href": "https://kb.realload.com/docs/synthetic-monitoring/",
"targetBlank": true
},
{
"helpKey": "HelpKey_TestResultsMenu",
"keyEnabled": true,
"hrefTitle": "Test Results",
"href": "https://kb.realload.com/docs/userguide/#test-results-menu",
"targetBlank": true
},
{
"helpKey": "HelpKey_TestsMenu",
"keyEnabled": true,
"hrefTitle": "RealLoad Tests",
"href": "https://kb.realload.com/docs/userguide/#tests-menu",
"targetBlank": true
},
{
"helpKey": "HelpKey_UserInputFieldsWizard",
"keyEnabled": true,
"hrefTitle": "User Input Fields Wizard",
"href": "https://kb.realload.com/docs/userguide/#user-input-fields-wizard",
"targetBlank": true
}
],
"isError": false
}
Specific Request Fields:
Specific Error Flags:
JSON Request Example:
{
"action":"getExternalHelpLink",
"helpKey": "HelpKey_ProjectsMenu"
}
JSON Response Example (Success Case):
{
"externalHelpLink": {
"helpKey": "HelpKey_ProjectsMenu",
"keyEnabled": true,
"hrefTitle": "Projects Menu",
"href": "https://kb.realload.com/docs/userguide/#projects-menu",
"targetBlank": true
},
"isError": false
}
JSON Response Example (Error Case):
{
"isError": true,
"genericErrorText": "",
"helpKeyError": true
}
To perform a Remote Admin API call, you must first generate an “Admin API Auth Token” in the Administrator Menu of the portal. When generating the token you can enter a purpose (only used as information) and also restrict the remote IP addresses for which the token is valid. You can also specify whether the token has read/write access or read/only access.
The API supports the following functions (so-called “actions”):
| URL | HTTP Method |
|---|---|
| https://portal.realload.com/RemoteAdminAPI | POST |
| All data are sent and received in JSON data format. The “authTokenValue” and the “action” must always be sent when an API call is made. |
curl -v --request POST --header "Content-Type: application/json" --data "@getAllUserAccounts.json" https://portal.realload.com/RemoteAdminAPI
{
"authTokenValue": "8mKSz1UzaQg17kfu",
"action": "getAllUserAccounts"
}
{"allUserAccountsArray":
[{"userId":13,"nickname":"DKF","firstName":"Max","lastName":"Fischer","primaryEmail":"max@dkfqa.com","primarySMSPhone":"+41771111111","secondaryEmail":"","secondarySMSPhone":"","accountBlocked":false,"accountCreateTime":1538556183756,"lastLoginTime":1625181623869,"lastLoginIP":"127.0.0.1","pricePlanId":1,"accountExpiresTime":-1,"pricePlanTitle":"Unlimited"},{"userId":18,"nickname":"AX","firstName":"Alex","lastName":"Fischer","primaryEmail":"alexfischer66@yahoo.com","primarySMSPhone":"+41781111111","secondaryEmail":"","secondarySMSPhone":"","accountBlocked":false,"accountCreateTime":1539874749677,"lastLoginTime":1616111301975,"lastLoginIP":"127.0.0.1","pricePlanId":1,"accountExpiresTime":-1,"pricePlanTitle":"Unlimited"},{"userId":22,"nickname":"Kes","firstName":"Kesorn","lastName":"Fischer","primaryEmail":"gsklsta@yahoo.com","primarySMSPhone":"+66000000000","secondaryEmail":"","secondarySMSPhone":"","accountBlocked":false,"accountCreateTime":1605303204754,"lastLoginTime":1624389324770,"lastLoginIP":"127.0.0.1","pricePlanId":6,"accountExpiresTime":-1,"pricePlanTitle":"BASIC1"},{"userId":48,"nickname":"BET","firstName":"Bettina","lastName":"Meier","primaryEmail":"b123456@lucini.id.au","primarySMSPhone":"+61404905702","secondaryEmail":"","secondarySMSPhone":"","accountBlocked":false,"accountCreateTime":1623719604561,"lastLoginTime":-1,"lastLoginIP":"","pricePlanId":6,"accountExpiresTime":1625061600000,"pricePlanTitle":"BASIC1"}],
"isError":false}
If the API call is successful, then the response field “isError” is false. If a numeric field has a value of -1 (minus one), this means “no data” or “unlimited” depending on the context.
Specific Request Fields:
Specific Error Flags:
Specific Request Fields:
Specific Error Flags:
Specific Request Fields:
The license is successfully assigned to a user if either mapToUserEmailAddress or mapToUserMobilePhone matches to a user account.
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"8mKSz1UzaQg17kfu",
"action":"addLicenseCertificateToUser",
"licenseProvider": "Real Load Pty Ltd / nopCommerce",
"mapToUserEmailAddress": "max@dkfqa.com",
"mapToUserMobilePhone": "+41771111111",
"licenseCertificate": "-----BEGIN CERTIFICATE-----\r\nMIIEnjCCA4agAwIBAgIEyDnukzANBgkqhkiG9w0BA ...... Hn/UMGAGRB6xF4w+TewYqTAZrdhi/WLyYwg==\r\n-----END CERTIFICATE-----"
}
JSON Response Example (Success Case):
{"licenseId":12,"cloudCreditLicenseId":-1,"userId":13,"isCloudCreditsLicense":false,"isError":false}
JSON Response Example (Error Case):
{"isError":true,"genericErrorText":"","writeAccessError":false,"licenseProviderError":false,"mapToUserError":false,"pricePlanError":false,"licenseCertificateAlreadyAddedError":false,"licenseCertificateError":true}
Specific Request Fields:
Specific Error Flags:
JSON Response Example:
{
"isServerMaintenanceMode":false,
"isSignInSelectPricePlanFromMultipleValidLicenseCertificates":true,
"isSignInExpiredAccountCanEnterLicenseCertificate":true,
"isSignUpEnabled":true,
"isSignUpRequiresInvitationTicket":false,
"signUpDefaultPricePlanId":2,
"signUpDefaultAccountExpiresInDays":14,
"deleteExpiredUserAccountsAfterDays":183,
"isError":false
}
Specific Request Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"8mKSz1UzaQg17kfu",
"action":"setServerMaintenanceMode",
"serverMaintenanceMode":true
}
JSON Response Example (Success Case):
{"isServerMaintenanceMode":true,"isError":false}
Specific Request Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"8mKSz1UzaQg17kfu",
"action":"updateMeasuredUsersDiskSpace",
"usersDiskSpaceArray":[
{
"userId":13,
"usedDiskSpaceBytes":20000000
},
{
"userId":63,
"usedDiskSpaceBytes":10000000
}
]
}
JSON Response Example (Success Case):
{
"processedUserAccountIdsArray":[13,63],
"nonProcessedUserAccountIdsArray":[],
"isError":false
}
To perform a Remote User API call, you must first sign in into the portal and generate an “API Authentication Token”. When generating the token you can enter a purpose (only used as information) and also restrict the remote IP addresses for which the token is valid.
The API supports the following functions (so-called “actions”):
Common Functions:
Projects, Resource Sets and Files Functions:
Measuring Agents Functions:
Measuring Agent Cluster Functions:
HTTP/S Remote Proxy Recorders Functions:
Load Test Jobs Functions:
Test Execution Suites Functions:
OSHI System Monitoring Functions:
| URL | HTTP Method |
|---|---|
| https://portal.realload.com/RemoteUserAPI | POST |
| All data are sent and received in JSON data format. The “authTokenValue” and the “action” must always be sent when an API call is made. |
curl -v --request POST --header "Content-Type: application/json" --data {\"authTokenValue\":\"jPmFClqeDUXaEk8Q274q\",\"action\":\"getUserAccountInfo\"} https://portal.realload.com/RemoteUserAPI
{
"authTokenValue": "jPmFClqeDUXaEk8Q274q",
"action": "getUserAccountInfo"
}
{
"userAccountInfo":{
"userId":48,
"nickname":"BET",
"firstName":"Bettina",
"lastName":"MeierHans",
"primaryEmail":"bettina@meierhans.id.au",
"primarySMSPhone":"+61401111111",
"secondaryEmail":"",
"secondarySMSPhone":"",
"accountBlocked":false,
"accountCreateTime":1623719604561,
"lastLoginTime":1625348376450,
"lastLoginIP":"127.0.0.1",
"pricePlanId":6,
"accountExpiresTime":1625953109397,
"pricePlanTitle":"BASIC1"
},
"isError":false
}
If the API call is successful, then the response field “isError” is false. If a numeric field has a value of -1 (minus one), this means “no data” or “unlimited” depending on the context.
Specific Request Fields:
Specific Error Flags:
Specific Request Fields:
Specific Error Flags:
JSON Response Example:
{
"pricePlanInfo":{
"pricePlanId":6,
"title":"BASIC1",
"description":"",
"isDeprecated":false,
"lastModified":1625348413042,
"maxDiskSpaceMB":1024,
"maxSubUserAccounts":0,
"maxMeasuringAgentsOwnedByUser":3,
"maxRemoteProxyRecordersOwnedByUser":3,
"executeLoadJobsEnabled":true,
"executeMonitoringJobsEnabled":false,
"apiAccessEnabled":true,
"maxStartLoadJobsLast24h":24,
"maxUsersPerLoadJob":500,
"maxDurationPerLoadJob":1800
},
"isError":false
}
The unit for “maxDurationPerLoadJob” is seconds.
Specific Request Fields:
Specific Error Flags:
JSON Response Example:
{
"projectsArray": [
{
"projectId": 97,
"projectName": "Common",
"projectDescription": "",
"resourceSetsArray": [
{
"resourceSetId": 154,
"resourceSetName": "Input Files",
"resourceSetDescription": "",
"filesArray": [
{
"fileName": "InputFile.txt",
"fileSize": 233,
"fileHashCode": 1873256029,
"fileLastModified": 1613835992073
}
]
},
{
"resourceSetId": 155,
"resourceSetName": "Jar Files",
"resourceSetDescription": "",
"filesArray": [
{
"fileName": "com.dkfqs.tools.jar",
"fileSize": 578087,
"fileHashCode": -2033420926,
"fileLastModified": 1613838181727
}
]
},
{
"resourceSetId": 156,
"resourceSetName": "Plug-Ins",
"resourceSetDescription": "",
"filesArray": [
{
"fileName": "HttpSessionPlugin_ChangeCopyright.json",
"fileSize": 5321,
"fileHashCode": 1958407366,
"fileLastModified": 1613838287871
}
]
}
]
},
...
...
...
],
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"createProject",
"projectName":"My New Project",
"projectDescription": "Created by API call"
}
JSON Response Example (Success Case):
{"projectId":113,"isError":false}
JSON Response Example (Error Case):
{"isError":true,"genericErrorText":"","diskSpaceLimitExceededError":false,"projectNameError":true}
Specific Request Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"deleteProject",
"projectId":113,
"moveToTrash":false
}
Specific Request Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"getResourceSetsOfProject",
"projectId":97
}
JSON Response Example (Success Case):
{
"resourceSetsArray": [
{
"resourceSetId": 154,
"resourceSetName": "Input Files",
"resourceSetDescription": "",
"filesArray": [
{
"fileName": "InputFile.txt",
"fileSize": 233,
"fileHashCode": 1873256029,
"fileLastModified": 1613835992073
}
]
},
{
"resourceSetId": 155,
"resourceSetName": "Jar Files",
"resourceSetDescription": "",
"filesArray": [
{
"fileName": "com.dkfqs.tools.jar",
"fileSize": 578087,
"fileHashCode": -2033420926,
"fileLastModified": 1613838181727
}
]
},
{
"resourceSetId": 156,
"resourceSetName": "Plug-Ins",
"resourceSetDescription": "",
"filesArray": [
{
"fileName": "HttpSessionPlugin_ChangeCopyright.json",
"fileSize": 5321,
"fileHashCode": 1958407366,
"fileLastModified": 1613838287871
}
]
}
],
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"createResourceSet",
"projectId":97,
"resourceSetName":"My New Resource Set",
"resourceSetDescription": "Created by API call"
}
JSON Response Example (Success Case):
{"resourceSetId":172,"isError":false}
JSON Response Example (Error Case):
{"isError":true,"genericErrorText":"","resourceSetNameError":true,"projectIdError":false,"diskSpaceLimitExceededError":false}
Specific Request Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"deleteResourceSet",
"projectId":97,
"resourceSetId":172,
"moveToTrash":false
}
Specific Request Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"getFilesInfoOfResourceSet",
"projectId":23,
"resourceSetId":143
}
JSON Response Example:
{
"filesArray": [
{
"fileName": "DKFQSLibrary2.psm1",
"fileSize": 16339,
"fileHashCode": -1503445747,
"fileLastModified": 1603566144851
},
{
"fileName": "powershell-http-bern2.ps1",
"fileSize": 12900,
"fileHashCode": -1174212096,
"fileLastModified": 1603566162094
},
{
"fileName": "TestResult_powershell-http-bern2Neu_2020-10-24@21-06-04.json",
"fileSize": 14395,
"fileHashCode": -951574615,
"fileLastModified": 1603566379097
},
{
"fileName": "TestResult_powershell-http-bern2Neu_2020-10-24@21-09-45.json",
"fileSize": 55128,
"fileHashCode": 1499924815,
"fileLastModified": 1603566591322
}
],
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"createFile",
"projectId":23,
"resourceSetId":143,
"fileName":"test.txt",
"fileContentB64":"VGhpcyBpcyB0aGUgY29udGVudCBvZiB0aGUgZmlsZS4="
}
JSON Response Example (Success Case):
{
"fileName":"test.txt",
"fileSize":32,
"fileHashCode":-1460278014,
"fileLastModified":1625423562384,
"isError":false
}
JSON Response Example (Error Case):
{"isError":true,"genericErrorText":"","projectIdError":false,"resourceSetIdError":false,"diskSpaceLimitExceededError":false,"fileNameError":true}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"getFile",
"projectId":23,
"resourceSetId":143,
"fileName":"test.txt"
}
JSON Response Example (Success Case):
{
"fileName":"test.txt",
"fileContentB64":"VGhpcyBpcyB0aGUgY29udGVudCBvZiB0aGUgZmlsZS4=",
"fileSize":32,
"fileHashCode":-1460278014,
"fileLastModified":1625423562384,
"isError":false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"deleteFile",
"projectId":23,
"resourceSetId":143,
"fileName":"test.txt",
"moveToTrash":false
}
JSON Response Example (Success Case):
{"fileDeleted":true,"isError":false}
JSON Response Example (Error Case):
{"isError":true,"genericErrorText":"","projectIdError":false,"resourceSetIdError":false,"fileNameError":true}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"getMeasuringAgents"
}
JSON Response Example (Success Case):
{
"measuringAgentsArray": [
{
"agentId": 46,
"createdBySystem": false,
"ownerUserId": 13,
"agentActive": true,
"agentDescription": "Local Agent",
"agentHost": "127.0.0.1",
"agentPort": 8080,
"authToken": "OrKmpkbyNWEHok"
},
{
"agentId": 49,
"createdBySystem": false,
"ownerUserId": 13,
"agentActive": false,
"agentDescription": "Rasberry 1",
"agentHost": "192.168.0.51",
"agentPort": 8080,
"authToken": ""
},
{
"agentId": 50,
"createdBySystem": false,
"ownerUserId": 13,
"agentActive": true,
"agentDescription": "Ubuntu 10",
"agentHost": "192.168.0.110",
"agentPort": 8080,
"authToken": ""
},
{
"agentId": 51,
"createdBySystem": false,
"ownerUserId": 13,
"agentActive": true,
"agentDescription": "Ubuntu 11",
"agentHost": "192.168.0.111",
"agentPort": 8080,
"authToken": ""
}
],
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"getMinRequiredMeasuringAgentVersion"
}
JSON Response Example (Success Case):
{
"minRequiredMeasuringAgentVersion":"3.9.34",
"isError":false
}
Specific Request Fields:
Response Fields (JSON object “measuringAgent”):
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"addMeasuringAgent",
"agentDescription":"Ubuntu 12",
"agentHost":"192.168.0.112",
"agentPort":8080,
"agentActive": true,
"agentAuthToken": "nixda"
}
JSON Response Example (Success Case):
{
"measuringAgent": {
"agentId": 53,
"createdBySystem": false,
"ownerUserId": 13,
"agentActive": true,
"agentDescription": "Ubuntu 12",
"agentHost": "192.168.0.112",
"agentPort": 8080,
"authToken": "nixda"
},
"isError": false
}
Specific Request Fields:
Response Fields (JSON object “agentResponse”):
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"pingMeasuringAgent",
"agentId":48
}
JSON Response Example (Success Case):
{
"agentResponse": {
"pingFromRemoteIp": "83.150.39.44",
"pingFromRemoteUserId": 13,
"productVersion": "3.9.30",
"limitMaxUsersPerJob": 500,
"limitMaxJobDurationSeconds": 300,
"osName": "Linux",
"osVersion": "4.15.0-136-generic",
"javaVersion": "11.0.1",
"javaVendor": "Oracle Corporation",
"javaMaxMemory":"2048 MB",
"systemTime": 1625513238236,
"deltaTimeMillis": 841,
"agentStartupTimeStamp": 1622836702172,
"httpExecuteTimeMillis": 247
},
"isError": false
}
JSON Response Example (Error Case 1):
{
"isError": true,
"genericErrorText": "API V1 request to 192.168.0.51:8080 timed out",
"agentIdError": false,
"agentAccessDeniedError": false,
"agentNotReachableError": true,
"agentVersionOutdatedError": false
}
JSON Response Example (Error Case 2):
{
"isError": true,
"genericErrorText": "Min. measuring agent version required: 3.9.30",
"agentIdError": false,
"agentAccessDeniedError": false,
"agentNotReachableError": false,
"agentVersionOutdatedError": true
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"setMeasuringAgentActive",
"agentId":46,
"agentActive":false
}
JSON Response Example (Success Case):
{"isError":false}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"deleteMeasuringAgent",
"agentId":54
}
JSON Response Example (Success Case):
{"isError":false}
Specific Request Fields:
Response Fields (JSON array “measuringAgentClustersArray”):
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"getMeasuringAgentClusters"
}
JSON Response Example:
{
"measuringAgentClustersArray": [
{
"clusterId": 11,
"createdBySystem": false,
"ownerUserId": 13,
"clusterActive": true,
"clusterDescription": "C1",
"controllerHost": "192.168.0.50",
"controllerPort": 8083,
"controllerAuthToken": "aberaber",
"clusterMembersArray": [
{
"clusterMemberId": 59,
"loadFactor": 1,
"agentId": 64,
"agentActive": true,
"agentDescription": "Agent 1",
"agentHost": "192.168.0.10",
"agentPort": 8080,
"agentAuthToken": "OrKmAAbyNWEHok"
},
{
"clusterMemberId": 60,
"loadFactor": 1,
"agentId": 59,
"agentActive": true,
"agentDescription": "Ubuntu 10",
"agentHost": "192.168.0.110",
"agentPort": 8080,
"agentAuthToken": "asc7jhacab"
},
{
"clusterMemberId": 61,
"loadFactor": 1,
"agentId": 60,
"agentActive": true,
"agentDescription": "Ubuntu 11",
"agentHost": "192.168.0.111",
"agentPort": 8080,
"agentAuthToken": "66ascascsdac"
}
]
},
{
"clusterId": 14,
"createdBySystem": false,
"ownerUserId": 13,
"clusterActive": true,
"clusterDescription": "C2",
"controllerHost": "192.168.0.50",
"controllerPort": 8083,
"controllerAuthToken": "aberaber",
"clusterMembersArray": [
{
"clusterMemberId": 66,
"loadFactor": 1,
"agentId": 56,
"agentActive": true,
"agentDescription": "Test System",
"agentHost": "192.168.0.60",
"agentPort": 8080,
"agentAuthToken": "aberdoch"
},
{
"clusterMemberId": 67,
"loadFactor": 1,
"agentId": 59,
"agentActive": true,
"agentDescription": "Ubuntu 10",
"agentHost": "192.168.0.110",
"agentPort": 8080,
"agentAuthToken": "asc7jhacab"
}
]
}
],
"isError": false
}
Specific Request Fields:
Response Fields (JSON array “clusterControllersArray”):
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"getClusterControllers"
}
JSON Response Example:
{
"clusterControllersArray": [
{
"controllerHost": "192.168.0.33",
"controllerPort": 8083,
"controllerAuthToken": "2fasdtfffe",
"measuringAgentClustersArray": [
{
"clusterId": 11,
"clusterDescription": "C1",
"clusterActive": 1
},
{
"clusterId": 13,
"clusterDescription": "C2",
"clusterActive": 1
},
{
"clusterId": 14,
"clusterDescription": "C3",
"clusterActive": 1
}
]
},
{
"controllerHost": "192.168.0.50",
"controllerPort": 8083,
"controllerAuthToken": "asfsdgh763",
"measuringAgentClustersArray": [
{
"clusterId": 15,
"clusterDescription": "C4",
"clusterActive": 1
},
{
"clusterId": 16,
"clusterDescription": "C7",
"clusterActive": 1
}
]
}
],
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"getMinRequiredClusterControllerVersion"
}
JSON Response Example:
{
"minRequiredClusterControllerVersion":"4.0.4",
"isError":false
}
Specific Request Fields:
Response Fields (JSON object “controllerResponse”):
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"pingClusterController",
"controllerHost":"192.168.0.50",
"controllerPort":8083,
"controllerAuthToken":"hagsajjs99"
}
JSON Response Example (Success Case):
{
"controllerResponse": {
"pingFromRemoteIp": "192.168.0.100",
"pingFromRemoteUserId": 13,
"productVersion": "4.0.4",
"osName": "Linux",
"osVersion": "4.15.0-135-generic",
"javaVersion": "11.0.1",
"javaVendor": "Oracle Corporation",
"javaMaxMemory": "512 MB",
"systemTime": 1643406118552,
"deltaTimeMillis": 1120,
"controllerStartupTimeStamp": 1643322597013,
"httpExecuteTimeMillis": 249,
"clusterControllerOutdated": false
},
"isError": false
}
JSON Response Example (Error Case 1):
{
"isError": true,
"genericErrorText": "API call pingGetControllerInfo failed. Error code = 18, Error message = Invalid authentication token",
"controllerHostError": false,
"controllerVersionOutdatedError": false,
"controllerNotReachableError": true,
"controllerPortError": false
}
JSON Response Example (Error Case 2):
{
"isError": true,
"genericErrorText": "Min. cluster controller version required: 4.0.4",
"controllerHostError": false,
"controllerVersionOutdatedError": true,
"controllerNotReachableError": false,
"controllerPortError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"addMeasuringAgentCluster",
"clusterActive":true,
"clusterDescription":"C7",
"controllerHost":"192.168.0.50",
"controllerPort":8083,
"controllerAuthToken":"aberaber",
"clusterMembersArray":[
{
"agentId":59,
"loadFactor":1
},
{
"agentId":60,
"loadFactor":1
}
]
}
JSON Response Example (Success Case):
{
"clusterId":16,
"clusterMembersArray":[
{
"clusterMemberId":71,
"agentId":59,
"loadFactor":1
},
{
"clusterMemberId":72,
"agentId":60,
"loadFactor":1
}
],
"isError":false
}
JSON Response Example (Error Case):
{
"isError": true,
"genericErrorText": "Invalid agentId = 101",
"controllerHostError": false,
"agentIdError": true,
"controllerPortError": false,
"loadFactorError": false,
"clusterDescriptionError": false
}
Specific Request Fields:
Response Fields (JSON object “clusterMember”):
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"addMemberToMeasuringAgentCluster",
"clusterId":17,
"agentId":64,
"loadFactor":1
}
JSON Response Example:
{
"clusterMember": {
"clusterMemberId": 75,
"agentId": 64,
"loadFactor": 1
},
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"removeMemberFromMeasuringAgentCluster",
"clusterId":17,
"clusterMemberId":75
}
JSON Response Example:
{"isError":false}
Specific Request Fields:
Response Fields (JSON object “controllerResponse”):
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"pingMeasuringAgentClusterMembers",
"clusterId":16
}
JSON Response Example (Success Case):
{
"controllerResponse": {
"productVersion": "4.0.4",
"clusterConnectResult": {
"measuringAgentClusterMemberArray": [
{
"clusterMemberId": 71,
"loadFactor": 1,
"agentId": 59,
"agentActive": true,
"agentDescription": "Ubuntu 10",
"agentHost": "192.168.0.110",
"agentPort": 8080,
"agentAuthToken": "agsdhagsj"
},
{
"clusterMemberId": 72,
"loadFactor": 1,
"agentId": 60,
"agentActive": true,
"agentDescription": "Ubuntu 11",
"agentHost": "192.168.0.111",
"agentPort": 8080,
"agentAuthToken": "nvbjnvbnn"
}
],
"connectSuccessfulClusterMemberArray": [
71,
72
],
"connectFailedClusterMemberArray": [],
"clusterConnectStartTimestamp": 1643410829270,
"clusterConnectDurationMillis": 79
},
"clusterActionResult": {
"actionSuccessfulClusterMemberArray": [
71,
72
],
"actionFailedClusterMemberArray": [],
"jsonResponseClusterMemberArray": [
{
"clusterMemberId": 71,
"jsonResponseObject": {
"productVersion": "4.0.4",
"systemTime": 1643410829340,
"deltaTimeMillis": -10,
"osName": "Linux",
"osVersion": "5.4.0-92-generic",
"javaVersion": "11.0.1",
"javaVendor": "Oracle Corporation",
"javaMaxMemory": "2048 MB",
"samplingGranularityMillis": 4000,
"isError": false,
"measuringAgentOutdated": false
}
},
{
"clusterMemberId": 72,
"jsonResponseObject": {
"productVersion": "4.0.4",
"systemTime": 1643410829351,
"deltaTimeMillis": -10,
"osName": "Linux",
"osVersion": "5.4.0-92-generic",
"javaVersion": "11.0.1",
"javaVendor": "Oracle Corporation",
"javaMaxMemory": "2048 MB",
"samplingGranularityMillis": 4000,
"isError": false,
"measuringAgentOutdated": false
}
}
],
"clusterActionStartTimestamp": 1643410829349,
"clusterActionDurationMillis": 43
},
"httpExecuteTimeMillis": 1778,
"clusterControllerOutdated": false
},
"isError": false
}
JSON Response Example (Error Case / Partly failed):
{
"controllerResponse": {
"productVersion": "4.0.4",
"clusterConnectResult": {
"measuringAgentClusterMemberArray": [
{
"clusterMemberId": 71,
"loadFactor": 1,
"agentId": 59,
"agentActive": true,
"agentDescription": "Ubuntu 10",
"agentHost": "192.168.0.110",
"agentPort": 8080,
"agentAuthToken": "marderzahn"
},
{
"clusterMemberId": 72,
"loadFactor": 1,
"agentId": 60,
"agentActive": true,
"agentDescription": "Ubuntu 11",
"agentHost": "192.168.0.111",
"agentPort": 8080,
"agentAuthToken": "marderzahn"
}
],
"connectSuccessfulClusterMemberArray": [
72
],
"connectFailedClusterMemberArray": [
{
"clusterMemberId": 71,
"errorMessage": "Connection refused (Connection refused)"
}
],
"clusterConnectStartTimestamp": 1643414272214,
"clusterConnectDurationMillis": 97
},
"clusterActionResult": {
"actionSuccessfulClusterMemberArray": [
72
],
"actionFailedClusterMemberArray": [],
"jsonResponseClusterMemberArray": [
{
"clusterMemberId": 72,
"jsonResponseObject": {
"productVersion": "4.0.4",
"systemTime": 1643414272310,
"deltaTimeMillis": -8,
"osName": "Linux",
"osVersion": "5.4.0-92-generic",
"javaVersion": "11.0.1",
"javaVendor": "Oracle Corporation",
"javaMaxMemory": "2048 MB",
"samplingGranularityMillis": 4000,
"isError": false,
"measuringAgentOutdated": false
}
}
],
"clusterActionStartTimestamp": 1643414272311,
"clusterActionDurationMillis": 21
},
"httpExecuteTimeMillis": 1769,
"clusterControllerOutdated": false
}
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"setMeasuringAgentClusterActive",
"clusterId":16,
"clusterActive":true
}
JSON Response Example (Success Case):
{"isError":false}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"deleteMeasuringAgentCluster",
"clusterId":16
}
JSON Response Example (Success Case):
{"isError":false}
Specific Request Fields:
Response Fields (JSON array “proxyRecordersArray”):
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"getProxyRecorders"
}
JSON Response Example:
{
"proxyRecordersArray": [
{
"recorderId": 3,
"createdBySystem": false,
"ownerUserId": 13,
"recorderDescription": "Erster",
"recorderProxyHost": "192.168.0.40",
"recorderProxyPort": 8082,
"recorderProxyAuthUsername": "",
"recorderProxyAuthPassword": "",
"recorderControlPort": 8081,
"recorderControlAuthToken": ""
},
{
"recorderId": 4,
"createdBySystem": false,
"ownerUserId": 13,
"recorderDescription": "proxy.realload.com",
"recorderProxyHost": "proxy.realload.com",
"recorderProxyPort": 8082,
"recorderProxyAuthUsername": "max.meier",
"recorderProxyAuthPassword": "123456",
"recorderControlPort": 8081,
"recorderControlAuthToken": "aZujkl97zuwert"
}
],
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"getMinRequiredProxyRecorderVersion"
}
JSON Response Example (Success Case):
{
"minRequiredProxyRecorderVersion":"0.2.2",
"isError":false
}
Specific Request Fields:
Response Fields (JSON object “proxyRecorder”):
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"addProxyRecorder",
"recorderDescription":"My New Proxy Recorder",
"recorderProxyHost":"192.168.0.148",
"recorderProxyPort":8082,
"recorderProxyAuthUsername":"max.meier",
"recorderProxyAuthPassword":"123456",
"recorderControlPort":8081,
"recorderControlAuthToken":"aZujkl97zuwert"
}
JSON Response Example (Success Case):
{
"proxyRecorder": {
"recorderId": 10,
"createdBySystem": false,
"ownerUserId": 13,
"recorderDescription": "My New Proxy Recorder",
"recorderProxyHost": "192.168.0.148",
"recorderProxyPort": 8082,
"recorderProxyAuthUsername": "max.meier",
"recorderProxyAuthPassword": "123456",
"recorderControlPort": 8081,
"recorderControlAuthToken": "aZujkl97zuwert"
},
"isError": false
}
Specific Request Fields:
Response Fields (JSON object “pongResponse”):
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"pingProxyRecorder",
"recorderId":4
}
JSON Response Example (Success Case):
{
"pongResponse": {
"pingFromRemoteIp": "83.150.39.44",
"pingFromRemoteUserId": 13,
"productVersion": "0.2.0",
"recorderComponentVersion": "1.1.0",
"isRecording": false,
"recordHostFilter": "www.dkfqa.com",
"numRecordedElements": 0,
"osName": "Linux",
"osVersion": "5.4.0-74-generic",
"javaMemoryMB": 2048,
"javaVersion": "11.0.1",
"javaVendor": "Oracle Corporation",
"systemTime": 1625529858405,
"deltaTimeMillis": 790,
"httpExecuteTimeMillis": 88
},
"isError": false
}
JSON Response Example (Error Case):
{
"isError": true,
"genericErrorText": "connect timed out",
"recorderNotReachableError": true,
"recorderIdError": false,
"recorderAccessDeniedError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"deleteProxyRecorder",
"recorderId":10
}
JSON Response Example (Success Case):
{"isError":false}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"getProxyRecordersClientCertificates"
}
JSON Response Example (Success Case):
{
"clientCertificatesArray": [
{
"certificateId": 1,
"ownerUserId": 13,
"recorderId": -1,
"originalCertFileName": "fischer@dkfqa.com.p12",
"certFileType": "PKCS#12",
"certFileDataB64": "MIIRQQ.....CAA=",
"certPassword": "12345678",
"certDescription": "Fischer's Cert",
"certActive": true,
"applyForHost": "192.168.0.100",
"applyForPort": 499
},
{
"certificateId": 3,
"ownerUserId": 13,
"recorderId": -1,
"originalCertFileName": "miller@dkfqa.com.p12",
"certFileType": "PKCS#12",
"certFileDataB64": "MIIRXB.....CCAA=",
"certPassword": "abcdefgh",
"certDescription": "",
"certActive": false,
"applyForHost": "www.werwaswo.com",
"applyForPort": 443
}
],
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"addProxyRecordersClientCertificate",
"recorderId": -1,
"certFileName": "felix@dkfqa.com.p12",
"certFileType": "PKCS#12",
"certFileDataB64": "MIIRQQIBAzCCEQ.....3dUWQICCAA=",
"certPassword": "mammamia",
"certDescription":"",
"certActive": true,
"applyForHost": "www.dkfqa.com",
"applyForPort": 443
}
JSON Response Example (Success Case):
{
"addedClientCertificate": {
"certificateId": 5,
"ownerUserId": 13,
"recorderId": -1,
"originalCertFileName": "felix@dkfqa.com.p12",
"certFileType": "PKCS#12",
"certDescription": "",
"certActive": true,
"applyForHost": "www.dkfqa.com",
"applyForPort": 443
},
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"setProxyRecordersClientCertificateActive",
"certificateId": 5,
"certActive": false
}
JSON Response Example (Success Case):
{
"updatedClientCertificate": {
"certificateId": 5,
"ownerUserId": 13,
"recorderId": -1,
"originalCertFileName": "felix@dkfqa.com.p12",
"certFileType": "PKCS#12",
"certDescription": "",
"certActive": false,
"applyForHost": "www.dkfqa.com",
"applyForPort": 443
},
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"modifyProxyRecordersClientCertificate",
"certificateId": 5,
"certDescription": "My Cert",
"applyForHost": "www.dkfqa.com",
"applyForPort": 444
}
JSON Response Example (Success Case):
{
"updatedClientCertificate": {
"certificateId": 5,
"ownerUserId": 13,
"recorderId": -1,
"originalCertFileName": "felix@dkfqa.com.p12",
"certFileType": "PKCS#12",
"certDescription": "My Cert",
"certActive": false,
"applyForHost": "www.dkfqa.com",
"applyForPort": 444
},
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"deleteProxyRecordersClientCertificate",
"certificateId": 5
}
JSON Response Example (Success Case):
{"isError": false}
JSON Response Example (Error Case):
{"isError": true, "genericErrorText": "Invalid certificate Id"}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"getTestjobTemplates"
}
JSON Response Example (Success Case):
{
"testjobTemplatesArray": [
{
"testjobTemplate": {
"templateId": 10,
"templateName": "SimpleTest 1VU",
"templateDescription": "",
"testjobProperties": {
"testjobResultFileName": "",
"executeMeasuringAgentClusterInfo": "",
"testjobConcurrentUsers": "1",
"testjobDescription": "SimpleTest",
"testjobDebugMeasuring": "false",
"testjobMaxTestDuration": "30",
"isClusterJob": "",
"testjobRampUpTime": "10",
"localTestjobId": "",
"testjobMaxLoopsPerUser": "1",
"productVersion": "4.8.23",
"remoteTestjobId": "",
"testjobAdditionalArguments": "",
"definedFromTestId": "384",
"testjobSignature": "",
"testjobDelayPerLoop": "1000",
"testjobExitCode": "",
"createTimeStamp": "1694549684261",
"userInputFieldsFileName": "",
"testjobType": "load test",
"enableAutomaticFileSync": "true",
"testjobState": "invalid",
"isClusterControllerJobProperties": "",
"testjobDebugExecution": "false",
"executeOnUserMeasuringAgentId": "",
"definedFromTimeZoneId": "Europe/Berlin",
"executeMeasuringAgentInfo": "",
"executeOnMeasuringAgentClusterId": ""
},
"hasUserInputFields": false
},
"testIsHealthy": true
},
{
"testjobTemplate": {
"templateId": 11,
"templateName": "SimpleTestWithInputFields 10VU",
"templateDescription": "",
"testjobProperties": {
"testjobResultFileName": "",
"executeMeasuringAgentClusterInfo": "",
"testjobConcurrentUsers": "10",
"testjobDescription": "SimpleTestWithInputFields",
"testjobDebugMeasuring": "false",
"testjobMaxTestDuration": "60",
"isClusterJob": "",
"testjobRampUpTime": "10",
"localTestjobId": "",
"testjobMaxLoopsPerUser": "5",
"productVersion": "4.8.23",
"remoteTestjobId": "",
"testjobAdditionalArguments": "",
"definedFromTestId": "385",
"testjobSignature": "",
"testjobDelayPerLoop": "1000",
"testjobExitCode": "",
"createTimeStamp": "1695047319785",
"userInputFieldsFileName": "InputFields_SimpleTestWithInputFields.json",
"testjobType": "load test",
"enableAutomaticFileSync": "true",
"testjobState": "invalid",
"isClusterControllerJobProperties": "",
"testjobDebugExecution": "true",
"executeOnUserMeasuringAgentId": "",
"definedFromTimeZoneId": "Europe/Berlin",
"executeMeasuringAgentInfo": "",
"executeOnMeasuringAgentClusterId": ""
},
"hasUserInputFields": true,
"userInputFieldsFile": {
"useShortNames": false,
"magicPattern": "UserInputFields",
"productVersion": "4.8.23",
"userInputFieldsArray": [
{
"useShortNames": false,
"productVersion": "4.8.23",
"label": "Input Host",
"variableName": "vHost",
"inputType": "string",
"defaultValue": "126.3.4.5",
"currentValue": "126.3.4.5"
},
{
"useShortNames": false,
"productVersion": "4.8.23",
"label": "Input Port",
"variableName": "vPort",
"inputType": "integer",
"defaultValue": "444",
"currentValue": "444"
}
]
}
},
"testIsHealthy": true
}
],
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"defineNewTestjobFromTemplate",
"templateId":10,
"measuringAgentOrClusterId":65,
"isCluster":false,
"jobDescription": "Simple Test"
}
JSON Response Example (Success Case):
{
"newTestjobId":33533,
"isError":false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"submitTestjob",
"localTestjobId":33534
}
JSON Response Example (Success Case):
{
"isClusterJob": false,
"agentResponse": {
"remoteTestjobId": 24129,
"httpExecuteTimeMillis": 338
},
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"makeTestjobReadyToRun",
"localTestjobId":33534
}
JSON Response Example (Success Case):
{
"isClusterJob": false,
"agentResponse": {
"testjobProperties": {
"testjobResultFileName": "",
"executeMeasuringAgentClusterInfo": "",
"testjobConcurrentUsers": "1",
"testjobDescription": "Simple Test",
"testjobDebugMeasuring": "false",
"testjobMaxTestDuration": "30",
"isClusterJob": "false",
"testjobRampUpTime": "10",
"localTestjobId": "33534",
"testjobMaxLoopsPerUser": "1",
"productVersion": "4.8.18",
"remoteTestjobId": "24129",
"testjobAdditionalArguments": "",
"definedFromTestId": "384",
"testjobSignature": "Z9B963yIj232nht1DIX5aSRt8m77QuXpvVA5736Tl9Wc7UZ7jOiU3l6UC7y3Nx6CXDDZB4qUg4FHDtTuHsD9xd0T/CSq/g==",
"testjobDelayPerLoop": "1000",
"testjobExitCode": "",
"createTimeStamp": "1695050460395",
"userInputFieldsFileName": "",
"testjobType": "load test",
"enableAutomaticFileSync": "true",
"testjobState": "ready to run",
"isClusterControllerJobProperties": "",
"testjobDebugExecution": "false",
"executeOnUserMeasuringAgentId": "65",
"definedFromTimeZoneId": "Europe/Berlin",
"executeMeasuringAgentInfo": "agent2.realload.com:8080",
"executeOnMeasuringAgentClusterId": ""
},
"httpExecuteTimeMillis": 2871
},
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"startTestjob",
"localTestjobId":33534
}
JSON Response Example (Success Case):
{
"isClusterJob": false,
"agentResponse": {
"testjobProperties": {
"testjobResultFileName": "",
"executeMeasuringAgentClusterInfo": "",
"testjobConcurrentUsers": "1",
"testjobDescription": "Simple Test",
"testjobDebugMeasuring": "false",
"testjobMaxTestDuration": "30",
"isClusterJob": "false",
"testjobRampUpTime": "10",
"localTestjobId": "33534",
"testjobMaxLoopsPerUser": "1",
"productVersion": "4.8.18",
"remoteTestjobId": "24129",
"testjobAdditionalArguments": "",
"definedFromTestId": "384",
"testjobSignature": "Z9B963yIj232nht1DIX5aSRt8m77QuXpvVA5736Tl9Wc7UZ7jOiU3l6UC7y3Nx6CXDDZB4qUg4FHDtTuHsD9xd0T/CSq/g==",
"testjobDelayPerLoop": "1000",
"testjobExitCode": "",
"createTimeStamp": "1695050460395",
"userInputFieldsFileName": "",
"testjobType": "load test",
"enableAutomaticFileSync": "true",
"testjobState": "running",
"isClusterControllerJobProperties": "",
"testjobDebugExecution": "false",
"executeOnUserMeasuringAgentId": "65",
"definedFromTimeZoneId": "Europe/Berlin",
"executeMeasuringAgentInfo": "agent2.realload.com:8080",
"executeOnMeasuringAgentClusterId": ""
},
"httpExecuteTimeMillis": 249
},
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"getMeasuringAgentTestjobs",
"measuringAgentId":65,
"synchronizeLocalTestjobsState":true
}
JSON Response Example (Success Case):
{
"agentResponse": {
"allTestjobsArray": [
{
"testjobProperties": {
"testjobResultFileName": "TestResult_RealloadTest_2023-09-09@23-45-34.json",
"executeMeasuringAgentClusterInfo": "",
"testjobConcurrentUsers": "1",
"testjobDescription": "RealloadTest",
"testjobDebugMeasuring": "false",
"testjobMaxTestDuration": "60",
"isClusterJob": "false",
"testjobRampUpTime": "10",
"localTestjobId": "30717",
"testjobMaxLoopsPerUser": "1",
"productVersion": "4.8.18",
"remoteTestjobId": "15240",
"testjobAdditionalArguments": "",
"definedFromTestId": "379",
"testjobSignature": "NeYJG4vf8/joAwz4nR4Fie3W0Qr7ijps25ONuk6F5BLghuD8/clPL9mBKc/ogQiic7wI8OXOf53Mi4YDCpg4dQzuaWQ==",
"testjobDelayPerLoop": "1000",
"testjobExitCode": "0",
"createTimeStamp": "1694295923799",
"userInputFieldsFileName": "",
"testjobType": "load test",
"enableAutomaticFileSync": "true",
"testjobState": "completed",
"isClusterControllerJobProperties": "",
"testjobDebugExecution": "true",
"executeOnUserMeasuringAgentId": "65",
"definedFromTimeZoneId": "Europe/Berlin",
"executeMeasuringAgentInfo": "agent2.realload.com:8080",
"executeOnMeasuringAgentClusterId": ""
},
"testProperties": {
"referencedResourceFilesList": [
{
"projectId": 130,
"testplanId": 203,
"fileName": "com.dkfqs.selenium.jar"
},
{
"projectId": 130,
"testplanId": 203,
"fileName": "commons-io-2.13.0.jar"
},
{
"projectId": 130,
"testplanId": 203,
"fileName": "hamcrest-core-1.3.jar"
},
{
"projectId": 130,
"testplanId": 203,
"fileName": "com.dkfqs.tools.jar"
},
{
"projectId": 130,
"testplanId": 203,
"fileName": "junit-4.13.2.jar"
},
{
"projectId": 130,
"testplanId": 203,
"fileName": "selenium_bundle-4.12.1.jar"
}
],
"jsonConfigObject": {
"productVersion": "4.8.20",
"jUnitConfigExecutionClassArray": [
{
"productVersion": "4.8.20",
"executingClassName": "RealloadTest",
"testMethodNamesArray": [
"realload"
]
}
],
"seleniumWebBrowserType": "Firefox"
},
"executingScript": "RealloadTest.jar",
"executingScriptResourceFileList": "",
"createTimeStamp": "1694293491984",
"testDescription": "",
"definedFromTestplanId": "251",
"productVersion": "4.8.20",
"definedFromProjectId": "137",
"visibleTestName": "RealloadTest",
"scriptType": "Selenium4byJUnit4",
"testId": "379"
}
},
{
"testjobProperties": {
"testjobResultFileName": "TestResult_SimpleTest_2023-09-18@17-01-08.json",
"executeMeasuringAgentClusterInfo": "",
"testjobConcurrentUsers": "1",
"testjobDescription": "Simple Test",
"testjobDebugMeasuring": "false",
"testjobMaxTestDuration": "30",
"isClusterJob": "false",
"testjobRampUpTime": "10",
"localTestjobId": "33533",
"testjobMaxLoopsPerUser": "1",
"productVersion": "4.8.18",
"remoteTestjobId": "24112",
"testjobAdditionalArguments": "",
"definedFromTestId": "384",
"testjobSignature": "JYstx+myVNqbyVMr24u4Pi8IXkLGH0iXUquRh5+NL0veKs4DRJX/w2ZT77wLXF70J9YmTPzR7g==",
"testjobDelayPerLoop": "1000",
"testjobExitCode": "0",
"createTimeStamp": "1695049264730",
"userInputFieldsFileName": "",
"testjobType": "load test",
"enableAutomaticFileSync": "true",
"testjobState": "completed",
"isClusterControllerJobProperties": "",
"testjobDebugExecution": "false",
"executeOnUserMeasuringAgentId": "65",
"definedFromTimeZoneId": "Europe/Berlin",
"executeMeasuringAgentInfo": "agent2.realload.com:8080",
"executeOnMeasuringAgentClusterId": ""
},
"testProperties": {
"referencedResourceFilesList": [
{
"projectId": 130,
"testplanId": 203,
"fileName": "com.dkfqs.tools.jar"
}
],
"jsonConfigObject": {},
"executingScript": "SimpleTest.jar",
"executingScriptResourceFileList": "",
"createTimeStamp": "1694549112155",
"testDescription": "",
"definedFromTestplanId": "251",
"productVersion": "4.8.21",
"definedFromProjectId": "137",
"visibleTestName": "SimpleTest",
"scriptType": "OpenJDK11Jar",
"testId": "384"
}
},
{
"testjobProperties": {
"testjobResultFileName": "TestResult_SimpleTest_2023-09-18@17-51-53.json",
"executeMeasuringAgentClusterInfo": "",
"testjobConcurrentUsers": "1",
"testjobDescription": "Simple Test",
"testjobDebugMeasuring": "false",
"testjobMaxTestDuration": "30",
"isClusterJob": "false",
"testjobRampUpTime": "10",
"localTestjobId": "33534",
"testjobMaxLoopsPerUser": "1",
"productVersion": "4.8.18",
"remoteTestjobId": "24129",
"testjobAdditionalArguments": "",
"definedFromTestId": "384",
"testjobSignature": "Z9B963yIj232nht1DIX5aSRt8m77QuXYjP9rn4OBSq/g==",
"testjobDelayPerLoop": "1000",
"testjobExitCode": "0",
"createTimeStamp": "1695050460395",
"userInputFieldsFileName": "",
"testjobType": "load test",
"enableAutomaticFileSync": "true",
"testjobState": "completed",
"isClusterControllerJobProperties": "",
"testjobDebugExecution": "false",
"executeOnUserMeasuringAgentId": "65",
"definedFromTimeZoneId": "Europe/Berlin",
"executeMeasuringAgentInfo": "agent2.realload.com:8080",
"executeOnMeasuringAgentClusterId": ""
},
"testProperties": {
"referencedResourceFilesList": [
{
"projectId": 130,
"testplanId": 203,
"fileName": "com.dkfqs.tools.jar"
}
],
"jsonConfigObject": {},
"executingScript": "SimpleTest.jar",
"executingScriptResourceFileList": "",
"createTimeStamp": "1694549112155",
"testDescription": "",
"definedFromTestplanId": "251",
"productVersion": "4.8.21",
"definedFromProjectId": "137",
"visibleTestName": "SimpleTest",
"scriptType": "OpenJDK11Jar",
"testId": "384"
}
}
],
"httpExecuteTimeMillis": 141
},
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"getTestjobOutDirectoryFilesInfo",
"localTestjobId":33534
}
JSON Response Example (Success Case):
{
"isClusterJob": false,
"measuringAgentData": {
"agentId": 65,
"createdBySystem": false,
"ownerUserId": 13,
"agentActive": true,
"agentDescription": "Demo Agent 2",
"agentHost": "agent2.realload.com",
"agentPort": 8080,
"authToken": "************",
"sharedMeasuringAgentTemplateId": -1,
"isLaunchedByCloudCredits": false
},
"filesInfoArray": [
{
"fileName": "DataCollector.err",
"fileSize": 0,
"lastModified": 1695051456261,
"mimeType": "application/octet-stream"
},
{
"fileName": "DataCollector.out",
"fileSize": 5647,
"lastModified": 1695052318516,
"mimeType": "application/octet-stream"
},
{
"fileName": "DataCollector.pid",
"fileSize": 8,
"lastModified": 1695051456273,
"mimeType": "application/octet-stream"
},
{
"fileName": "DataCollector.port",
"fileSize": 6,
"lastModified": 1695051457729,
"mimeType": "application/octet-stream"
},
{
"fileName": "DataCollector.state",
"fileSize": 2,
"lastModified": 1695052318512,
"mimeType": "application/octet-stream"
},
{
"fileName": "TestResult_SimpleTest_2023-09-18@17-51-53.json",
"fileSize": 7421,
"lastModified": 1695052315488,
"mimeType": "application/json"
},
{
"fileName": "user_1_statistics.out",
"fileSize": 5037,
"lastModified": 1695052313788,
"mimeType": "application/octet-stream"
},
{
"fileName": "users.out",
"fileSize": 1923,
"lastModified": 1695052314000,
"mimeType": "application/octet-stream"
}
],
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"getTestjobOutDirectoryFile",
"localTestjobId":33534,
"fileName":"users.out"
}
JSON Response Example (Success Case):
{
"isClusterJob": false,
"measuringAgentData": {
"agentId": 65,
"createdBySystem": false,
"ownerUserId": 13,
"agentActive": true,
"agentDescription": "Demo Agent 2",
"agentHost": "agent2.realload.com",
"agentPort": 8080,
"authToken": "************",
"sharedMeasuringAgentTemplateId": -1,
"isLaunchedByCloudCredits": false
},
"fileContentB64": "MjAyMy0wOS0xOCAxNTo1MTo1Mi42MjYgfCBtYWluIHwgSU5GTyB8IE1heC4gSmF2YSBNZW1vcnkgPSAzMzAwIE1CCjIwMjMtMDktMTggMTU6NTE6NTIuNjU1IHwgbWFpbiB8IElORk8gfCBUaW1lIFpvbmUgPSBDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSArMDA6MDAKMjAyMy0wOS0xOCAxNTo1MTo1Mi42NjggfCBtYWluIHwgSU5GTyB8IC0tLSB2dnYgLS0tIHJlc291cmNlIGZpbGVzIC0tLSB2dnYgLS0tCjIwMjMtMDktMTggMTU6NTE6NTIuNjY5IHwgbWFpbiB8IElORk8gfCAtLS0gXl5eIC0tLSByZXNvdXJjZSBmaWxlcyAtLS0gXl5eIC0tLQoyMDIzLTA5LTE4IDE1OjUxOjUyLjY2OSB8IG1haW4gfCBJTkZPIHwgLS0tIHZ2diAtLS0gZ2VuZXJpYyBhcmd1bWVudHMgLS0tIHZ2diAtLS0KMjAyMy0wOS0xOCAxNTo1MTo1Mi42NjkgfCBtYWluIHwgSU5GTyB8IHVzZXJzID0gMQoyMDIzLTA5LTE4IDE1OjUxOjUyLjY2OSB8IG1haW4gfCBJTkZPIHwgZHVyYXRpb24gPSAzMAoyMDIzLTA5LTE4IDE1OjUxOjUyLjY3MCB8IG1haW4gfCBJTkZPIHwgbWF4TG9vcHMgPSAxCjIwMjMtMDktMTggMTU6NTE6NTIuNjcwIHwgbWFpbiB8IElORk8gfCBkZWxheVBlckxvb3AgPSAxMDAwCjIwMjMtMDktMTggMTU6NTE6NTIuNjcwIHwgbWFpbiB8IElORk8gfCByYW1wdXBUaW1lID0gMTAKMjAyMy0wOS0xOCAxNTo1MTo1Mi42NzAgfCBtYWluIHwgSU5GTyB8IGRhdGFPdXRwdXREaXIgPSAvaG9tZS9ka2Zxcy9hZ2VudC91c2Vyc0RhdGEvVXNlcl8xMy9UZXN0Sm9icy9UZXN0am9iXzI0MTI5L291dAoyMDIzLTA5LTE4IDE1OjUxOjUyLjY3MCB8IG1haW4gfCBJTkZPIHwgZGVidWdFeGVjID0gZmFsc2UKMjAyMy0wOS0xOCAxNTo1MTo1Mi42NzEgfCBtYWluIHwgSU5GTyB8IGRlYnVnRGF0YSA9IGZhbHNlCjIwMjMtMDktMTggMTU6NTE6NTIuNjcxIHwgbWFpbiB8IElORk8gfCBkZXNjcmlwdGlvbiA9IFNpbXBsZSBUZXN0CjIwMjMtMDktMTggMTU6NTE6NTIuNjcxIHwgbWFpbiB8IElORk8gfCAtLS0gXl5eIC0tLSBnZW5lcmljIGFyZ3VtZW50cyAtLS0gXl5eIC0tLQoyMDIzLTA5LTE4IDE1OjUxOjUyLjkyMSB8IG1haW4gfCBJTkZPIHwgSlZNIFdhcm11cCBwZXJmb3JtZWQgaW4gMjM2IG1zCjIwMjMtMDktMTggMTU6NTE6NTIuOTc3IHwgbWFpbiB8IElORk8gfCAtLS0gdnZ2IC0tLSBzcGVjaWZpYyBhcmd1bWVudHMgLS0tIHZ2diAtLS0KMjAyMy0wOS0xOCAxNTo1MTo1Mi45OTQgfCBtYWluIHwgSU5GTyB8IHRjcFRpbWVvdXQgPSAxMDAwMAoyMDIzLTA5LTE4IDE1OjUxOjUyLjk5NSB8IG1haW4gfCBJTkZPIHwgc3NsVGltZW91dCA9IDUwMDAKMjAyMy0wOS0xOCAxNTo1MTo1Mi45OTcgfCBtYWluIHwgSU5GTyB8IGh0dHBUaW1lb3V0ID0gMzAwMDAKMjAyMy0wOS0xOCAxNTo1MTo1Mi45OTcgfCBtYWluIHwgSU5GTyB8IC0tLSBeXl4gLS0tIHNwZWNpZmljIGFyZ3VtZW50cyAtLS0gXl5eIC0tLQoyMDIzLTA5LTE4IDE1OjUxOjUzLjAwMiB8IG1haW4gfCBJTkZPIHwgW1N0YXJ0IG9mIFRlc3RdCjIwMjMtMDktMTggMTU6NTE6NTMuMDAzIHwgVXNlci0xIHwgSU5GTyB8IFVzZXIgc3RhcnRlZAoyMDIzLTA5LTE4IDE1OjUxOjUzLjAyNiB8IHBlcmlvZGljLXRocmVhZCB8IElORk8gfCBUaHJlYWQgc3RhcnRlZAoyMDIzLTA5LTE4IDE1OjUxOjUzLjAyNiB8IFVzZXItMSB8IElORk8gfCBTdGFydCBleGVjdXRlIHNlc3Npb24gbm8uIDEgLi4uCjIwMjMtMDktMTggMTU6NTE6NTMuNTk3IHwgVXNlci0xIHwgSU5GTyB8IC4uLiBFbmQgZXhlY3V0ZSBzZXNzaW9uIG5vLiAxIHN1Y2Nlc3NmdWwgcGFzc2VkCjIwMjMtMDktMTggMTU6NTE6NTMuNjQ5IHwgVXNlci0xIHwgSU5GTyB8IFVzZXIgbm9ybWFsIHRlcm1pbmF0ZWQKMjAyMy0wOS0xOCAxNTo1MTo1NC4wMDMgfCBtYWluIHwgSU5GTyB8IFtFbmQgb2YgVGVzdF0K",
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"saveTestjobOutDirectoryFileToProjectTree",
"localTestjobId":33534,
"fileName":"users.out",
"saveAsFileName":"users.out",
"projectId":137,
"resourceSetId":251
}
JSON Response Example (Success Case):
{
"isClusterJob": false,
"fileHashCode": 4557110,
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"deleteTestjob",
"localTestjobId":33534,
"deleteAlsoRemoteTestjob":true
}
JSON Response Example (Success Case):
{
"isClusterJob": false,
"localTestjobState": "completed",
"agentResponse": {
"httpExecuteTimeMillis": 143
},
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
Values of testRunResultsArray[n].executionState :
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"getTestExecutionSuites"
}
JSON Response Example (Success Case):
{
"testExecutionSuitesArray": [
{
"testExecutionSuite": {
"testExecutionSuiteId": 2,
"testExecutionSuiteName": "First Suite",
"testExecutionSuiteDescription": "",
"topExecuteOnMeasuringAgentOrClusterId": "m-145",
"topExecutionOrder": 2,
"totalNumberOfTestjobs": 3,
"isTestExecutionSuiteHealthy": true
},
"testRunResultsArray": [
{
"userId": 13,
"subUserId": -1,
"testRunId": 1,
"executionState": 2,
"annotationArray": [],
"testRunStartTimestamp": 1699716014207,
"testRunLastUpdatedTimestamp": 1699716054368,
"numTestjobTemplatesToExecute": 3,
"numTestjobTemplatesExecutionPassed": 3,
"numTestjobTemplatesExecutionFailed": 0,
"totalSessionsPassed": 8,
"totalSessionsFailed": 0,
"totalSessionsPassedTimeSum": 5295,
"totalSamplesPassed": 12,
"totalSamplesFailed": 0,
"maxConcurrentUsers": 1,
"maxPendingSamples": 1
},
{
"userId": 13,
"subUserId": -1,
"testRunId": 2,
"executionState": 2,
"annotationArray": [],
"testRunStartTimestamp": 1699716108571,
"testRunLastUpdatedTimestamp": 1699716151826,
"numTestjobTemplatesToExecute": 3,
"numTestjobTemplatesExecutionPassed": 3,
"numTestjobTemplatesExecutionFailed": 0,
"totalSessionsPassed": 8,
"totalSessionsFailed": 0,
"totalSessionsPassedTimeSum": 5503,
"totalSamplesPassed": 12,
"totalSamplesFailed": 0,
"maxConcurrentUsers": 1,
"maxPendingSamples": 1
}
]
},
{
"testExecutionSuite": {
"testExecutionSuiteId": 3,
"testExecutionSuiteName": "Second Suite Long Run",
"testExecutionSuiteDescription": "",
"topExecuteOnMeasuringAgentOrClusterId": "c-27",
"topExecutionOrder": 1,
"totalNumberOfTestjobs": 2,
"isTestExecutionSuiteHealthy": true
},
"testRunResultsArray": [
{
"userId": 13,
"subUserId": -1,
"testRunId": 1,
"executionState": 2,
"annotationArray": [],
"testRunStartTimestamp": 1699715808192,
"testRunLastUpdatedTimestamp": 1699715867468,
"numTestjobTemplatesToExecute": 2,
"numTestjobTemplatesExecutionPassed": 2,
"numTestjobTemplatesExecutionFailed": 0,
"totalSessionsPassed": 44,
"totalSessionsFailed": 0,
"totalSessionsPassedTimeSum": 4400,
"totalSamplesPassed": 44,
"totalSamplesFailed": 0,
"maxConcurrentUsers": 4,
"maxPendingSamples": 4
},
{
"userId": 13,
"subUserId": -1,
"testRunId": 2,
"executionState": 2,
"annotationArray": [],
"testRunStartTimestamp": 1699715952212,
"testRunLastUpdatedTimestamp": 1699716012124,
"numTestjobTemplatesToExecute": 2,
"numTestjobTemplatesExecutionPassed": 2,
"numTestjobTemplatesExecutionFailed": 0,
"totalSessionsPassed": 44,
"totalSessionsFailed": 0,
"totalSessionsPassedTimeSum": 4400,
"totalSamplesPassed": 44,
"totalSamplesFailed": 0,
"maxConcurrentUsers": 4,
"maxPendingSamples": 3
},
{
"userId": 13,
"subUserId": -1,
"testRunId": 3,
"executionState": 2,
"annotationArray": [],
"testRunStartTimestamp": 1699717843777,
"testRunLastUpdatedTimestamp": 1699717905674,
"numTestjobTemplatesToExecute": 2,
"numTestjobTemplatesExecutionPassed": 2,
"numTestjobTemplatesExecutionFailed": 0,
"totalSessionsPassed": 43,
"totalSessionsFailed": 0,
"totalSessionsPassedTimeSum": 4300,
"totalSamplesPassed": 43,
"totalSamplesFailed": 0,
"maxConcurrentUsers": 4,
"maxPendingSamples": 3
}
]
}
],
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"getCurrentlyRunningTestExecutionSuiteIds"
}
JSON Response Example (Success Case):
{
"testExecutionSuiteIdArray": [
3
],
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"startTestExecutionSuiteTestRun",
"testExecutionSuiteId":3,
"testRunAnnotation":"",
"topExecuteOnMeasuringAgentOrClusterId":143,
"topExecuteOnCluster":false
}
JSON Response Example (Success Case):
{
"newTestRunId": 5,
"isError": false
}
JSON Response Example (Error Case):
{
"isError": true,
"genericErrorText": "Test execution suite currently running"
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
Values of executionState :
Values of logLevel :
Values of elementType :
Values of executionOrder :
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"getTestExecutionSuiteTestRunResultDetail",
"testExecutionSuiteId":3,
"testRunId":5
}
JSON Response Example (Success Case):
{
"testRunResultDetail": {
"testRunResult": {
"userId": 13,
"subUserId": -1,
"testExecutionSuite": {
"testExecutionSuiteId": 3,
"testExecutionSuiteName": "Second Suite Long Run",
"testExecutionSuiteDescription": "",
"topExecuteOnMeasuringAgentOrClusterId": "c-27",
"topExecutionOrder": 1,
"testExecutionElementsArray": [
{
"productVersion": "4.8.24",
"elementType": 10,
"elementId": 737867696,
"elementInactive": false,
"executionGroupName": "Top Group",
"executionGroupDescription": "",
"executionOrder": 2,
"executeOnMeasuringAgentOrClusterId": "",
"executionElementsArray": [
{
"productVersion": "4.8.24",
"elementType": 1,
"elementId": 1040705161,
"elementInactive": false,
"templateId": 18
},
{
"productVersion": "4.8.24",
"elementType": 1,
"elementId": 493179849,
"elementInactive": false,
"templateId": 18
}
]
}
]
},
"testjobTemplatesArray": [
{
"templateId": 18,
"templateName": "Simple Test 2VU Long Run",
"templateDescription": "",
"testjobProperties": {
"testjobResultFileName": "",
"executeMeasuringAgentClusterInfo": "",
"testjobConcurrentUsers": "2",
"testjobDescription": "Simple Test 2VU Long Run",
"testjobDebugMeasuring": "false",
"testjobMaxTestDuration": "30",
"isClusterJob": "",
"testjobRampUpTime": "1",
"localTestjobId": "",
"testjobMaxLoopsPerUser": "-1",
"productVersion": "4.8.24",
"remoteTestjobId": "",
"testjobAdditionalArguments": "",
"definedFromTestId": "384",
"testjobSignature": "",
"testjobDelayPerLoop": "3000",
"testjobExitCode": "",
"createTimeStamp": "1697224057753",
"userInputFieldsFileName": "",
"testjobType": "load test",
"enableAutomaticFileSync": "true",
"testjobState": "invalid",
"isClusterControllerJobProperties": "",
"testjobDebugExecution": "false",
"executeOnUserMeasuringAgentId": "",
"definedFromTimeZoneId": "Europe/Berlin",
"executeMeasuringAgentInfo": "",
"executeOnMeasuringAgentClusterId": ""
},
"hasUserInputFields": false
}
],
"testRunId": 5,
"executorLog": {
"userId": 13,
"testExecutionSuiteId": 3,
"testRunId": 5,
"logEntriesArray": [
{
"timestamp": 1699726961703,
"logLevel": 7,
"threadName": "TestSuiteExecutor-S:3-R:5",
"testExecutionElementId": -1,
"logMessage": "Test run #5 started",
"stacktraceArray": []
},
{
"timestamp": 1699726963704,
"logLevel": 7,
"threadName": "TestSuiteExecutorGroup-S:3-R:5-G:737867696",
"testExecutionElementId": 737867696,
"logMessage": "Execution Group 'Top Group' started",
"stacktraceArray": []
},
{
"timestamp": 1699726963706,
"logLevel": 7,
"threadName": "TestSuiteExecutorGroup-S:3-R:5-T:1040705161",
"testExecutionElementId": 1040705161,
"logMessage": "Test Job Template 'Simple Test 2VU Long Run' execution started",
"stacktraceArray": []
},
{
"timestamp": 1699726963708,
"logLevel": 7,
"threadName": "TestSuiteExecutorGroup-S:3-R:5-T:493179849",
"testExecutionElementId": 493179849,
"logMessage": "Test Job Template 'Simple Test 2VU Long Run' execution started",
"stacktraceArray": []
},
{
"timestamp": 1699726963731,
"logLevel": 7,
"threadName": "TestSuiteExecutorGroup-S:3-R:5-T:1040705161",
"testExecutionElementId": 1040705161,
"logMessage": "Test Job Template 'Simple Test 2VU Long Run' test job defined with id = 34442",
"stacktraceArray": []
},
{
"timestamp": 1699726963753,
"logLevel": 7,
"threadName": "TestSuiteExecutorGroup-S:3-R:5-T:493179849",
"testExecutionElementId": 493179849,
"logMessage": "Test Job Template 'Simple Test 2VU Long Run' test job defined with id = 34443",
"stacktraceArray": []
},
{
"timestamp": 1699726964081,
"logLevel": 7,
"threadName": "TestSuiteExecutorGroup-S:3-R:5-T:1040705161",
"testExecutionElementId": 1040705161,
"logMessage": "Test Job Template 'Simple Test 2VU Long Run' test job submitted to 'Shared Agent 2', remote test job id = 791",
"stacktraceArray": []
},
{
"timestamp": 1699726964128,
"logLevel": 7,
"threadName": "TestSuiteExecutorGroup-S:3-R:5-T:493179849",
"testExecutionElementId": 493179849,
"logMessage": "Test Job Template 'Simple Test 2VU Long Run' test job submitted to 'Shared Agent 2', remote test job id = 792",
"stacktraceArray": []
},
{
"timestamp": 1699726968458,
"logLevel": 7,
"threadName": "TestSuiteExecutorGroup-S:3-R:5-T:493179849",
"testExecutionElementId": 493179849,
"logMessage": "Test Job Template 'Simple Test 2VU Long Run' started on 'Shared Agent 2', remote test job id = 792",
"stacktraceArray": []
},
{
"timestamp": 1699726968466,
"logLevel": 7,
"threadName": "TestSuiteExecutorGroup-S:3-R:5-T:1040705161",
"testExecutionElementId": 1040705161,
"logMessage": "Test Job Template 'Simple Test 2VU Long Run' started on 'Shared Agent 2', remote test job id = 791",
"stacktraceArray": []
},
{
"timestamp": 1699727005910,
"logLevel": 7,
"threadName": "TestSuiteExecutorGroup-S:3-R:5-T:493179849",
"testExecutionElementId": 493179849,
"logMessage": "Test Job Template 'Simple Test 2VU Long Run' execution successful",
"stacktraceArray": []
},
{
"timestamp": 1699727006912,
"logLevel": 7,
"threadName": "TestSuiteExecutorGroup-S:3-R:5-T:1040705161",
"testExecutionElementId": 1040705161,
"logMessage": "Test Job Template 'Simple Test 2VU Long Run' execution successful",
"stacktraceArray": []
},
{
"timestamp": 1699727012111,
"logLevel": 7,
"threadName": "TestSuiteExecutorGroup-S:3-R:5-T:1040705161",
"testExecutionElementId": 1040705161,
"logMessage": "Test Job Template 'Simple Test 2VU Long Run' execution terminated",
"stacktraceArray": []
},
{
"timestamp": 1699727012112,
"logLevel": 7,
"threadName": "TestSuiteExecutorGroup-S:3-R:5-T:493179849",
"testExecutionElementId": 493179849,
"logMessage": "Test Job Template 'Simple Test 2VU Long Run' execution terminated",
"stacktraceArray": []
},
{
"timestamp": 1699727012113,
"logLevel": 7,
"threadName": "TestSuiteExecutorGroup-S:3-R:5-G:737867696",
"testExecutionElementId": 737867696,
"logMessage": "Execution Group 'Top Group' terminated",
"stacktraceArray": []
},
{
"timestamp": 1699727014114,
"logLevel": 7,
"threadName": "TestSuiteExecutor-S:3-R:5",
"testExecutionElementId": -1,
"logMessage": "Test run #5 done. Execution state = completed",
"stacktraceArray": []
}
]
},
"executionState": 2,
"annotationArray": [],
"testRunStartTimestamp": 1699726961701,
"testRunLastUpdatedTimestamp": 1699727012113,
"numTestjobTemplatesToExecute": 2,
"numTestjobTemplatesExecutionPassed": 2,
"numTestjobTemplatesExecutionFailed": 0,
"totalSessionsPassed": 44,
"totalSessionsFailed": 0,
"totalSessionsPassedTimeSum": 4400,
"totalSamplesPassed": 44,
"totalSamplesFailed": 0,
"maxConcurrentUsers": 4,
"maxPendingSamples": 2,
"testRunExecutionGroupResultArray": [
{
"testExecutionSuiteId": 3,
"testRunId": 5,
"executionGroupElementId": 737867696,
"containsMeasuringAgent": true,
"measuringAgent": {
"agentId": 143,
"createdBySystem": true,
"ownerUserId": 13,
"agentActive": true,
"agentDescription": "Shared Agent 2",
"agentHost": "192.168.0.50",
"agentPort": 8081,
"sharedMeasuringAgentTemplateId": 5,
"isLaunchedByCloudCredits": false
},
"containsMeasuringAgentCluster": false,
"executionState": 2,
"executionStartTimestamp": 1699726963704,
"executionEndTimestamp": 1699727012113,
"numTestjobTemplatesExecutionPassed": 2,
"numTestjobTemplatesExecutionFailed": 0,
"totalSessionsPassed": 44,
"totalSessionsFailed": 0,
"totalSessionsPassedTimeSum": 4400,
"totalSamplesPassed": 44,
"totalSamplesFailed": 0
}
],
"testRunTestjobResultArray": [
{
"testExecutionSuiteId": 3,
"testRunId": 5,
"testExecutionGroupElementId": 737867696,
"testjobTemplateElementId": 493179849,
"testjobTemplate": {
"templateId": 18,
"templateName": "Simple Test 2VU Long Run",
"templateDescription": "",
"testjobProperties": {
"testjobResultFileName": "TestResult_SimpleTest_2023-11-11@19-22-49.json",
"executeMeasuringAgentClusterInfo": "",
"testjobConcurrentUsers": "2",
"testjobDescription": "Simple Test 2VU Long Run",
"testjobDebugMeasuring": "false",
"testjobMaxTestDuration": "30",
"isClusterJob": "false",
"testjobRampUpTime": "1",
"localTestjobId": "34443",
"testjobMaxLoopsPerUser": "-1",
"productVersion": "4.8.24",
"remoteTestjobId": "792",
"testjobAdditionalArguments": "",
"definedFromTestId": "384",
"testjobSignature": "",
"testjobDelayPerLoop": "3000",
"testjobExitCode": "",
"createTimeStamp": "1697224057753",
"userInputFieldsFileName": "",
"testjobType": "load test",
"enableAutomaticFileSync": "true",
"testjobState": "invalid",
"isClusterControllerJobProperties": "",
"testjobDebugExecution": "false",
"executeOnUserMeasuringAgentId": "143",
"definedFromTimeZoneId": "Europe/Berlin",
"executeMeasuringAgentInfo": "Shared Agent 2",
"executeOnMeasuringAgentClusterId": ""
},
"hasUserInputFields": false
},
"executionState": 2,
"executionStartTimestamp": 1699726963708,
"executionEndTimestamp": 1699727005710,
"jobStartTimestamp": 1699726969618,
"jobEndTimestamp": 1699727003517,
"totalSessionsPassed": 22,
"totalSessionsFailed": 0,
"totalSessionsPassedTimeSum": 2200,
"totalSamplesPassed": 22,
"totalSamplesFailed": 0,
"maxConcurrentUsers": 2,
"maxPendingSamples": 1
},
{
"testExecutionSuiteId": 3,
"testRunId": 5,
"testExecutionGroupElementId": 737867696,
"testjobTemplateElementId": 1040705161,
"testjobTemplate": {
"templateId": 18,
"templateName": "Simple Test 2VU Long Run",
"templateDescription": "",
"testjobProperties": {
"testjobResultFileName": "TestResult_SimpleTest_2023-11-11@19-22-49.json",
"executeMeasuringAgentClusterInfo": "",
"testjobConcurrentUsers": "2",
"testjobDescription": "Simple Test 2VU Long Run",
"testjobDebugMeasuring": "false",
"testjobMaxTestDuration": "30",
"isClusterJob": "false",
"testjobRampUpTime": "1",
"localTestjobId": "34442",
"testjobMaxLoopsPerUser": "-1",
"productVersion": "4.8.24",
"remoteTestjobId": "791",
"testjobAdditionalArguments": "",
"definedFromTestId": "384",
"testjobSignature": "",
"testjobDelayPerLoop": "3000",
"testjobExitCode": "",
"createTimeStamp": "1697224057753",
"userInputFieldsFileName": "",
"testjobType": "load test",
"enableAutomaticFileSync": "true",
"testjobState": "invalid",
"isClusterControllerJobProperties": "",
"testjobDebugExecution": "false",
"executeOnUserMeasuringAgentId": "143",
"definedFromTimeZoneId": "Europe/Berlin",
"executeMeasuringAgentInfo": "Shared Agent 2",
"executeOnMeasuringAgentClusterId": ""
},
"hasUserInputFields": false
},
"executionState": 2,
"executionStartTimestamp": 1699726963706,
"executionEndTimestamp": 1699727006711,
"jobStartTimestamp": 1699726969515,
"jobEndTimestamp": 1699727003517,
"totalSessionsPassed": 22,
"totalSessionsFailed": 0,
"totalSessionsPassedTimeSum": 2200,
"totalSamplesPassed": 22,
"totalSamplesFailed": 0,
"maxConcurrentUsers": 2,
"maxPendingSamples": 1
}
]
},
"executedByUserNickname": "DKF",
"testjobsOutFilesArray": [
{
"elementId": 1040705161,
"outFileInfoArray": [
{
"fileName": "DataCollector.err",
"fileSize": 0,
"lastModified": 1699727006724,
"mimeType": "application/octet-stream"
},
{
"fileName": "DataCollector.out",
"fileSize": 6537,
"lastModified": 1699727006726,
"mimeType": "application/octet-stream"
},
{
"fileName": "DataCollector.pid",
"fileSize": 7,
"lastModified": 1699727006736,
"mimeType": "application/octet-stream"
},
{
"fileName": "DataCollector.port",
"fileSize": 6,
"lastModified": 1699727006737,
"mimeType": "application/octet-stream"
},
{
"fileName": "DataCollector.state",
"fileSize": 1,
"lastModified": 1699727006738,
"mimeType": "application/octet-stream"
},
{
"fileName": "TestResult_SimpleTest_2023-11-11@19-22-49.json",
"fileSize": 11913,
"lastModified": 1699727006739,
"mimeType": "application/json"
},
{
"fileName": "users.out",
"fileSize": 5507,
"lastModified": 1699727006741,
"mimeType": "application/octet-stream"
}
]
},
{
"elementId": 493179849,
"outFileInfoArray": [
{
"fileName": "DataCollector.err",
"fileSize": 0,
"lastModified": 1699727005722,
"mimeType": "application/octet-stream"
},
{
"fileName": "DataCollector.out",
"fileSize": 6264,
"lastModified": 1699727005725,
"mimeType": "application/octet-stream"
},
{
"fileName": "DataCollector.pid",
"fileSize": 7,
"lastModified": 1699727005733,
"mimeType": "application/octet-stream"
},
{
"fileName": "DataCollector.port",
"fileSize": 6,
"lastModified": 1699727005734,
"mimeType": "application/octet-stream"
},
{
"fileName": "DataCollector.state",
"fileSize": 1,
"lastModified": 1699727005735,
"mimeType": "application/octet-stream"
},
{
"fileName": "TestResult_SimpleTest_2023-11-11@19-22-49.json",
"fileSize": 11850,
"lastModified": 1699727005736,
"mimeType": "application/json"
},
{
"fileName": "users.out",
"fileSize": 5507,
"lastModified": 1699727005738,
"mimeType": "application/octet-stream"
}
]
}
]
},
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"getTestExecutionSuiteTestRunTestJobOutputFileContent",
"testExecutionSuiteId":3,
"testRunId":5,
"testjobTemplateElementId":1040705161,
"fileName":"users.out"
}
JSON Response Example (Success Case):
{
"fileContentB64": "MjAyMy0xMS0xMSAxO ... uZCBvZiBUZXN0XQo=",
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"deleteTestExecutionSuiteTestRun",
"testExecutionSuiteId":3,
"testRunId":5
}
JSON Response Example (Success Case):
{
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"getOshiAlertProcessor"
}
JSON Response Example (Success Case):
{
"oshiAlertProcessor": {
"alertProcessorId": 5,
"alertProcessorDescription": "RealLoad Alert Processor",
"alertProcessorHost": "192.168.0.54",
"alertProcessorPort": 8099
},
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"getOshiSystems"
}
JSON Response Example (Success Case):
{
"oshiSystemsArray": [
{
"oshiSystemId": 19,
"ownerUserId": 13,
"systemActive": true,
"systemDescription": "Test System 1",
"oshiDaemonHost": "",
"oshiDaemonPort": -1,
"oshiDaemonUniqueId": "76Aq4KyAJqLWEYJZ"
},
{
"oshiSystemId": 20,
"ownerUserId": 13,
"systemActive": true,
"systemDescription": "Test System 2",
"oshiDaemonHost": "",
"oshiDaemonPort": -1,
"oshiDaemonUniqueId": "fEoyk5hGRViuSY9d"
},
{
"oshiSystemId": 13,
"ownerUserId": 13,
"systemActive": false,
"systemDescription": "Windows Server",
"oshiDaemonHost": "127.0.0.1",
"oshiDaemonPort": 8087,
"oshiDaemonUniqueId": "13uoTKLoIR3LWWln"
}
],
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"getConnectedOshiSystems"
}
JSON Response Example (Success Case):
{
"connectedOshiSystemsArray": [
{
"oshiSystemId": 20,
"ownerUserId": 13,
"systemActive": true,
"systemDescription": "Test System 2",
"oshiDaemonHost": "",
"oshiDaemonPort": -1,
"oshiDaemonUniqueId": "fEoyk5hGRViuSY9d",
"javaScriptProcessorEnabled": false,
"foreignAddress": "192.168.0.51"
},
{
"oshiSystemId": 19,
"ownerUserId": 13,
"systemActive": true,
"systemDescription": "Test System 1",
"oshiDaemonHost": "",
"oshiDaemonPort": -1,
"oshiDaemonUniqueId": "76Aq4KyAJqLWEYJZ",
"javaScriptProcessorEnabled": true,
"foreignAddress": "192.168.0.50"
}
],
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"addOshiSystem",
"systemDescription":"Test System 3",
"systemActive":true,
"oshiDaemonUniqueId":"xCoy88huioiuS8aa"
}
JSON Response Example (Success Case):
{
"newOshiSystemId": 22,
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"modifyOshiSystem",
"oshiSystemId":22,
"systemDescription":"Test System 3 (Berlin)",
"systemActive":false,
"oshiDaemonUniqueId":"xCoy88huioiuS8aa"
}
JSON Response Example (Success Case):
{
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"deleteOshiSystem",
"oshiSystemId":22
}
JSON Response Example (Success Case):
{
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"getOshiMonitoringRules"
}
JSON Response Example (Success Case):
{
"oshiMonitoringRulesArray": [
{
"ruleId": 27,
"lastModifiedTimestamp": 1728228133406,
"ruleTitle": "Check Average CPU Load",
"configurationInputFieldsArray": [
{
"label": "Last Minutes",
"variableName": "vLastMinutes",
"dataType": "number",
"defaultValue": "3",
"currentValue": ""
},
{
"label": "Warning Percent Threshold",
"variableName": "vWarningPercentThreshold",
"dataType": "number",
"defaultValue": "80",
"currentValue": ""
},
{
"label": "Error Percent Threshold",
"variableName": "vErrorPercentThreshold",
"dataType": "number",
"defaultValue": "95",
"currentValue": ""
}
],
"javaScriptLibrariesArray": [],
"javaScriptFunctionName": "checkAverageCpuLoad",
"javaScriptFunctionParametersArray": [
{
"oshiParameterType": "CurrentTimestamp"
},
{
"oshiParameterType": "CpuHistory"
}
],
"javaScriptCodeB64": "LyogTW9uaXRvcmluZyBSdWxlLgogKiBEZXNjcmlwdGlvbjogQ2hlY2sgZm9yIGhpZ2ggQ1BVIGxvYWQKICovCmZ1bmN0aW9uIGNoZWNrQXZlcmFnZUNwdUxvYWQocnVsZUNvbmZpZywgcnVsZUNvbnRleHQsIGN1cnJlbnRUaW1lc3RhbXAsIGNwdUhpc3RvcnkpIHsKCS8vIGNvbnNvbGUubG9nKGBydWxlQ29uZmlnID0gJHtKU09OLnN0cmluZ2lmeShydWxlQ29uZmlnKX1gKTsKCS8vIGNvbnNvbGUubG9nKGBydWxlQ29udGV4dCA9ICR7SlNPTi5zdHJpbmdpZnkocnVsZUNvbnRleHQpfWApOwoJLy8gY29uc29sZS5sb2coYGN1cnJlbnRUaW1lc3RhbXAgPSAke2N1cnJlbnRUaW1lc3RhbXB9YCk7CgkvLyBjb25zb2xlLmxvZyhgY3B1SGlzdG9yeSA9ICR7SlNPTi5zdHJpbmdpZnkoY3B1SGlzdG9yeSl9YCk7ICAvLyBkZWZhdWx0IHNvcnRpbmc6IG9sZCB0byBuZXcgaW5mb1RpbWVzdGFtcAoJCglpZiAocnVsZUNvbmZpZy52TGFzdE1pbnV0ZXMgPCAxKSB7CgkgICAgcmV0dXJuOwoJfQoJY29uc3Qgdkxhc3RNaW51dGVzID0gcnVsZUNvbmZpZy52TGFzdE1pbnV0ZXM7CgkKCS8vIGNhbGN1bGF0ZSB0aGUgYXZlcmFnZSBDUFUgbG9hZAoJY29uc3QgcmV2ZXJzZWRDcHVIaXN0b3J5ID0gY3B1SGlzdG9yeS5yZXZlcnNlKCk7Cgljb25zdCBtYXhPbGRlc3RUaW1lc3RhbXAgPSBjdXJyZW50VGltZXN0YW1wIC0gKHZMYXN0TWludXRlcyAqIDYwMDAwKTsKCWxldCBudW1WYWx1ZXMgPSAwOwoJbGV0IHN1bVZhbHVlcyA9IDA7Cglmb3IgKGxldCBjcHVJbmZvIG9mIHJldmVyc2VkQ3B1SGlzdG9yeSkgewoJICAgIGlmIChjcHVJbmZvLmluZm9UaW1lc3RhbXAgPj0gbWF4T2xkZXN0VGltZXN0YW1wKSB7CiAgICAgICAgICAgIG51bVZhbHVlcysrOwogICAgICAgICAgICBzdW1WYWx1ZXMgPSBzdW1WYWx1ZXMgKyBjcHVJbmZvLnN5c3RlbUNwdUxvYWRQZXJjZW50OwogICAgICAgICAgICBjb250aW51ZTsKCSAgICB9CgkgICAgYnJlYWs7Cgl9CglpZiAobnVtVmFsdWVzIDwgMTApIHsgICAvLyAxMCB2YWx1ZXMgKiA1IHNlY29uZHMgbWVhc3VyZW1lbnQgaW50ZXJ2YWwgPSA1MCBzZWNvbmRzCgkgICAgcmV0dXJuOyAvLyBub3QgZW5vdWdoIGRhdGEKCX0KCWNvbnN0IGF2ZXJhZ2VDcHVMb2FkID0gTWF0aC5yb3VuZCgoc3VtVmFsdWVzIC8gbnVtVmFsdWVzKSAqIDEwKSAvIDEwOyAvLyBjYWxjdWxhdGUgYXZlcmFnZSB2YWx1ZSBhbmQgcm91bmQgaXQgdG8gb25lIGRpZ2l0IGFmdGVyIHRoZSBkZWNpbWFsIHBvaW50CgkvLyBjb25zb2xlLmxvZyhgbnVtVmFsdWVzID0gJHtudW1WYWx1ZXN9LCBhdmVyYWdlQ3B1TG9hZCA9ICR7YXZlcmFnZUNwdUxvYWR9JWApOwoJCgljb25zdCBzeXN0ZW1EZXNjcmlwdGlvbiA9IHJ1bGVDb250ZXh0Lm9zaGlTeXN0ZW0uc3lzdGVtRGVzY3JpcHRpb247Cgljb25zdCBvc2hpRGFlbW9uVW5pcXVlSWQgPSBydWxlQ29udGV4dC5vc2hpU3lzdGVtLm9zaGlEYWVtb25VbmlxdWVJZDsKCQoJLy8gY3JlYXRlIHRoZSBhbGVydCBjb250ZXh0Cgljb25zdCBhbGVydENvbnRleHRBcnJheSA9IFtdOwoJY29uc3QgYWxlcnRDb250ZXh0S2V5ID0gb3NoaURhZW1vblVuaXF1ZUlkICsgJ3wnICsgJ2hpZ2hDcHVVc2FnZSc7Cgljb25zdCBhbGVydENvbnRleHREZXNjcmlwdGlvbiA9IGBDaGVjayBpZiAnJHtzeXN0ZW1EZXNjcmlwdGlvbn0nIGhhcyBoaWdoIENQVSB1c2FnZWA7Cgljb25zdCBtaW51dGVzVGV4dCA9IHZMYXN0TWludXRlcyA+IDEgPyBgJHt2TGFzdE1pbnV0ZXN9IG1pbnV0ZXNgIDogJ21pbnV0ZSc7Cgljb25zdCBhbGVydE1lc3NhZ2UgPSBgJyR7c3lzdGVtRGVzY3JpcHRpb259JzogVGhlIENQVSBsb2FkIG9mIHRoZSBsYXN0ICR7bWludXRlc1RleHR9IGlzICR7YXZlcmFnZUNwdUxvYWR9JWA7CglsZXQgYWxlcnRTdGF0dXMgPSAnb2snOwoJaWYgKGF2ZXJhZ2VDcHVMb2FkID4gcnVsZUNvbmZpZy52V2FybmluZ1BlcmNlbnRUaHJlc2hvbGQpIHsKCQlhbGVydFN0YXR1cyA9ICd3YXJuaW5nJzsKCX0KCWlmIChhdmVyYWdlQ3B1TG9hZCA+IHJ1bGVDb25maWcudkVycm9yUGVyY2VudFRocmVzaG9sZCkgewoJCWFsZXJ0U3RhdHVzID0gJ2Vycm9yJzsKCX0KCWFsZXJ0Q29udGV4dEFycmF5LnB1c2goe2FsZXJ0Q29udGV4dEtleTogYWxlcnRDb250ZXh0S2V5LCBhbGVydENvbnRleHREZXNjcmlwdGlvbjogYWxlcnRDb250ZXh0RGVzY3JpcHRpb24sIGFsZXJ0TWVzc2FnZTogYWxlcnRNZXNzYWdlLCBhbGVydFN0YXR1czogYWxlcnRTdGF0dXN9KTsKCgkvLyByZXR1cm4gcnVsZSByZXN1bHQKCWNvbnN0IHJ1bGVSZXN1bHQgPSB7CgkJYWxlcnRDb250ZXh0QXJyYXk6IGFsZXJ0Q29udGV4dEFycmF5Cgl9OwoJcmV0dXJuIHJ1bGVSZXN1bHQ7Cn0K",
"javaScriptCodeMD5": "ed567ceba107d49369b777e6befc522c",
"ruleExecutionTimeoutMillis": 10000
},
{
"ruleId": 12,
"lastModifiedTimestamp": 1726952369808,
"ruleTitle": "Execute HTTP GET",
"configurationInputFieldsArray": [
{
"label": "URL",
"variableName": "vConfigRuleURL",
"dataType": "string",
"defaultValue": "https://www.realload.com/",
"currentValue": ""
}
],
"javaScriptLibrariesArray": [],
"javaScriptFunctionName": "executeURL",
"javaScriptFunctionParametersArray": [],
"javaScriptCodeB64": "LyogTW9uaXRvcmluZyBSdWxlLgogKiBEZXNjcmlwdGlvbjogRXhlY3V0ZSBhIHNpbXBsZSBIVFRQIEdFVAogKi8KZnVuY3Rpb24gZXhlY3V0ZVVSTChydWxlQ29uZmlnLCBydWxlQ29udGV4dCkgewogICAgLy8gZ2V0IHRoZSBVUkwgZnJvbSB0aGUgbW9uaXRvcmluZyBydWxlIGNvbmZpZ3VyYXRpb24gaW5wdXQgZmllbGRzCiAgICBjb25zdCB1cmwgPSBydWxlQ29uZmlnLnZDb25maWdSdWxlVVJMOwogICAgY29uc29sZS5sb2coYENhbGxpbmcgVVJMIEdFVCAke3VybH1gKQogICAgCiAgICAvLyBleGVjdXRlIHRoZSBIVFRQIEdFVAogICAgY29uc3QgaHR0cENsaWVudCA9IEhUVFBDbGllbnQubmV3SW5zdGFuY2UoKTsgLy8gY3JlYXRlIGEgbmV3IEhUVFBDbGllbnQgaW5zdGFuY2Ugd2l0aCBhIGRlZmF1bHQgcHJvY2Vzc2luZyB0aW1lb3V0IG9mIDMwIHNlY29uZHMgCiAgICBjb25zdCBodHRwUmVxdWVzdCA9IGh0dHBDbGllbnQubmV3UmVxdWVzdCgnR0VUJywgdXJsKTsKICAgIGNvbnN0IGh0dHBSZXNwb25zZSA9IGh0dHBDbGllbnQuc2VuZFN5bmNSZXF1ZXN0KGh0dHBSZXF1ZXN0KTsgLy8gZXhlY3V0ZSB0aGUgSFRUUCByZXF1ZXN0CiAgICAvLyBwcm9jZXNzIHRoZSBIVFRQIHJlc3BvbnNlCglpZiAoaHR0cFJlcXVlc3QuaGFzRXJyb3JFeGNlcHRpb24oKSA9PT0gdHJ1ZSkgewoJICAgIGNvbnNvbGUubG9nKCdIVFRQIHJlcXVlc3QgZmFpbGVkOiAnICsgaHR0cFJlcXVlc3QuZ2V0RXJyb3JFeGNlcHRpb24oKSk7Cgl9IGVsc2UgewoJICAgIC8vIGNvbnN0IGJpbmFyeVJlc3BvbnNlQ29udGVudCA9IGh0dHBSZXNwb25zZS5nZXRIdHRwUmVzcG9uc2VDb250ZW50KCkuZ2V0Q29udGVudCgpOyAvLyBnZXQgdGhlIGJpbmFyeSByZXNwb25zZSBjb250ZW50CgkgICAgY29uc29sZS5sb2coYEhUVFAgc3RhdHVzIGNvZGUgPSAke2h0dHBSZXNwb25zZS5nZXRIdHRwU3RhdHVzQ29kZSgpfWApOwoJICAgIGNvbnNvbGUubG9nKGBIVFRQIHBlcmZvcm1hbmNlIGRhdGEgPSAke0pTT04uc3RyaW5naWZ5KGh0dHBSZXNwb25zZS5nZXRIdHRwUGVyZm9ybWFuY2VEYXRhKCkudG9Kc29uT2JqZWN0KCkpfWApCgkgICAgLy8gY29uc29sZS5sb2coYEhUVFAgcmVzcG9uc2UgY29udGVudCA9ICR7aHR0cFJlc3BvbnNlLmdldEh0dHBSZXNwb25zZUNvbnRlbnQoKS5nZXRDb250ZW50QXNTdHJpbmcoKX1gKTsKCX0KfQo=",
"javaScriptCodeMD5": "aaca1e4ad121702c4fb120c5b1e9e2d0",
"ruleExecutionTimeoutMillis": 60000
},
{
"ruleId": 4,
"lastModifiedTimestamp": 1728081058402,
"ruleTitle": "File Systems Full",
"configurationInputFieldsArray": [
{
"label": "File System Full% Warning",
"variableName": "vPercentWarning",
"dataType": "number",
"defaultValue": "80",
"currentValue": ""
},
{
"label": "Full System Full% Error",
"variableName": "vPercentError",
"dataType": "number",
"defaultValue": "90",
"currentValue": ""
}
],
"javaScriptLibrariesArray": [],
"javaScriptFunctionName": "checkFileSystemsFull",
"javaScriptFunctionParametersArray": [
{
"oshiParameterType": "FileSystemsSnapshot"
}
],
"javaScriptCodeB64": "LyogTW9uaXRvcmluZyBSdWxlLgogKiBEZXNjcmlwdGlvbjogQ2hlY2sgaWYgZmlsZSBzeXN0ZW1zIGFyZSBmdWxsLgogKi8KZnVuY3Rpb24gY2hlY2tGaWxlU3lzdGVtc0Z1bGwocnVsZUNvbmZpZywgcnVsZUNvbnRleHQsIGZpbGVTeXN0ZW1zU25hcHNob3QpIHsKCS8vIE5vdGU6IGNvbW1lbnQgb3V0IHRoZSBmb2xsb3dpbmcgY29uc29sZS5sb2cgZW50cmllcyBhZnRlciB0aGUgcnVsZSBoYXMgYmVlbiBzdWNjZXNzZnVsbHkgdGVzdGVkCgkvLyBjb25zb2xlLmxvZyhgcnVsZUNvbmZpZyA9ICR7SlNPTi5zdHJpbmdpZnkocnVsZUNvbmZpZyl9YCk7CgkvLyBjb25zb2xlLmxvZyhgcnVsZUNvbnRleHQgPSAke0pTT04uc3RyaW5naWZ5KHJ1bGVDb250ZXh0KX1gKTsKCS8vIGNvbnNvbGUubG9nKGBmaWxlU3lzdGVtc1NuYXBzaG90ID0gJHtKU09OLnN0cmluZ2lmeShmaWxlU3lzdGVtc1NuYXBzaG90KX1gKTsKCQoJY29uc3Qgc3lzdGVtRGVzY3JpcHRpb24gPSBydWxlQ29udGV4dC5vc2hpU3lzdGVtLnN5c3RlbURlc2NyaXB0aW9uOwoJY29uc3Qgb3NoaURhZW1vblVuaXF1ZUlkID0gcnVsZUNvbnRleHQub3NoaVN5c3RlbS5vc2hpRGFlbW9uVW5pcXVlSWQ7CgogICAgY29uc3QgYWxlcnRDb250ZXh0QXJyYXkgPSBbXTsKCWZpbGVTeXN0ZW1zU25hcHNob3QuZmlsZVN0b3Jlc0FycmF5LmZvckVhY2goZmlsZVN0b3JlID0+IHsKCSAgICBjb25zdCBtb3VudFBvaW50ID0gZmlsZVN0b3JlLm1vdW50UG9pbnQ7CgkgICAgY29uc3QgdXNlZFNwYWNlUGVyY2VudCA9IDEwMCAtIGZpbGVTdG9yZS5mcmVlU3BhY2VQZXJjZW50OwoJICAgIAoJICAgIGNvbnN0IGFsZXJ0Q29udGV4dEtleSA9IG9zaGlEYWVtb25VbmlxdWVJZCArICd8JyArIG1vdW50UG9pbnQ7CgkgICAgY29uc3QgYWxlcnRDb250ZXh0RGVzY3JpcHRpb24gPSBgQ2hlY2sgaWYgJyR7c3lzdGVtRGVzY3JpcHRpb259JyBmaWxlIHN5c3RlbSAnJHttb3VudFBvaW50fScgaXMgZnVsbGA7CgkgICAgY29uc3QgYWxlcnRNZXNzYWdlID0gYCR7c3lzdGVtRGVzY3JpcHRpb259OiB0aGUgZmlsZSBzeXN0ZW0gJyR7bW91bnRQb2ludH0nIGlzICR7TWF0aC5yb3VuZCh1c2VkU3BhY2VQZXJjZW50ICogMTApIC8gMTB9JSBmdWxsYDsKCSAgICBsZXQgYWxlcnRTdGF0dXMgPSAnb2snOwoJICAgIGlmICh1c2VkU3BhY2VQZXJjZW50ID4gcnVsZUNvbmZpZy52UGVyY2VudFdhcm5pbmcpIHsKCSAgICAgICAgYWxlcnRTdGF0dXMgPSAnd2FybmluZyc7CgkgICAgfQoJICAgIGlmICh1c2VkU3BhY2VQZXJjZW50ID4gcnVsZUNvbmZpZy52UGVyY2VudEVycm9yKSB7CgkgICAgICAgIGFsZXJ0U3RhdHVzID0gJ2Vycm9yJzsKCSAgICB9CiAgICAgICAgYWxlcnRDb250ZXh0QXJyYXkucHVzaCh7YWxlcnRDb250ZXh0S2V5OiBhbGVydENvbnRleHRLZXksIGFsZXJ0Q29udGV4dERlc2NyaXB0aW9uOiBhbGVydENvbnRleHREZXNjcmlwdGlvbiwgYWxlcnRNZXNzYWdlOiBhbGVydE1lc3NhZ2UsIGFsZXJ0U3RhdHVzOiBhbGVydFN0YXR1c30pOwkgICAgCgl9KTsKCWNvbnN0IHJ1bGVSZXN1bHQgPSB7CgkJYWxlcnRDb250ZXh0QXJyYXk6IGFsZXJ0Q29udGV4dEFycmF5Cgl9OwoJLy8gY29uc29sZS5sb2coYHJ1bGVSZXN1bHQgPSAke0pTT04uc3RyaW5naWZ5KHJ1bGVSZXN1bHQpfWApOwoJcmV0dXJuIHJ1bGVSZXN1bHQ7Cn0K",
"javaScriptCodeMD5": "1773314714f298f2c059825f2add21c4",
"ruleExecutionTimeoutMillis": 15000
},
{
"ruleId": 25,
"lastModifiedTimestamp": 1727976959366,
"ruleTitle": "Start Linux OS Process",
"configurationInputFieldsArray": [],
"javaScriptLibrariesArray": [],
"javaScriptFunctionName": "startOsProcess",
"javaScriptFunctionParametersArray": [],
"javaScriptCodeB64": "LyogTW9uaXRvcmluZyBSdWxlLgogKiBEZXNjcmlwdGlvbjogLi4gYWRkIGRlc2NyaXB0aW9uIGhlcmUgLi4KICovCmZ1bmN0aW9uIHN0YXJ0T3NQcm9jZXNzKHJ1bGVDb25maWcsIHJ1bGVDb250ZXh0KSB7CgkvLyBOb3RlOiBjb21tZW50IG91dCB0aGUgZm9sbG93aW5nIGNvbnNvbGUubG9nIGVudHJpZXMgYWZ0ZXIgdGhlIHJ1bGUgaGFzIGJlZW4gc3VjY2Vzc2Z1bGx5IHRlc3RlZAoJLy8gY29uc29sZS5sb2coYHJ1bGVDb25maWcgPSAke0pTT04uc3RyaW5naWZ5KHJ1bGVDb25maWcpfWApOwoJLy8gY29uc29sZS5sb2coYHJ1bGVDb250ZXh0ID0gJHtKU09OLnN0cmluZ2lmeShydWxlQ29udGV4dCl9YCk7CgkKCWNvbnN0IHN5c3RlbURlc2NyaXB0aW9uID0gcnVsZUNvbnRleHQub3NoaVN5c3RlbS5zeXN0ZW1EZXNjcmlwdGlvbjsKCWNvbnN0IG9zaGlEYWVtb25VbmlxdWVJZCA9IHJ1bGVDb250ZXh0Lm9zaGlTeXN0ZW0ub3NoaURhZW1vblVuaXF1ZUlkOwoJCgljb25zdCBhbGVydENvbnRleHRBcnJheSA9IFtdOwoJCgkvLyBjb25zdCBvc1Byb2Nlc3MgPSBPc1Byb2Nlc3MubmV3SW5zdGFuY2UoWydiYXNoJywgJy1jJywgJ2xzIC1hbCddKTsKCWNvbnN0IG9zUHJvY2VzcyA9IE9zUHJvY2Vzcy5uZXdJbnN0YW5jZShbJ2Jhc2gnLCAnLWMnLCAnZW52J10pOwoJLy8gb3NQcm9jZXNzLnNldERhZW1vbih0cnVlKTsKCW9zUHJvY2Vzcy5zZXRlbnYoJ015TmFtZScsICdEYXZpZCcpOwoJb3NQcm9jZXNzLnVuc2V0ZW52KCdMU19DT0xPUlMnKTsKCW9zUHJvY2Vzcy5zdGFydCgpOwoJb3NQcm9jZXNzLndhaXRGb3IoKTsKCQoJLy8gcmV0dXJuIHJ1bGUgcmVzdWx0Cgljb25zdCBydWxlUmVzdWx0ID0gewoJCWFsZXJ0Q29udGV4dEFycmF5OiBhbGVydENvbnRleHRBcnJheQoJfTsKCS8vIGNvbnNvbGUubG9nKGBydWxlUmVzdWx0ID0gJHtKU09OLnN0cmluZ2lmeShydWxlUmVzdWx0KX1gKTsKCXJldHVybiBydWxlUmVzdWx0Owp9Cg==",
"javaScriptCodeMD5": "a71a0ff6bf27e0977be5ac5e09e82f77",
"ruleExecutionTimeoutMillis": 10000
}
],
"isError": false
}
Specific Request Fields:
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"getOshiMonitoringGroups"
}
JSON Response Example (Success Case):
{
"oshiMonitoringGroupsArray": [
{
"monitoringGroupId": 9,
"lastModifiedTimestamp": 1734815386476,
"monitoringGroupTitle": "My First Group",
"monitoringGroupDescription": "nixda",
"executionIntervalSeconds": 60,
"groupExecutionEnabled": true,
"assignedOshiSystemsArray": [
{
"assignedOshiSystemId": 19,
"oshiSystemInGroupEnabled": true
},
{
"assignedOshiSystemId": 20,
"oshiSystemInGroupEnabled": true
}
],
"assignedRulesArray": [
{
"assignerId": 21,
"assignedRuleId": 4,
"executionEnabled": true,
"executionTarget": "onAlertProcessor",
"configurationInputFieldsArray": [
{
"label": "File System Full% Warning",
"variableName": "vPercentWarning",
"dataType": "number",
"defaultValue": "80",
"currentValue": "1"
},
{
"label": "Full System Full% Error",
"variableName": "vPercentError",
"dataType": "number",
"defaultValue": "90",
"currentValue": "3"
}
],
"assignedAlertGroupsArray": []
},
{
"assignerId": 22,
"assignedRuleId": 27,
"executionEnabled": true,
"executionTarget": "onAlertProcessor",
"configurationInputFieldsArray": [
{
"label": "Last Minutes",
"variableName": "vLastMinutes",
"dataType": "number",
"defaultValue": "3",
"currentValue": "3"
},
{
"label": "Warning Percent Threshold",
"variableName": "vWarningPercentThreshold",
"dataType": "number",
"defaultValue": "80",
"currentValue": "80"
},
{
"label": "Error Percent Threshold",
"variableName": "vErrorPercentThreshold",
"dataType": "number",
"defaultValue": "95",
"currentValue": "95"
}
],
"assignedAlertGroupsArray": []
}
],
"assignedAlertGroupsArray": [
{
"assignedAlertGroupId": 1,
"alertGroupInMonitoringGroupEnabled": true
}
]
}
],
"isError": false
}
Specific Request Fields:
The data of all Specific Request Fields will be updated/modified (except monitoringGroupId).
Response Fields:
Specific Error Flags:
JSON Request Example:
{
"authTokenValue":"jPmFClqeDUXaEk8Q274q",
"action":"modifyOshiMonitoringGroup",
"monitoringGroupId":9,
"monitoringGroupTitle":"My First Group",
"monitoringGroupDescription":"My Description",
"executionIntervalSeconds":120,
"groupExecutionEnabled":true,
"assignedOshiSystemsArray":[
{
"assignedOshiSystemId": 19,
"oshiSystemInGroupEnabled": true
},
{
"assignedOshiSystemId": 20,
"oshiSystemInGroupEnabled": true
}
]
}
JSON Response Example (Success Case):
{
"isError": false
}
The “Remote User Monitoring API” is a WebSocket API that supports developers to implement their own version of a Synthetic Monitoring “Real Time Dashboard”.
Similar to the Remote User API there is also an “API Authentication Token” required to access the API.
The API supports the following functions (so-called “actions”):
| WebSocket URL |
|---|
| wss://portal.realload.com/RemoteUserMonitoringAPI |
| HTTP Request Header Fields | |
|---|---|
| x-api-key: <API Authentication Token> | required |
| subscribeToHeartbeat: true | optional |
| subscribeToRealtimeMonitor: true | optional |
The subscribed data are received in JSON format. The received JSON values are never null.
Runtime Behavior
Example:
Send: {"action":"subscribeToHeartbeat"}
Received: {"action":"subscribeToHeartbeat","isError":false}
Received: {"action":"heartbeat","timestamp":1708466543962,"isError":false}
Received: {"action":"heartbeat","timestamp":1708466544963,"isError":false}
Received: {"action":"heartbeat","timestamp":1708466545963,"isError":false}
Implementation Recommendations
Example:
Send: {"action":"pingPortalServer"}
Received: {"action":"pongFromPortalServer","portalServerVersion":"4.8.35","portalServerTimestamp":1708468300516,"isError":false}
{
"action":"subscribeToHeartbeat"
}
{
"action":"heartbeat",
"timestamp":1677521478771,
"isError":false
}
{
"action":"subscribeToPeriodicAliveThread",
"periodicIntervalSeconds":60
}
{
"action":"periodicAlive",
"timestamp":1708469366167,
"isError":false
}
{
"action":"subscribeToRealtimeMonitor"
}
As first you will receive instantly the configuration data of all already defined Monitoring Groups and Monitoring Jobs, and also the data of the last Execution Result of the Monitoring Groups and Monitoring Jobs (if they have been executed in the past).
After that you will receive update information of all Monitoring Groups and Monitoring Jobs when they are new-defined/modified/deleted, and you will receive also update information about the result of executed Monitoring Groups and Monitoring Jobs.
Because monitoring groups and jobs can be temporarily disabled by configuring one or multiple “Monitoring Downtime(s)” you receive the actions “onMonitoringGroupTemporarilyEvent” and “onMonitoringJobTemporarilyEvent”.
{
"action": "onMonitoringGroupEvent",
"monitoringGroupId": 34,
"monitoringEvent": {
"eventTimestamp": 1708541771774,
"monitoringGroup": {
"monitoringGroupId": 34,
"ownerUserId": 13,
"title": "First Group",
"description": "",
"maxDataStorageDays": 14,
"agentType": "agent",
"executionEnabled": true,
"executionInterval": 300,
"executionTimeout": 300,
"currentExecutionState": "executing",
"lastExecutionStartTime": 1708541763897
},
"monitoringGroupAction": "groupExists"
},
"isError": false
}
The executionInterval and the executionTimeout are in seconds. The lastExecutionStartTime has a value of -1 (minus one) if the Monitoring Group was never executed. The agentType has currently no meaning.
Any modification of a Monitoring Group made by the Portal Server Web Interface such as modify executionEnabled or title effects that a new frame with monitoringGroupAction = “groupModified” is received.
{
"action": "onMonitoringJobEvent",
"monitoringGroupId": 36,
"monitoringJobId": 79,
"monitoringEvent": {
"eventTimestamp": 1708541771790,
"monitoringJobProperties": {
"performanceErrorAlertThresholdMillis": "-1",
"enableJobExecution": "true",
"performanceWarningAlertsEnabled": "false",
"testjobConcurrentUsers": "1",
"testjobDelayPerLoop": "1000",
"testjobDebugMeasuring": "false",
"performanceErrorAlertsEnabled": "false",
"enableAutomaticFileSync": "false",
"performanceWarningAlertThresholdMillis": "-1",
"testjobMaxTestDuration": "60",
"testjobDebugExecution": "false",
"testjobRampUpTime": "5",
"definedFromMonitoringGroupId": "36",
"testjobMaxLoopsPerUser": "1",
"productVersion": "4.8.35",
"monitoringJobId": "79",
"monitoringJobTitle": "Local_Cinema",
"lastExecutionStartTime": "1708541731138",
"testjobAdditionalArguments": "",
"definedFromTestId": "399",
"testjobUserInputFieldsValuesJsonArray": "[]",
"monitoringJobDescription": ""
},
"monitoringTestProperties": {
"referencedResourceFilesList": [
{
"projectId": 130,
"testplanId": 203,
"fileName": "com.dkfqs.tools.jar"
}
],
"jsonConfigObject": {},
"executingScript": "Local_Cinema.jar",
"executingScriptResourceFileList": "",
"createTimeStamp": "1708293851731",
"testDescription": "",
"definedFromTestplanId": "287",
"productVersion": "4.8.34",
"definedFromProjectId": "137",
"visibleTestName": "Local_Cinema",
"scriptType": "OpenJDK11Jar",
"testId": "399"
},
"monitoringTestIsHealthy": true,
"monitoringJobAction": "jobExists"
},
"isError": false
}
The testjobMaxTestDuration and the testjobRampUpTime are in seconds. The testjobDelayPerLoop are in milliseconds. The lastExecutionStartTime has a value of -1 (minus one) if the Monitoring Job was never executed.
Any modification of a Monitoring Job made by the Portal Server Web Interface such as modify enableJobExecution or monitoringJobTitle effects that a new frame with monitoringJobAction = “jobModified” is received.
{
"action": "onMonitoringGroupExecuted",
"monitoringGroupId": 34,
"monitoringEvent": {
"eventTimestamp": 1708541771806,
"oldEvent": true,
"groupExecutionResult": {
"magicPattern": "MonitoringGroupExecutionResult",
"productVersion": "4.8.35",
"userId": 13,
"monitoringGroupId": 34,
"groupExecutionId": 39412,
"resultTimestamp": 1708541492973,
"monitoringJobIdToLocalTestjobIdArray": [
{
"monitoringJobId": 60,
"localTestjobId": 73932
},
{
"monitoringJobId": 61,
"localTestjobId": 73934
},
{
"monitoringJobId": 62,
"localTestjobId": 73933
}
],
"groupSystemStatus": 0,
"groupCombinedTestjobState": "completed",
"groupExecutionLogArray": [
"2024-02-21 19:51:03.915 | | INFO | Monitoring Group Execution Thread started",
"2024-02-21 19:51:32.972 | | INFO | Monitoring Job Id 60 executed",
"2024-02-21 19:51:32.972 | | INFO | Monitoring Job Id 62 executed",
"2024-02-21 19:51:32.972 | | INFO | Monitoring Job Id 61 executed",
"2024-02-21 19:51:32.973 | | INFO | Monitoring Group Execution Thread terminated"
],
"numberOfPassedSamples": 10,
"numberOfFailedSamples": 0,
"numberOfPassedLoops": 6,
"numberOfFailedLoops": 0,
"sumErrorsSeverityWarning": 0,
"sumErrorsSeverityError": 0,
"sumErrorsSeverityFatal": 0
}
},
"hasGroupExecutionStatistic": true,
"groupExecutionStatistic": {
"userId": 13,
"monitoringGroupId": 34,
"fromTimestamp": 1708455371812,
"toTimestamp": 1708541771812,
"systemAvailabilityPercent": 100,
"measuredAvailabilityPercent": 100,
"measuredFaultyTimeSumSeconds": 0
},
"isError": false
}
groupSystemStatus:
groupCombinedTestjobState
Hint for groupCombinedTestjobState : Note that is value does not reflect if any warnings or errors have been measured by the test jobs.
The Reference Implementation on the Real Load Portal Server shows the measured (sumErrorsSeverityError + sumErrorsSeverityFatal) simple as “number of measured errors”.
{
"action": "onMonitoringJobExecuted",
"monitoringGroupId": 36,
"monitoringJobId": 79,
"monitoringEvent": {
"eventTimestamp": 1708541771849,
"oldEvent": true,
"jobExecutionResult": {
"magicPattern": "MonitoringJobExecutionResult",
"productVersion": "4.8.35",
"userId": 13,
"monitoringGroupId": 36,
"groupExecutionId": 39417,
"monitoringJobId": 79,
"localTestjobId": 73939,
"resultTimestamp": 1708541748100,
"systemStatus": 0,
"jobExecutionLogArray": [
"2024-02-21 19:55:31.137 | | INFO | Monitoring Job Execution Thread started",
"2024-02-21 19:55:31.495 | Shared Agent 1 | INFO | Job submitted to measuring agent, remote testjob id = 19015",
"2024-02-21 19:55:38.034 | Shared Agent 1 | INFO | Job executed on measuring agent, exit code = process executed successfully",
"2024-02-21 19:55:40.014 | Shared Agent 2 | INFO | Job submitted to measuring agent, remote testjob id = 4864",
"2024-02-21 19:55:46.446 | Shared Agent 2 | INFO | Job executed on measuring agent, exit code = process executed successfully",
"2024-02-21 19:55:48.100 | | INFO | Monitoring Job Execution Thread terminated"
],
"combinedTestjobState": "completed",
"hasCombinedTestResult": true,
"combinedTestResultFileName": "TestResult_MonitoringJob_79_2024-02-21@19-55-48.json",
"combinedTestResultSummaryStatistic": {
"productVersion": "4.8.35",
"localTestjobId": 73939,
"remoteTestjobId": 39417,
"samplingGranularity": 4000,
"jobStartTimestamp": 1708541736385,
"jobEndTimestamp": 1708541744994,
"osCpuLoadPercent": -1,
"numberOfPassedLoopsTimeSum": 178,
"numberOfConcurrentUsers": 0,
"currentlyPendingSamples": 0,
"numberOfPassedSamples": 2,
"numberOfFailedSamples": 0,
"numberOfPassedLoops": 2,
"numberOfFailedLoops": 0,
"numberOfMeasuredErrors": 0,
"numErrorsSeverityWarning": 0,
"numErrorsSeverityError": 0,
"numErrorsSeverityFatal": 0
},
"averagePassedLoopTime": 89,
"sumErrorsSeverityWarning": 0,
"sumErrorsSeverityError": 0,
"sumErrorsSeverityFatal": 0
}
},
"hasJobExecutionStatistic": true,
"jobExecutionStatistic": {
"userId": 13,
"monitoringGroupId": 36,
"monitoringJobId": 79,
"fromTimestamp": 1708455371849,
"toTimestamp": 1708541771849,
"systemAvailabilityPercent": 100,
"measuredAvailabilityPercent": 100,
"measuredFaultyTimeSumSeconds": 0,
"averagePassedLoopTime": 93,
"hasPassedLoopTimePercentileArray": false
},
"isError": false
}
systemStatus:
combinedTestjobState
Hint for combinedTestjobState : Note that is value does not reflect if any warnings or errors have been measured by the test jobs.
The Reference Implementation of the Monitoring Dashboard on the RealLoad Portal Server shows the measured (sumErrorsSeverityError + sumErrorsSeverityFatal) simple as “number of measured errors”.
{
"action": "onMonitoringGroupTemporarilyEvent",
"monitoringGroupId": 34,
"monitoringEvent": {
"eventTimestamp": 1708541771851,
"monitoringGroup": {
"monitoringGroupId": 34,
"ownerUserId": 13,
"title": "First Group",
"description": "",
"maxDataStorageDays": 14,
"agentType": "agent",
"executionEnabled": true,
"executionInterval": 300,
"executionTimeout": 300,
"currentExecutionState": "executing",
"lastExecutionStartTime": 1708541763897
},
"monitoringGroupTemporarilyAction": "groupExecutionTemporarilyNotDisabled"
},
"isError": false
}
{
"action": "onMonitoringJobTemporarilyEvent",
"monitoringGroupId": 36,
"monitoringJobId": 79,
"monitoringEvent": {
"eventTimestamp": 1708541771854,
"monitoringJobProperties": {
"performanceErrorAlertThresholdMillis": "-1",
"enableJobExecution": "true",
"performanceWarningAlertsEnabled": "false",
"testjobConcurrentUsers": "1",
"testjobDelayPerLoop": "1000",
"testjobDebugMeasuring": "false",
"performanceErrorAlertsEnabled": "false",
"enableAutomaticFileSync": "false",
"performanceWarningAlertThresholdMillis": "-1",
"testjobMaxTestDuration": "60",
"testjobDebugExecution": "false",
"testjobRampUpTime": "5",
"definedFromMonitoringGroupId": "36",
"testjobMaxLoopsPerUser": "1",
"productVersion": "4.8.35",
"monitoringJobId": "79",
"monitoringJobTitle": "Local_Cinema",
"lastExecutionStartTime": "1708541731138",
"testjobAdditionalArguments": "",
"definedFromTestId": "399",
"testjobUserInputFieldsValuesJsonArray": "[]",
"monitoringJobDescription": ""
},
"monitoringJobTemporarilyAction": "jobExecutionTemporarilyNotDisabled"
},
"isError": false
}
{
"action":"subscribeToMonitoringAlerts"
}
{
"action": "onMonitoringAlert",
"monitoringEvent": {
"eventTimestamp": 1708547148410,
"monitoringAlert": {
"userId": 13,
"alertLevel": "Monitoring Group",
"alertType": "New Alert",
"alertId": 579,
"alertContext": {
"alertIdUpdateCounter": 0,
"currentSystemStatus": "Healthy",
"currentExecutionState": "Successful",
"currentNumMeasuredWarnings": 0,
"currentNumMeasuredErrors": 2,
"previousSystemStatus": "Healthy",
"previousExecutionState": "Successful",
"previousNumMeasuredWarnings": 0,
"previousNumMeasuredErrors": 0
},
"monitoringGroupId": 36,
"monitoringGroupExecutionResult": {
"magicPattern": "MonitoringGroupExecutionResult",
"productVersion": "4.8.35",
"userId": 13,
"monitoringGroupId": 36,
"groupExecutionId": 39525,
"resultTimestamp": 1708547148390,
"monitoringJobIdToLocalTestjobIdArray": [
{
"monitoringJobId": 79,
"localTestjobId": 74083
}
],
"groupSystemStatus": 0,
"groupCombinedTestjobState": "completed",
"groupExecutionLogArray": [
"2024-02-21 21:25:31.365 | | INFO | Monitoring Group Execution Thread started",
"2024-02-21 21:25:48.383 | | INFO | Monitoring Job Id 79 executed",
"2024-02-21 21:25:48.390 | | INFO | Monitoring Group Execution Thread terminated"
],
"numberOfPassedSamples": 0,
"numberOfFailedSamples": 2,
"numberOfPassedLoops": 0,
"numberOfFailedLoops": 2,
"sumErrorsSeverityWarning": 0,
"sumErrorsSeverityError": 2,
"sumErrorsSeverityFatal": 0
}
}
},
"isError": false
}
{
"action": "subscribeToGroupExecutionHistoryCache",
"monitoringGroupId": 36
}
Error Case
{
"action": "subscribeToGroupExecutionHistoryCache",
"isError": true,
"genericErrorText": "subscribeToGroupExecutionHistoryCache failed: java.lang.IllegalArgumentException: Invalid monitoringGroupId : 35"
}
Received actions:
{
"action": "onMonitoringGroupExecutionHistoryInitialEntries",
"monitoringGroupId": 36,
"monitoringEvent": {
"eventTimestamp": 1708548777246,
"historyEntriesArray": [
{
"t": 1708463444623,
"ge": 60,
"ss": 0,
"ct": "completed",
"w": 0,
"e": 0,
"f": 0,
"gid": 37851
},
{
"t": 1708463504557,
"ge": 60,
"ss": 0,
"ct": "completed",
"w": 0,
"e": 0,
"f": 0,
"gid": 37853
},
{
"t": 1708463563635,
"ge": 60,
"ss": 0,
"ct": "completed",
"w": 0,
"e": 0,
"f": 0,
"gid": 37854
},
{
"t": 1708548588515,
"ge": 60,
"ss": 0,
"ct": "completed",
"w": 0,
"e": 2,
"f": 0,
"gid": 39554
},
{
"t": 1708548648466,
"ge": 60,
"ss": 0,
"ct": "completed",
"w": 0,
"e": 2,
"f": 0,
"gid": 39555
},
{
"t": 1708548708464,
"ge": 60,
"ss": 0,
"ct": "completed",
"w": 0,
"e": 2,
"f": 0,
"gid": 39557
},
{
"t": 1708548768449,
"ge": 60,
"ss": 0,
"ct": "completed",
"w": 0,
"e": 2,
"f": 0,
"gid": 39558
}
]
},
"isError": false
}
{
"action": "onMonitoringGroupExecutionHistoryNewEntry",
"monitoringGroupId": 36,
"monitoringEvent": {
"eventTimestamp": 1708549188525,
"historyEntry": {
"t": 1708549188468,
"ge": 60,
"ss": 0,
"ct": "completed",
"w": 0,
"e": 2,
"f": 0,
"gid": 39566
}
},
"isError": false
}
{
"action": "subscribeToJobExecutionHistoryCache",
"monitoringJobId": 79
}
Error Case
{
"action": "subscribeToJobExecutionHistoryCache",
"isError": true,
"genericErrorText": "subscribeToJobExecutionHistoryCache failed: java.lang.IllegalArgumentException: Invalid monitoringJobId : 80"
}
Received actions:
{
"action": "onMonitoringJobExecutionHistoryInitialEntries",
"monitoringGroupId": 36,
"monitoringJobId": 79,
"monitoringEvent": {
"eventTimestamp": 1708551216713,
"historyEntriesArray": [
{
"t": 1708464823243,
"ge": 60,
"ss": 0,
"ct": "completed",
"al": 118,
"w": 0,
"e": 0,
"f": 0,
"lid": 71889,
"h": true
},
{
"t": 1708464882694,
"ge": 60,
"ss": 0,
"ct": "completed",
"al": 107,
"w": 0,
"e": 0,
"f": 0,
"lid": 71890,
"h": true
},
{
"t": 1708464943399,
"ge": 60,
"ss": 0,
"ct": "completed",
"al": 96,
"w": 0,
"e": 0,
"f": 0,
"lid": 71891,
"h": true
},
{
"t": 1708550987656,
"ge": 60,
"ss": 0,
"ct": "completed",
"al": -1,
"w": 0,
"e": 2,
"f": 0,
"lid": 74186,
"h": true
},
{
"t": 1708551047722,
"ge": 60,
"ss": 0,
"ct": "completed",
"al": -1,
"w": 0,
"e": 2,
"f": 0,
"lid": 74187,
"h": true
},
{
"t": 1708551108599,
"ge": 60,
"ss": 0,
"ct": "completed",
"al": -1,
"w": 0,
"e": 2,
"f": 0,
"lid": 74191,
"h": true
},
{
"t": 1708551167586,
"ge": 60,
"ss": 0,
"ct": "completed",
"al": -1,
"w": 0,
"e": 2,
"f": 0,
"lid": 74192,
"h": true
}
]
},
"isError": false
}
{
"action": "onMonitoringJobExecutionHistoryNewEntry",
"monitoringGroupId": 36,
"monitoringJobId": 79,
"monitoringEvent": {
"eventTimestamp": 1708551228189,
"historyEntry": {
"t": 1708551228183,
"ge": 60,
"ss": 0,
"ct": "completed",
"al": -1,
"w": 0,
"e": 2,
"f": 0,
"lid": 74193,
"h": true
}
},
"isError": false
}
You will also receive other actions than previously described above. These are confirmations that you can ignore. Example:
{
"action":"subscribeToRealtimeMonitor",
"isError":false
}