/neoload-web-java-client

Java client for NeoLoad web rest API.

Primary LanguageJava

swagger-java-client

NeoLoad API

  • API version: 3.0
    • Build date: 2021-04-16T09:41:51.665+02:00[Europe/Paris]

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

Automatically generated by the Swagger Codegen

Requirements

Building the API client library requires:

  1. Java 1.7+
  2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>io.swagger</groupId>
  <artifactId>swagger-java-client</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.swagger:swagger-java-client:1.0.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/swagger-java-client-1.0.0.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdministrationOfUsersApi;

import java.io.File;
import java.util.*;

public class AdministrationOfUsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: NeoloadAuthorizer
        ApiKeyAuth NeoloadAuthorizer = (ApiKeyAuth) defaultClient.getAuthentication("NeoloadAuthorizer");
        NeoloadAuthorizer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //NeoloadAuthorizer.setApiKeyPrefix("Token");

        AdministrationOfUsersApi apiInstance = new AdministrationOfUsersApi();
        String login = "login_example"; // String | 
        Boolean removeFromNeotysSaaSAccount = false; // Boolean | SaaS Account-Admin-only option: Remove the user from your Account on the Neotys user platform
        try {
            apiInstance.delete1(login, removeFromNeotysSaaSAccount);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdministrationOfUsersApi#delete1");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to /

Class Method HTTP request Description
AdministrationOfUsersApi delete1 DELETE /v3/users/{login} Delete a user
InformationApi getInformation GET /v3/information Lists information
ResourcesApi getReservations GET /v3/resources/reservations Lists reservations
ResourcesApi getZones GET /v3/resources/zones List all zones
ResultsApi deleteTestResult DELETE /v3/workspaces/{workspaceId}/test-results/{resultId} Deletes a test result
ResultsApi getTestRawResult GET /v3/workspaces/{workspaceId}/test-results/{resultId}/raw Test result raw data
ResultsApi getTestRawResultElement GET /v3/workspaces/{workspaceId}/test-results/{resultId}/elements/{elementId}/raw Test result raw data of a TRANSACTION element
ResultsApi getTestResult GET /v3/workspaces/{workspaceId}/test-results/{resultId} Test result description
ResultsApi getTestResultElementDefinition GET /v3/workspaces/{workspaceId}/test-results/{resultId}/elements/{elementId} Test result element definition
ResultsApi getTestResultElements GET /v3/workspaces/{workspaceId}/test-results/{resultId}/elements Test result elements
ResultsApi getTestResultElementsPercentiles GET /v3/workspaces/{workspaceId}/test-results/{resultId}/elements/{elementId}/percentiles Test result percentiles transaction since the beginning of the test result
ResultsApi getTestResultElementsPoints GET /v3/workspaces/{workspaceId}/test-results/{resultId}/elements/{elementId}/points Test results elements points since the beginning of the test result
ResultsApi getTestResultElementsSla GET /v3/workspaces/{workspaceId}/test-results/{resultId}/elements/{elementId}/sla Test result elements SLA status since the beginning of the test result
ResultsApi getTestResultElementsValues GET /v3/workspaces/{workspaceId}/test-results/{resultId}/elements/{elementId}/values Test result elements values
ResultsApi getTestResultEvents GET /v3/workspaces/{workspaceId}/test-results/{resultId}/events Test result events
ResultsApi getTestResultGraph POST /v3/workspaces/{workspaceId}/test-results/{resultId}/graph Test result Graph
ResultsApi getTestResultList GET /v3/workspaces/{workspaceId}/test-results Lists test results
ResultsApi getTestResultMonitorDefinition GET /v3/workspaces/{workspaceId}/test-results/{resultId}/monitors/{counterId} Test result counter definition
ResultsApi getTestResultMonitors GET /v3/workspaces/{workspaceId}/test-results/{resultId}/monitors Test result monitors
ResultsApi getTestResultMonitorsPoints GET /v3/workspaces/{workspaceId}/test-results/{resultId}/monitors/{counterId}/points Test result monitors points
ResultsApi getTestResultMonitorsValues GET /v3/workspaces/{workspaceId}/test-results/{resultId}/monitors/{counterId}/values Test result monitors values
ResultsApi getTestResultMultiGraph POST /v3/workspaces/{workspaceId}/test-results/graph Test results MultiGraph
ResultsApi getTestResultSLAGlobalIndicators GET /v3/workspaces/{workspaceId}/test-results/{resultId}/slas/statistics SLAs global indicators
ResultsApi getTestResultSLAPerInterval GET /v3/workspaces/{workspaceId}/test-results/{resultId}/slas/per-interval SLAs per time interval
ResultsApi getTestResultSLAPerTest GET /v3/workspaces/{workspaceId}/test-results/{resultId}/slas/per-test SLAs per test
ResultsApi getTestResultStatistics GET /v3/workspaces/{workspaceId}/test-results/{resultId}/statistics Test result main statistics
ResultsApi patchTestResultCustomEvent PATCH /v3/workspaces/{workspaceId}/test-results/{resultId}/events/{eventId} Partially update a Test Result custom event
ResultsApi postTestResultCustomEvent POST /v3/workspaces/{workspaceId}/test-results/{resultId}/events Create a Test Result custom event
ResultsApi postTestResultMonitors POST /v3/workspaces/{workspaceId}/test-results/{resultId}/monitors Create custom monitors
ResultsApi stopTestResult POST /v3/workspaces/{workspaceId}/test-results/{resultId}/stop Stop a running test result
ResultsApi updateTestResult PUT /v3/workspaces/{workspaceId}/test-results/{resultId} Update a test result
RuntimeApi deleteTest DELETE /v3/workspaces/{workspaceId}/tests/{testId} Delete a test
RuntimeApi getTest GET /v3/workspaces/{workspaceId}/tests/{testId} Get a test
RuntimeApi getTestList GET /v3/workspaces/{workspaceId}/tests Get a test list
RuntimeApi getTestsRun POST /v3/workspaces/{workspaceId}/tests/{testId}/start Starts a test
RuntimeApi patchTest PATCH /v3/workspaces/{workspaceId}/tests/{testId} Partially update a test
RuntimeApi postCreateTest POST /v3/workspaces/{workspaceId}/tests Create a new test
RuntimeApi postUploadProject POST /v3/workspaces/{workspaceId}/tests/{testId}/project Uploads a NeoLoad project zip file or a standalone as-code file
RuntimeApi putTest PUT /v3/workspaces/{workspaceId}/tests/{testId} Fully update a test
RuntimeApi readProjectMetadata GET /v3/workspaces/{workspaceId}/tests/{testId}/project Get project's metadata
WorkspacesApi addMembersToWorkspace PATCH /v3/workspaces/{workspaceId}/members/add Add member(s) to a Workspace
WorkspacesApi create POST /v3/workspaces Create a new Workspace
WorkspacesApi delete DELETE /v3/workspaces/{workspaceId}/name/{workspaceName} Delete a Workspace
WorkspacesApi find GET /v3/workspaces/{workspaceId} Get a Workspace
WorkspacesApi getWorkspaceList GET /v3/workspaces Get the list of all accessible Workspaces
WorkspacesApi removeMembersFromWorkspace PATCH /v3/workspaces/{workspaceId}/members/remove Remove member(s) from a Workspace
WorkspacesApi update PATCH /v3/workspaces/{workspaceId} Update a Workspace

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

NeoloadAuthorizer

  • Type: API key
  • API key parameter name: accountToken
  • Location: HTTP header

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author