Results API

NeoLoad makes it possible to generate and download reports on a current project from a REST API on the Controller.

License information

No specific license module is required to use the Results API service.

Available methods

Click here for a list of available methods.

Interact with the API

• Java client

• C# Client

Identify the client

By default, no identification is performed: the server accepts all client connections.

To identify a client, configure the REST APIs in the Project settings. Every client may have an identification key (the identification key is then sent with each entry; the identification applies for each call because the client/server connection is stateless).

If an unauthorized client sends a call to the server to start or stop a test:

• The call is ignored.

• A message is logged with an ERROR level severity.

• A "401 Unauthorized" error is returned to the client.

Data model

The Results API is a RESTful data service based on the Open Data Protocol. This is the OData Entity Description Model (EDM):

<edmx:Edmx xmlns:edmx="http://schemas.microsoft.com/ado/2007/06/edmx"
    Version="1.0">
    <edmx:DataServices
        xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"
        m:DataServiceVersion="1.0">
        <Schema xmlns="http://schemas.microsoft.com/ado/2008/09/edm"
            Namespace="com.neotys.neoload.api.results">
            <EntityType Name="GenerateReport">
                <Key>
                    <PropertyRef Name="ApiKey" />
                </Key>
                <Property Name="ApiKey" Type="Edm.String" Nullable="false" />
                <Property Name="TestResultName" Type="Edm.String" Nullable="true" />
                <Property Name="ComparisonReport" Type="Edm.Boolean"
                    Nullable="true" />
                <Property Name="OtherTestResultName" Type="Edm.String"
                    Nullable="true" />
                <Property Name="TestResultLabel" Type="Edm.String"
                    Nullable="true" />
                <Property Name="OtherTestResultLabel" Type="Edm.String"
                    Nullable="true" />
                <Property Name="CustomReportContents" Type="Edm.Boolean"
                    Nullable="true" />
                <Property Name="Format" Type="Edm.String" Nullable="true" />
                <Property Name="FileName" Type="Edm.String" Nullable="true" />
                <Property Name="ReportId" Type="Edm.String" Nullable="true" />
            </EntityType>
            <EntityType Name="DownloadReport">
                <Key>
                    <PropertyRef Name="ApiKey" />
                </Key>
                <Property Name="ApiKey" Type="Edm.String" Nullable="false" />
                <Property Name="ReportId" Type="Edm.String" Nullable="false" />
            </EntityType>
            <EntityContainer Name="Container"
                m:IsDefaultEntityContainer="true">
                <EntitySet Name="GenerateReport"
                    EntityType="com.neotys.neoload.api.results.GenerateReport" />
                <EntitySet Name="DownloadReport"
                    EntityType="com.neotys.neoload.api.results.DownloadReport" />
            </EntityContainer>
        </Schema>
    </edmx:DataServices>
</edmx:Edmx>

Endpoint

The NeoLoad Controller embeds a REST API server that listens on port 7400. The Results API method can be called using the URL:

http://localhost:7400/Results/v1/Service.svc/

The port can be customized and the communication secured in configuration file controller.properties. For more information, see REST APIs.