@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Run History APIs
@version 2019-09-30
@auth OAuth2
@common_fields {subscriptionId: any, resourceGroupName: any, workspaceName: any}
@endpoints 26
@hint download_for_search
@toc history(26)

@endpoint POST /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/batch/events
@required {experimentName: any}
@optional {batchEventCommand: map}
@returns(200)

@endpoint POST /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/events
@required {experimentName: any, runId: any}
@optional {eventMessage: map}
@returns(200)

@endpoint GET /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}
@required {experimentName: any}
@returns(200)

@endpoint POST /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}
@required {experimentName: any}
@returns(200)

@endpoint GET /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}
@required {experimentId: any}
@returns(200)

@endpoint PATCH /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}
@required {experimentId: any}
@optional {modifyExperimentDto: map}
@returns(200)

@endpoint POST /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments:query
@optional {queryParams: map}
@returns(200)

@endpoint DELETE /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/tags
@required {experimentId: any}
@optional {tags: map}
@returns(200)

@endpoint GET /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/children
@required {experimentName: any, runId: any}
@optional {$filter: any, $continuationtoken: any, $orderby: any, $sortorder: any, $top: any, $count: any}
@returns(200)

@endpoint GET /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/details
@required {experimentName: any, runId: any}
@returns(200)

@endpoint PATCH /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/batch/runs
@required {experimentName: any}
@optional {requestDto: map}
@returns(200)

@endpoint GET /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}
@required {experimentName: any, runId: any}
@returns(200)

@endpoint PATCH /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}
@required {experimentName: any, runId: any}
@optional {createRunDto: map}
@returns(200)

@endpoint DELETE /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/tags
@required {experimentName: any, runId: any}
@optional {tags: [str]}
@returns(200)

@endpoint POST /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs:query
@required {experimentName: any}
@optional {queryParams: map}
@returns(200)

@endpoint GET /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts
@required {experimentName: any, runId: any}
@optional {continuationToken: any}
@returns(200)

@endpoint GET /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/path
@required {experimentName: any, runId: any}
@optional {path: any, continuationToken: any}
@returns(200)

@endpoint GET /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/metadata
@required {experimentName: any, runId: any}
@optional {path: any}
@returns(200)

@endpoint GET /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/contentinfo
@required {experimentName: any, runId: any}
@optional {path: any}
@returns(200)

@endpoint GET /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/artifacturi
@required {experimentName: any, runId: any}
@optional {path: any}
@returns(200)

@endpoint GET /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/prefix/contentinfo
@required {experimentName: any, runId: any}
@optional {path: any, continuationToken: any}
@returns(200)

@endpoint POST /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/batch/metadata
@required {experimentName: any, runId: any}
@optional {artifactPaths: map}
@returns(200)

@endpoint POST /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/metrics
@required {experimentName: any, runId: any}
@optional {metricDto: map}
@returns(200)

@endpoint POST /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/batch/metrics
@required {experimentName: any, runId: any}
@optional {batchMetricDto: map}
@returns(200)

@endpoint GET /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/metrics/{metricId}
@required {experimentName: any, metricId: any}
@returns(200)

@endpoint POST /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/metrics:query
@required {experimentName: any}
@optional {queryParams: map, MergeStrategyType: any, MergeStrategyOptions: any, MergeStrategySettings.Version: any, MergeStrategySettings.SelectMetrics: any}
@returns(200)

@end
