@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Execution Service API
@version 2019-09-30
@auth OAuth2
@endpoints 4
@toc execution(4)

@endpoint POST /execution/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/startlocalrun
@desc Start a run on a local machine.
@required {subscriptionId: any # The Azure Subscription ID., resourceGroupName: any # The Name of the resource group in which the workspace is located., workspaceName: any # The name of the workspace., experimentName: any # The experiment name., definition: map # A JSON run definition structure.}
@optional {runId: any # A run id. If not supplied a run id will be created automatically.}
@returns(200) File Response

@endpoint POST /execution/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/startrun
@desc Start a run on a remote compute target.
@required {subscriptionId: any # The Azure Subscription ID., resourceGroupName: any # The Name of the resource group in which the workspace is located., workspaceName: any # The name of the workspace., experimentName: any # The experiment name., runDefinitionFile: any # The JSON file containing the RunDefinition, projectZipFile: any # The zip archive of the project folder containing the source code to use for the run.}
@optional {runId: any # A run id. If not supplied a run id will be created automatically.}
@returns(200) A run was successfully started.

@endpoint POST /execution/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/snapshotrun
@desc Start a run from a snapshot on a remote compute target.
@required {subscriptionId: any # The Azure Subscription ID., resourceGroupName: any # The Name of the resource group in which the workspace is located., workspaceName: any # The name of the workspace., experimentName: any # The experiment name., definition: map # A JSON run definition structure.}
@optional {runId: any # A run id. If not supplied a run id will be created automatically.}
@returns(200) A snapshot run was successfully started.

@endpoint POST /execution/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runId/{runId}/cancel
@desc Cancel a run.
@required {subscriptionId: any # The Azure Subscription ID., resourceGroupName: any # The Name of the resource group in which the workspace is located., workspaceName: any # The name of the workspace., experimentName: any # The experiment name., runId: any # The id of the run to cancel.}
@returns(200) The run was successfully cancelled.

@end