Answered question

On the REST API of the Controller using the Runtime API Data Model what is required for ApiKey

On the REST API of the Controller using the Runtime API Data Model what is required for ApiKey? The associated data model does indicate that it is required, but doesn't say what it should be. In the rest of the documentation ApiKey is used as an optional login security key. In the REST Runtime data model is this how ApiKey is used and does that mandate that an ApiKey must be set on the Neoload controller in order to use the REST Runtime API?

Can someone detail each field in the Data Model for the REST Runtime API?

Also, is there a way given this REST Runtime API to identify the specific instance of testing started via the REST Runtime API?

Or is the expectation that the caller provide a distinct "TestResultName" which is also defined in the Data Model as

<Property Name="TestResultName" Type="Edm.String" Nullable="true"/>

in order to find the results associated with any particular testing instance launched via the REST Runtime API within the REST Results API?

I noted that each Data Model (Runtime and Results) has a required ApiKey, is this (ApiKey in both) instead a client provided key to uniquely identify the launched test instance so it can later be found in the REST Results API?

Larry H.
Larry H.

Larry H.

Level
0
4 / 100
points
Alexis N.
Alexis N.

Alexis N.

Level
2
805 / 2000
points
Team

The ApiKey is a NeoLoad GUI key used for identification. You can add an ApiKey in REST API settings of NeoLoad GUI (https://www.neotys.com/documents/doc/neoload/latest/en/ht...).
If no identification is required in settings of NeoLoad GUI then the ApiKey should be empty on client side.

Description of the start test method:

The StartTest method sends a request to start a NeoLoad test.
Parameters:
ScenarioName (required): The name of the scenario to launch.
TestResultName (optional): The name of the test result.
Description (optional): The description of the test result.
Debug (optional): Default value is false. If set to true, the test result is launch in debug mode.
NLWeb (optional): Default value is false. If set to true, the test results are sent to NeoLoad web.
NLWebToken (optional): The NeoLoad web token.
Variables (optional): A map allowing to update or create NeoLoad variables.
ApiKey (optional): To authenticate the command. Required if enabled on the Controller.

If you want to generate a report with the Results API, you should use the TestResultName defined when starting the test.

Did you find this useful ?

No (1)

Yes (0)

0%

0% of users found this answer useful