Data model

The Runtime 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.runtime">
			<EntityType Name="StartTest">
				<Key>
					<PropertyRef Name="ApiKey"/>
				</Key>
				<Property Name="ApiKey" Type="Edm.String" Nullable="false"/>
				<Property Name="ScenarioName" Type="Edm.String" Nullable="true"/>
				<Property Name="TestResultName" Type="Edm.String" Nullable="true"/>
				<Property Name="Description" Type="Edm.String" Nullable="true"/>
				<Property Name="Debug" Type="Edm.Boolean" Nullable="true"/>
				<Property Name="NLWeb" Type="Edm.Boolean" Nullable="false"/>
				<Property Name="NLWebToken" Type="Edm.String" Nullable="true"/>
			</EntityType>
			<EntityType Name="StopTest">
				<Key>
					<PropertyRef Name="ApiKey"/>
				</Key>
				<Property Name="ApiKey" Type="Edm.String" Nullable="false"/>
				<Property Name="ForceStop" Type="Edm.Boolean" Nullable="true"/>
			</EntityType>
			<EntityType Name="GetStatus">
				<Key>
					<PropertyRef Name="ApiKey"/>
				</Key>
				<Property Name="ApiKey" Type="Edm.String" Nullable="false"/>
				<Property Name="Status" Type="Edm.String" Nullable="true"/>
			</EntityType>
			<EntityType Name="AddVirtualUsers">
				<Key>
					<PropertyRef Name="ApiKey"/>
				</Key>
				<Property Name="ApiKey" Type="Edm.String" Nullable="false"/>
				<Property Name="PopulationName" Type="Edm.String" Nullable="true"/>
				<Property Name="VirtualUserCount" Type="Edm.Int32" Nullable="true"/>
				<Property Name="AddedVirtualUser" Type="Edm.Int32" Nullable="true"/>
			</EntityType>
			<EntityType Name="StopVirtualUsers">
				<Key>
					<PropertyRef Name="ApiKey"/>
				</Key>
				<Property Name="ApiKey" Type="Edm.String" Nullable="false"/>
				<Property Name="PopulationName" Type="Edm.String" Nullable="true"/>
				<Property Name="VirtualUserCount" Type="Edm.Int32" Nullable="true"/>
				<Property Name="StopPolicy" Type="Edm.String" Nullable="true"/>
				<Property Name="StoppedVirtualUser" Type="Edm.Int32" Nullable="true"/>
			</EntityType>
			<EntityContainer Name="Container" m:IsDefaultEntityContainer="true">
				<EntitySet Name="StartTest" EntityType="com.neotys.neoload.api.runtime.StartTest"/>
				<EntitySet Name="StopTest" EntityType="com.neotys.neoload.api.runtime.StopTest"/>
				<EntitySet Name="GetStatus" EntityType="com.neotys.neoload.api.runtime.GetStatus"/>
				<EntitySet Name="AddVirtualUsers" EntityType="com.neotys.neoload.api.runtime.AddVirtualUsers"/>
				<EntitySet Name="StopVirtualUsers" EntityType="com.neotys.neoload.api.runtime.StopVirtualUsers"/>
			</EntityContainer>
		</Schema>
	</edmx:DataServices>
</edmx:Edmx>