runHistory.json

{
  "swagger": "2.0",
  "info": {
    "version": "2019-08-01",
    "title": "Run History APIs"
  },
  "schemes": [
    "https"
  ],
  "paths": {
    "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/batch/events": {
      "post": {
        "tags": [
          "Events"
        ],
        "summary": "Batch post event data.",
        "description": "Post event data to a specific Run Id.",
        "operationId": "Events_BatchPost",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "experimentName",
            "in": "path",
            "description": "The experiment name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "batchEventCommand",
            "in": "body",
            "description": "The batch of Event details.",
            "required": false,
            "schema": {
              "$ref": "#/definitions/BatchEventCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The batch of Events is posted successfully.",
            "schema": {
              "$ref": "#/definitions/BatchEventCommandResult"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      }
    },
    "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/events": {
      "post": {
        "tags": [
          "Events"
        ],
        "summary": "Post event data.",
        "description": "Post event data to a specific Run Id.",
        "operationId": "Events_Post",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "experimentName",
            "in": "path",
            "description": "The experiment name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "runId",
            "in": "path",
            "description": "The identifier of the Run.",
            "required": true,
            "type": "string"
          },
          {
            "name": "eventMessage",
            "in": "body",
            "description": "The Event details.",
            "required": false,
            "schema": {
              "$ref": "#/definitions/BaseEvent"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The Event is posted successfully."
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      }
    },
    "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}": {
      "get": {
        "tags": [
          "Experiments"
        ],
        "summary": "Get details of an Experiment.",
        "description": "Get details of an Experiment with specific Experiment name.",
        "operationId": "Experiments_Get",
        "consumes": [],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "experimentName",
            "in": "path",
            "description": "The experiment name.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The details of the Experiment are returned successfully.",
            "schema": {
              "$ref": "#/definitions/Experiment"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      },
      "post": {
        "tags": [
          "Experiments"
        ],
        "summary": "Create an Experiment.",
        "description": "Create a new Experiment.",
        "operationId": "Experiments_Create",
        "consumes": [],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "experimentName",
            "in": "path",
            "description": "The experiment name.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The Experiment is created successfully.",
            "schema": {
              "$ref": "#/definitions/Experiment"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      }
    },
    "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}": {
      "get": {
        "tags": [
          "Experiments"
        ],
        "summary": "Get details of an Experiment.",
        "description": "Get details of an Experiment with specific Experiment Id.",
        "operationId": "Experiments_GetById",
        "consumes": [],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "experimentId",
            "in": "path",
            "description": "The identifier of the experiment.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/Experiment"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      },
      "patch": {
        "tags": [
          "Experiments"
        ],
        "summary": "Update details of an Experiment.",
        "description": "Update details of an Experiment with specific Experiment Id.",
        "operationId": "Experiments_Update",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "experimentId",
            "in": "path",
            "description": "The identifier of the experiment.",
            "required": true,
            "type": "string"
          },
          {
            "name": "modifyExperimentDto",
            "in": "body",
            "description": "Experiment details which needs to be updated.",
            "required": false,
            "schema": {
              "$ref": "#/definitions/ModifyExperiment"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/Experiment"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      }
    },
    "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments:query": {
      "post": {
        "tags": [
          "Experiments"
        ],
        "summary": "Get all Experiments in a specific workspace.",
        "description": "Get all experiments in a specific workspace with the specified query filters.",
        "operationId": "Experiments_GetByQuery",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "queryParams",
            "in": "body",
            "description": "Query parameters for data sorting and filtering.",
            "required": false,
            "schema": {
              "$ref": "#/definitions/QueryParams"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/PaginatedExperimentList"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        }
      }
    },
    "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/tags": {
      "delete": {
        "tags": [
          "Experiments"
        ],
        "summary": "Delete list of Tags in an Experiment.",
        "description": "Delete list of Tags from a specific Experiment Id.",
        "operationId": "Experiments_DeleteTags",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "experimentId",
            "in": "path",
            "description": "The identifier of the experiment.",
            "required": true,
            "type": "string"
          },
          {
            "name": "tags",
            "in": "body",
            "description": "The requested tags list to be deleted.",
            "required": false,
            "schema": {
              "$ref": "#/definitions/DeleteTagsCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/Experiment"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      }
    },
    "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/children": {
      "get": {
        "tags": [
          "Run"
        ],
        "summary": "Get details of all child runs.",
        "description": "Get details of all child runs for the specified Run Id with the specified filters.",
        "operationId": "Runs_GetChild",
        "consumes": [],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "experimentName",
            "in": "path",
            "description": "The experiment name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "runId",
            "in": "path",
            "description": "The identifier of the Run.",
            "required": true,
            "type": "string"
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Allows for filtering the collection of resources.\r\nThe expression specified is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response.",
            "required": false,
            "type": "string"
          },
          {
            "name": "$continuationtoken",
            "in": "query",
            "description": "The continuation token to use for getting the next set of resources.",
            "required": false,
            "type": "string"
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "The list of resource properties to use for sorting the requested resources.",
            "required": false,
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi",
            "uniqueItems": false
          },
          {
            "name": "$sortorder",
            "in": "query",
            "description": "The sort order of the returned resources. Not used, specify asc or desc after each property name in the OrderBy parameter.",
            "required": false,
            "type": "string",
            "enum": [
              "Asc",
              "Desc"
            ]
          },
          {
            "name": "$top",
            "in": "query",
            "description": "The maximum number of items in the resource collection to be included in the result.\r\nIf not specified, all items are returned.",
            "required": false,
            "type": "integer",
            "format": "int32"
          },
          {
            "name": "$count",
            "in": "query",
            "description": "Whether to include a count of the matching resources along with the resources returned in the response.",
            "required": false,
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The details of the child Runs are returned successfully.",
            "schema": {
              "$ref": "#/definitions/PaginatedRunList"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        }
      }
    },
    "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/details": {
      "get": {
        "tags": [
          "Run"
        ],
        "summary": "Get Run Details.",
        "description": "Get Run Details for a specific Run Id.",
        "operationId": "Runs_GetDetails",
        "consumes": [],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "experimentName",
            "in": "path",
            "description": "The experiment name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "runId",
            "in": "path",
            "description": "The identifier of the Run.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The details of the Run are returned successfully.",
            "schema": {
              "$ref": "#/definitions/RunDetails"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      }
    },
    "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/batch/runs": {
      "patch": {
        "tags": [
          "Run"
        ],
        "summary": "Add or Modify a batch of Runs.",
        "description": "Add or Modify a batch of Runs for a given experiment.",
        "operationId": "Runs_BatchAddOrModify",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "experimentName",
            "in": "path",
            "description": "The experiment name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "requestDto",
            "in": "body",
            "description": "The list of requested Run Additions/modifications in an Experiment.",
            "required": false,
            "schema": {
              "$ref": "#/definitions/BatchAddOrModifyRunRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The Batch Runs are added/modified successfully.",
            "schema": {
              "$ref": "#/definitions/BatchAddOrModifyRunResult"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      }
    },
    "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}": {
      "get": {
        "tags": [
          "Run"
        ],
        "summary": "Get Run details.",
        "description": "Get Run details of a specific Run Id.",
        "operationId": "Runs_Get",
        "consumes": [],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "experimentName",
            "in": "path",
            "description": "The experiment name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "runId",
            "in": "path",
            "description": "The identifier of the Run.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The details of the Run are returned successfully.",
            "schema": {
              "$ref": "#/definitions/Run"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      },
      "patch": {
        "tags": [
          "Run"
        ],
        "summary": "Add or Modify a Run.",
        "description": "Add a new Run or Modify an existing Run.",
        "operationId": "Runs_Patch",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "experimentName",
            "in": "path",
            "description": "The experiment name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "runId",
            "in": "path",
            "description": "The identifier of the Run.",
            "required": true,
            "type": "string",
            "pattern": "^[a-zA-Z0-9][\\w-]{0,255}$"
          },
          {
            "name": "createRunDto",
            "in": "body",
            "description": "The requested Run parameter Additions/modifications.",
            "required": false,
            "schema": {
              "$ref": "#/definitions/CreateRun"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The Run is added/modified successfully.",
            "schema": {
              "$ref": "#/definitions/Run"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      }
    },
    "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/tags": {
      "delete": {
        "tags": [
          "Run"
        ],
        "summary": "Delete list of Tags in a Run.",
        "description": "Delete list of Tags from a specific Run Id.",
        "operationId": "Runs_DeleteTags",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "experimentName",
            "in": "path",
            "description": "The experiment name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "runId",
            "in": "path",
            "description": "The identifier of the Run.",
            "required": true,
            "type": "string"
          },
          {
            "name": "tags",
            "in": "body",
            "description": "The requested tags list to be deleted.",
            "required": false,
            "schema": {
              "uniqueItems": false,
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/Run"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      }
    },
    "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs:query": {
      "post": {
        "tags": [
          "Run"
        ],
        "summary": "Get all Runs for a specific Experiment.",
        "description": "Get all Runs for a specific Experiment with the specified query filters.",
        "operationId": "Runs_GetByQuery",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "experimentName",
            "in": "path",
            "description": "The experiment name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "queryParams",
            "in": "body",
            "description": "Query parameters for data sorting and filtering.",
            "required": false,
            "schema": {
              "$ref": "#/definitions/QueryParams"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/PaginatedRunList"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        }
      }
    },
    "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts": {
      "get": {
        "tags": [
          "RunArtifacts"
        ],
        "summary": "Get Artifacts in a container.",
        "description": "Get Artifacts in container for a specific Run Id.",
        "operationId": "RunArtifacts_ListInContainer",
        "consumes": [],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "experimentName",
            "in": "path",
            "description": "The experiment name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "runId",
            "in": "path",
            "description": "The identifier of the Run.",
            "required": true,
            "type": "string"
          },
          {
            "name": "continuationToken",
            "in": "query",
            "description": "The Continuation Token.",
            "required": false,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The Artifacts in Container are returned successfully.",
            "schema": {
              "$ref": "#/definitions/PaginatedArtifactList"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        }
      }
    },
    "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/path": {
      "get": {
        "tags": [
          "RunArtifacts"
        ],
        "summary": "Get Artifacts in the provided path.",
        "description": "Get Artifacts in the provided path for a specific Run Id.",
        "operationId": "RunArtifacts_ListInPath",
        "consumes": [],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "experimentName",
            "in": "path",
            "description": "The experiment name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "runId",
            "in": "path",
            "description": "The identifier of the Run.",
            "required": true,
            "type": "string"
          },
          {
            "name": "path",
            "in": "query",
            "description": "The Artifact Path.",
            "required": false,
            "type": "string"
          },
          {
            "name": "continuationToken",
            "in": "query",
            "description": "The Continuation Token.",
            "required": false,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/PaginatedArtifactList"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        }
      }
    },
    "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/metadata": {
      "get": {
        "tags": [
          "RunArtifacts"
        ],
        "summary": "Get Artifact by Id.",
        "description": "Get Artifact for a specific Id.",
        "operationId": "RunArtifacts_GetById",
        "consumes": [],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "experimentName",
            "in": "path",
            "description": "The experiment name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "runId",
            "in": "path",
            "description": "The identifier of the Run.",
            "required": true,
            "type": "string"
          },
          {
            "name": "path",
            "in": "query",
            "description": "The Artifact Path.",
            "required": false,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/Artifact"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      }
    },
    "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/contentinfo": {
      "get": {
        "tags": [
          "RunArtifacts"
        ],
        "summary": "Get Artifact content information.",
        "description": "Get Artifact content information for give Run Id.",
        "operationId": "RunArtifacts_GetContentInformation",
        "consumes": [],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "experimentName",
            "in": "path",
            "description": "The experiment name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "runId",
            "in": "path",
            "description": "The identifier of the Run.",
            "required": true,
            "type": "string"
          },
          {
            "name": "path",
            "in": "query",
            "description": "The Artifact Path.",
            "required": false,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The Artifact content information is returned successfully.",
            "schema": {
              "$ref": "#/definitions/ArtifactContentInformation"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      }
    },
    "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/artifacturi": {
      "get": {
        "tags": [
          "RunArtifacts"
        ],
        "summary": "Get URI of an Artifact.",
        "description": "Get URI of an Artifact for a specific Run Id.",
        "operationId": "RunArtifacts_GetSasUri",
        "consumes": [],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "experimentName",
            "in": "path",
            "description": "The experiment name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "runId",
            "in": "path",
            "description": "The identifier of the Run.",
            "required": true,
            "type": "string"
          },
          {
            "name": "path",
            "in": "query",
            "description": "The Artifact Path.",
            "required": false,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      }
    },
    "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/prefix/contentinfo": {
      "get": {
        "tags": [
          "RunArtifacts"
        ],
        "summary": "Get SAS of an Artifact.",
        "description": "Get SAS of an Artifact in the specified path.",
        "operationId": "RunArtifacts_ListSasByPrefix",
        "consumes": [],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "experimentName",
            "in": "path",
            "description": "The experiment name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "runId",
            "in": "path",
            "description": "The identifier of the Run.",
            "required": true,
            "type": "string"
          },
          {
            "name": "path",
            "in": "query",
            "description": "The Artifact Path.",
            "required": false,
            "type": "string"
          },
          {
            "name": "continuationToken",
            "in": "query",
            "description": "The Continuation Token.",
            "required": false,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/PaginatedArtifactContentInformationList"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        }
      }
    },
    "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/batch/metadata": {
      "post": {
        "tags": [
          "RunArtifacts"
        ],
        "summary": "Create a batch of empty Artifacts.",
        "description": "Create a batch of empty Artifacts in a specific Run.",
        "operationId": "RunArtifacts_BatchCreateEmptyArtifacts",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "experimentName",
            "in": "path",
            "description": "The experiment name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "runId",
            "in": "path",
            "description": "The identifier of the Run.",
            "required": true,
            "type": "string"
          },
          {
            "name": "artifactPaths",
            "in": "body",
            "description": "The list of artifact paths.",
            "required": false,
            "schema": {
              "$ref": "#/definitions/ArtifactPathList"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The Batch Artifacts are created successfully.",
            "schema": {
              "$ref": "#/definitions/BatchArtifactContentInformationResult"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      }
    },
    "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/metrics": {
      "post": {
        "tags": [
          "RunMetrics"
        ],
        "summary": "Post Metric to a Run.",
        "description": "Post a Metric to a specific Run Id.",
        "operationId": "RunMetrics_Post",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "experimentName",
            "in": "path",
            "description": "The experiment name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "runId",
            "in": "path",
            "description": "The identifier for a run.",
            "required": true,
            "type": "string"
          },
          {
            "name": "metricDto",
            "in": "body",
            "description": "Details of the metric which will be added to the Run Id.",
            "required": false,
            "schema": {
              "$ref": "#/definitions/Metric"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The Run Metric is posted successfully."
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      }
    },
    "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/batch/metrics": {
      "post": {
        "tags": [
          "RunMetrics"
        ],
        "summary": "Post Metrics to a Run.",
        "description": "Post Metrics to a specific Run Id.",
        "operationId": "RunMetrics_BatchPost",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "experimentName",
            "in": "path",
            "description": "The experiment name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "runId",
            "in": "path",
            "description": "The identifier for a run.",
            "required": true,
            "type": "string"
          },
          {
            "name": "batchMetricDto",
            "in": "body",
            "description": "Details of the Metrics which will be added to the Run Id.",
            "required": false,
            "schema": {
              "$ref": "#/definitions/BatchMetric"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The Run Metrics are posted successfully."
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      }
    },
    "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/metrics/{metricId}": {
      "get": {
        "tags": [
          "RunMetrics"
        ],
        "summary": "Get Metric details.",
        "description": "Get Metric details for a specific Metric Id.",
        "operationId": "RunMetrics_Get",
        "consumes": [],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "experimentName",
            "in": "path",
            "description": "The experiment name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "metricId",
            "in": "path",
            "description": "The identifier for a Metric.",
            "required": true,
            "type": "string",
            "format": "uuid"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunMetric"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      }
    },
    "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/metrics:query": {
      "post": {
        "tags": [
          "RunMetrics"
        ],
        "summary": "Get all Run Metrics for the specific Experiment.",
        "description": "Get all Run Metrics for the specific Experiment with the specified query filters.",
        "operationId": "RunMetrics_GetByQuery",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/workspaceNameParameter"
          },
          {
            "name": "experimentName",
            "in": "path",
            "description": "The experiment name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "queryParams",
            "in": "body",
            "description": "Query Parameters for data sorting and filtering.",
            "required": false,
            "schema": {
              "$ref": "#/definitions/QueryParams"
            }
          },
          {
            "name": "MergeStrategyType",
            "in": "query",
            "description": "The type of merge strategy. Currently supported strategies are:\r\nNone - all logged values are returned as individual metrics.\r\nMergeToVector - merges multiple values into a vector of values.\r\nDefault - the system determines the behavior.",
            "required": false,
            "type": "string",
            "enum": [
              "Default",
              "None",
              "MergeToVector"
            ]
          },
          {
            "name": "MergeStrategyOptions",
            "in": "query",
            "description": "Controls behavior of the merge strategy in certain cases; e.g. when a metric is not merged.",
            "required": false,
            "type": "string",
            "enum": [
              "None",
              "ReportUnmergedMetricsValues"
            ]
          },
          {
            "name": "MergeStrategySettings.Version",
            "in": "query",
            "description": "The strategy settings version.",
            "required": false,
            "type": "string"
          },
          {
            "name": "MergeStrategySettings.SelectMetrics",
            "in": "query",
            "description": "Defines how to select metrics when merging them together.",
            "required": false,
            "type": "string",
            "enum": [
              "SelectAll",
              "SelectByFirstValueSchema",
              "SelectByFirstValueSchemaMergeNumericValues"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "The Run Metrics are returned successfully.",
            "schema": {
              "$ref": "#/definitions/PaginatedRunMetricList"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        }
      }
    }
  },
  "definitions": {
    "BatchEventCommand": {
      "type": "object",
      "properties": {
        "events": {
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/BaseEvent"
          }
        }
      }
    },
    "BaseEvent": {
      "description": "Base event is the envelope used to post event data to the Event controller",
      "type": "object",
      "properties": {
        "timestamp": {
          "format": "date-time",
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "data": {
          "type": "object"
        }
      }
    },
    "BatchEventCommandResult": {
      "type": "object",
      "properties": {
        "errors": {
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/KeyValuePairBaseEventErrorResponse"
          }
        }
      }
    },
    "KeyValuePairBaseEventErrorResponse": {
      "type": "object",
      "properties": {
        "key": {
          "$ref": "#/definitions/BaseEvent",
          "readOnly": true
        },
        "value": {
          "$ref": "#/definitions/ErrorResponse",
          "readOnly": true
        }
      }
    },
    "ErrorResponse": {
      "description": "The error response.",
      "type": "object",
      "properties": {
        "error": {
          "$ref": "#/definitions/RootError",
          "description": "The top level error that occurred."
        },
        "correlation": {
          "description": "Dictionary containing correlation details for the error.",
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "environment": {
          "description": "The hosting environment.",
          "type": "string"
        },
        "location": {
          "description": "The Azure region.",
          "type": "string"
        },
        "time": {
          "format": "date-time",
          "description": "The time in UTC.",
          "type": "string"
        }
      }
    },
    "RootError": {
      "description": "The root error.",
      "type": "object",
      "properties": {
        "code": {
          "description": "The service-defined error code. Supported error codes: ServiceError, UserError, ValidationError, AzureStorageError, TransientError, RequestThrottled.",
          "type": "string"
        },
        "message": {
          "description": "A human-readable representation of the error.",
          "type": "string"
        },
        "target": {
          "description": "The target of the error (e.g., the name of the property in error).",
          "type": "string"
        },
        "details": {
          "description": "The related errors that occurred during the request.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/ErrorDetails"
          }
        },
        "innerError": {
          "$ref": "#/definitions/InnerErrorResponse",
          "description": "A nested list of inner errors. When evaluating errors, clients MUST traverse through all of the nested “innerErrors” and choose the deepest one that they understand."
        }
      }
    },
    "ErrorDetails": {
      "description": "The error details.",
      "type": "object",
      "properties": {
        "code": {
          "description": "The error code.",
          "type": "string"
        },
        "message": {
          "description": "The error message.",
          "type": "string"
        },
        "target": {
          "description": "The target of the error (e.g., the name of the property in error).",
          "type": "string"
        }
      }
    },
    "InnerErrorResponse": {
      "description": "A nested structure of errors.",
      "type": "object",
      "properties": {
        "code": {
          "description": "The error code.",
          "type": "string"
        },
        "innerError": {
          "$ref": "#/definitions/InnerErrorResponse",
          "description": "A nested list of inner errors. When evaluating errors, clients MUST traverse through all of the nested “innerErrors” and choose the deepest one that they understand."
        }
      }
    },
    "Experiment": {
      "type": "object",
      "properties": {
        "experimentId": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "createdUtc": {
          "format": "date-time",
          "type": "string"
        },
        "tags": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "archivedTime": {
          "format": "date-time",
          "type": "string"
        },
        "latestCreatedRunCreatedUtc": {
          "format": "date-time",
          "type": "string"
        },
        "latestCreatedRunId": {
          "type": "string"
        }
      }
    },
    "ModifyExperiment": {
      "type": "object",
      "properties": {
        "description": {
          "type": "string"
        },
        "tags": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "archive": {
          "type": "boolean"
        }
      }
    },
    "QueryParams": {
      "description": "The set of supported filters.",
      "type": "object",
      "properties": {
        "filter": {
          "description": "Allows for filtering the collection of resources.\r\nThe expression specified is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response.\r\nSee https://docs.microsoft.com/en-us/azure/search/query-odata-filter-orderby-syntax for details on the expression syntax.",
          "type": "string"
        },
        "continuationToken": {
          "description": "The continuation token to use for getting the next set of resources.",
          "type": "string"
        },
        "orderBy": {
          "description": "The comma separated list of resource properties to use for sorting the requested resources.\r\nOptionally, can be followed by either 'asc' or 'desc'",
          "type": "string",
          "example": "Color, Size desc"
        },
        "top": {
          "format": "int32",
          "description": "The maximum number of items in the resource collection to be included in the result.\r\nIf not specified, all items are returned.",
          "type": "integer"
        }
      }
    },
    "PaginatedExperimentList": {
      "description": "A paginated list of Experiments.",
      "type": "object",
      "properties": {
        "value": {
          "description": "An array of objects of type Experiment.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/Experiment"
          }
        },
        "continuationToken": {
          "description": "The token used in retrieving the next page.  If null, there are no additional pages.",
          "type": "string"
        },
        "nextLink": {
          "description": "The link to the next page constructed using the continuationToken.  If null, there are no additional pages.",
          "type": "string"
        }
      }
    },
    "DeleteTagsCommand": {
      "type": "object",
      "properties": {
        "tags": {
          "uniqueItems": false,
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "PaginatedRunList": {
      "description": "A paginated list of Runs.",
      "type": "object",
      "properties": {
        "value": {
          "description": "An array of objects of type Run.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/Run"
          }
        },
        "continuationToken": {
          "description": "The token used in retrieving the next page.  If null, there are no additional pages.",
          "type": "string"
        },
        "nextLink": {
          "description": "The link to the next page constructed using the continuationToken.  If null, there are no additional pages.",
          "type": "string"
        }
      }
    },
    "Run": {
      "description": "The definition of a Run.",
      "type": "object",
      "properties": {
        "runNumber": {
          "format": "int32",
          "type": "integer"
        },
        "rootRunId": {
          "type": "string"
        },
        "experimentId": {
          "description": "The Id of the experiment that created this run.",
          "type": "string"
        },
        "createdUtc": {
          "format": "date-time",
          "description": "The time the run was created in UTC.",
          "type": "string"
        },
        "createdBy": {
          "$ref": "#/definitions/CreatedBy",
          "description": "The details of the user who created the run."
        },
        "userId": {
          "description": "The Id of the user that created the run.",
          "type": "string"
        },
        "token": {
          "description": "A token used for authenticating a run.",
          "type": "string"
        },
        "tokenExpiryTimeUtc": {
          "format": "date-time",
          "description": "The Token expiration time in UTC.",
          "type": "string"
        },
        "error": {
          "$ref": "#/definitions/ErrorResponse",
          "description": "If an error occurred during the run, this will be populated."
        },
        "warnings": {
          "description": "A list of warnings that occurred during the run.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/RunDetailsWarning"
          }
        },
        "revision": {
          "format": "int32",
          "type": "integer"
        },
        "runId": {
          "description": "The identifier for the run. Run IDs must be less than 256 characters and contain only alphanumeric characters with dashes and underscores.",
          "type": "string"
        },
        "parentRunId": {
          "description": "The parent of the run if the run is hierarchical; otherwise, Null.",
          "type": "string"
        },
        "status": {
          "description": "The status of the run. The Status string value maps to the RunStatus Enum.",
          "type": "string"
        },
        "startTimeUtc": {
          "format": "date-time",
          "description": "The start time of the run in UTC.",
          "type": "string"
        },
        "endTimeUtc": {
          "format": "date-time",
          "description": "The end time of the run in UTC.",
          "type": "string"
        },
        "heartbeatEnabled": {
          "type": "boolean"
        },
        "options": {
          "$ref": "#/definitions/RunOptions"
        },
        "name": {
          "type": "string"
        },
        "dataContainerId": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "hidden": {
          "type": "boolean"
        },
        "runType": {
          "type": "string"
        },
        "properties": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "scriptName": {
          "type": "string"
        },
        "target": {
          "type": "string"
        },
        "tags": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "runDefinition": {
          "type": "object"
        },
        "createdFrom": {
          "$ref": "#/definitions/CreatedFrom"
        },
        "cancelUri": {
          "type": "string"
        },
        "diagnosticsUri": {
          "type": "string"
        }
      }
    },
    "CreatedBy": {
      "type": "object",
      "properties": {
        "userObjectId": {
          "description": "A user or service principal's object ID.\r\nThis is PII and should never be logged.",
          "type": "string"
        },
        "userTenantId": {
          "description": "A user or service principal's tenant ID.",
          "type": "string"
        },
        "userName": {
          "description": "A user's full name or a service principal's app ID.\r\nThis is PII and should never be logged.",
          "type": "string"
        }
      }
    },
    "RunDetailsWarning": {
      "type": "object",
      "properties": {
        "source": {
          "type": "string"
        },
        "message": {
          "type": "string"
        }
      }
    },
    "RunOptions": {
      "type": "object",
      "properties": {
        "generateDataContainerIdIfNotSpecified": {
          "type": "boolean"
        }
      }
    },
    "CreatedFrom": {
      "type": "object",
      "properties": {
        "type": {
          "enum": [
            "Notebook"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "CreatedFromType",
            "modelAsString": false
          }
        },
        "locationType": {
          "enum": [
            "ArtifactId"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "CreatedFromLocationType",
            "modelAsString": false
          }
        },
        "location": {
          "type": "string"
        }
      }
    },
    "RunDetails": {
      "description": "The details of the run.",
      "type": "object",
      "properties": {
        "runId": {
          "description": "The identifier for the run.",
          "type": "string"
        },
        "target": {
          "description": "The name of the compute target where the run is executed.",
          "type": "string"
        },
        "status": {
          "description": "The status of the run. The Status string value maps to the RunStatus Enum.",
          "type": "string"
        },
        "parentRunId": {
          "description": "The parent of the run if the run is hierarchical.",
          "type": "string"
        },
        "startTimeUtc": {
          "format": "date-time",
          "description": "The start time of the run in UTC.",
          "type": "string"
        },
        "endTimeUtc": {
          "format": "date-time",
          "description": "The end time of the run in UTC.",
          "type": "string"
        },
        "error": {
          "$ref": "#/definitions/ErrorResponse",
          "description": "If an error occurred during the run, this will be populated."
        },
        "warnings": {
          "description": "A list of warnings that occurred during the run.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/RunDetailsWarning"
          }
        },
        "tags": {
          "description": "The tag dictionary for the run. Tags are mutable.",
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "properties": {
          "description": "The properties dictionary for the run. Properties are immutable.",
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "runDefinition": {
          "description": "The run definition specification.",
          "type": "object"
        },
        "logFiles": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "revision": {
          "format": "int32",
          "type": "integer"
        }
      }
    },
    "BatchAddOrModifyRunRequest": {
      "type": "object",
      "properties": {
        "runs": {
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/CreateRun"
          }
        }
      }
    },
    "CreateRun": {
      "type": "object",
      "properties": {
        "runId": {
          "description": "The identifier for the run. Run IDs must be less than 256 characters and contain only alphanumeric characters with dashes and underscores.",
          "type": "string"
        },
        "parentRunId": {
          "description": "The parent of the run if the run is hierarchical; otherwise, Null.",
          "type": "string"
        },
        "status": {
          "description": "The status of the run. The Status string value maps to the RunStatus Enum.",
          "type": "string"
        },
        "startTimeUtc": {
          "format": "date-time",
          "description": "The start time of the run in UTC.",
          "type": "string"
        },
        "endTimeUtc": {
          "format": "date-time",
          "description": "The end time of the run in UTC.",
          "type": "string"
        },
        "heartbeatEnabled": {
          "type": "boolean"
        },
        "options": {
          "$ref": "#/definitions/RunOptions"
        },
        "name": {
          "type": "string"
        },
        "dataContainerId": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "hidden": {
          "type": "boolean"
        },
        "runType": {
          "type": "string"
        },
        "properties": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "scriptName": {
          "type": "string"
        },
        "target": {
          "type": "string"
        },
        "tags": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "runDefinition": {
          "type": "object"
        },
        "createdFrom": {
          "$ref": "#/definitions/CreatedFrom"
        },
        "cancelUri": {
          "type": "string"
        },
        "diagnosticsUri": {
          "type": "string"
        }
      }
    },
    "BatchAddOrModifyRunResult": {
      "type": "object",
      "properties": {
        "runs": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/Run"
          }
        },
        "errors": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/ErrorResponse"
          }
        }
      }
    },
    "PaginatedArtifactList": {
      "description": "A paginated list of Artifacts.",
      "type": "object",
      "properties": {
        "value": {
          "description": "An array of objects of type Artifact.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/Artifact"
          }
        },
        "continuationToken": {
          "description": "The token used in retrieving the next page.  If null, there are no additional pages.",
          "type": "string"
        },
        "nextLink": {
          "description": "The link to the next page constructed using the continuationToken.  If null, there are no additional pages.",
          "type": "string"
        }
      }
    },
    "Artifact": {
      "description": "Details of an Artifact.",
      "required": [
        "origin",
        "container",
        "path"
      ],
      "type": "object",
      "properties": {
        "artifactId": {
          "description": "The identifier of an Artifact. Format of ArtifactId - {Origin}/{Container}/{Path}.",
          "type": "string"
        },
        "origin": {
          "description": "The origin of the Artifact creation request. Available origins are 'ExperimentRun', 'LocalUpload', 'WebUpload', 'Dataset' and 'Unknown'.",
          "type": "string"
        },
        "container": {
          "description": "The name of container. Artifacts can be grouped by container.",
          "type": "string"
        },
        "path": {
          "description": "The path to the Artifact in a container.",
          "type": "string"
        },
        "etag": {
          "description": "The Etag of the Artifact.",
          "type": "string",
          "readOnly": true
        },
        "createdTime": {
          "format": "date-time",
          "description": "The Date and Time at which the Artifact is created. The DateTime is in UTC.",
          "type": "string",
          "readOnly": true
        },
        "dataPath": {
          "$ref": "#/definitions/DataPath"
        }
      }
    },
    "DataPath": {
      "type": "object",
      "properties": {
        "dataStoreName": {
          "type": "string"
        },
        "relativePath": {
          "type": "string"
        },
        "sqlDataPath": {
          "$ref": "#/definitions/SqlDataPath"
        }
      }
    },
    "SqlDataPath": {
      "type": "object",
      "properties": {
        "sqlTableName": {
          "type": "string"
        },
        "sqlQuery": {
          "type": "string"
        },
        "sqlStoredProcedureName": {
          "type": "string"
        },
        "sqlStoredProcedureParams": {
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/StoredProcedureParameter"
          }
        }
      }
    },
    "StoredProcedureParameter": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "value": {
          "type": "string"
        },
        "type": {
          "enum": [
            "String",
            "Int",
            "Decimal",
            "Guid",
            "Boolean",
            "Date"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "StoredProcedureParameterType",
            "modelAsString": false
          }
        }
      }
    },
    "ArtifactContentInformation": {
      "description": "Details of an Artifact Content Information.",
      "type": "object",
      "properties": {
        "contentUri": {
          "description": "The URI of the content.",
          "type": "string"
        },
        "origin": {
          "description": "The origin of the Artifact creation request. Available origins are 'ExperimentRun', 'LocalUpload', 'WebUpload', 'Dataset', 'ComputeRecord', 'Metric', and 'Unknown'.",
          "type": "string"
        },
        "container": {
          "description": "The name of container. Artifacts can be grouped by container.",
          "type": "string"
        },
        "path": {
          "description": "The path to the Artifact in a container.",
          "type": "string"
        }
      }
    },
    "PaginatedArtifactContentInformationList": {
      "description": "A paginated list of ArtifactContentInformations.",
      "type": "object",
      "properties": {
        "value": {
          "description": "An array of objects of type ArtifactContentInformation.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/ArtifactContentInformation"
          }
        },
        "continuationToken": {
          "description": "The token used in retrieving the next page.  If null, there are no additional pages.",
          "type": "string"
        },
        "nextLink": {
          "description": "The link to the next page constructed using the continuationToken.  If null, there are no additional pages.",
          "type": "string"
        }
      }
    },
    "ArtifactPathList": {
      "description": "Contains list of Artifact Paths.",
      "required": [
        "paths"
      ],
      "type": "object",
      "properties": {
        "paths": {
          "description": "List of Artifact Paths.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/ArtifactPath"
          }
        }
      }
    },
    "ArtifactPath": {
      "description": "Details of an Artifact Path.",
      "required": [
        "path"
      ],
      "type": "object",
      "properties": {
        "path": {
          "description": "The path to the Artifact in a container.",
          "type": "string"
        }
      }
    },
    "BatchArtifactContentInformationResult": {
      "description": "Results of the Batch Artifact Content Information request.",
      "type": "object",
      "properties": {
        "artifacts": {
          "description": "Artifact details of the Artifact Ids requested.",
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/Artifact"
          }
        },
        "artifactContentInformation": {
          "description": "Artifact Content Information details of the Artifact Ids requested.",
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/ArtifactContentInformation"
          }
        },
        "errors": {
          "description": "Errors occurred while fetching the requested Artifact Ids.",
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/ErrorResponse"
          }
        }
      }
    },
    "Metric": {
      "type": "object",
      "properties": {
        "metricId": {
          "format": "uuid",
          "type": "string"
        },
        "dataContainerId": {
          "type": "string"
        },
        "metricType": {
          "type": "string"
        },
        "createdUtc": {
          "format": "date-time",
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "label": {
          "type": "string"
        },
        "numCells": {
          "format": "int32",
          "type": "integer"
        },
        "dataLocation": {
          "type": "string"
        },
        "cells": {
          "uniqueItems": false,
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            }
          }
        },
        "schema": {
          "$ref": "#/definitions/MetricSchema"
        }
      }
    },
    "MetricSchema": {
      "type": "object",
      "properties": {
        "numProperties": {
          "format": "int32",
          "type": "integer"
        },
        "properties": {
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/MetricSchemaProperty"
          }
        }
      }
    },
    "MetricSchemaProperty": {
      "type": "object",
      "properties": {
        "propertyId": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      }
    },
    "BatchMetric": {
      "type": "object",
      "properties": {
        "values": {
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/Metric"
          }
        }
      }
    },
    "RunMetric": {
      "type": "object",
      "properties": {
        "runId": {
          "type": "string"
        },
        "metricId": {
          "format": "uuid",
          "type": "string"
        },
        "dataContainerId": {
          "type": "string"
        },
        "metricType": {
          "type": "string"
        },
        "createdUtc": {
          "format": "date-time",
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "label": {
          "type": "string"
        },
        "numCells": {
          "format": "int32",
          "type": "integer"
        },
        "dataLocation": {
          "type": "string"
        },
        "cells": {
          "uniqueItems": false,
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            }
          }
        },
        "schema": {
          "$ref": "#/definitions/MetricSchema"
        }
      }
    },
    "PaginatedRunMetricList": {
      "description": "A paginated list of RunMetrics.",
      "type": "object",
      "properties": {
        "value": {
          "description": "An array of objects of type RunMetric.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/RunMetric"
          }
        },
        "continuationToken": {
          "description": "The token used in retrieving the next page.  If null, there are no additional pages.",
          "type": "string"
        },
        "nextLink": {
          "description": "The link to the next page constructed using the continuationToken.  If null, there are no additional pages.",
          "type": "string"
        }
      }
    }
  },
  "parameters": {
    "subscriptionIdParameter": {
      "name": "subscriptionId",
      "in": "path",
      "description": "The Azure Subscription ID.",
      "required": true,
      "type": "string",
      "format": "uuid",
      "x-ms-parameter-location": "method"
    },
    "resourceGroupNameParameter": {
      "name": "resourceGroupName",
      "in": "path",
      "description": "The Name of the resource group in which the workspace is located.",
      "required": true,
      "type": "string",
      "x-ms-parameter-location": "method"
    },
    "workspaceNameParameter": {
      "name": "workspaceName",
      "in": "path",
      "description": "The name of the workspace.",
      "required": true,
      "type": "string",
      "x-ms-parameter-location": "method"
    }
  },
  "securityDefinitions": {
    "azure_auth": {
      "flow": "implicit",
      "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
      "scopes": {
        "user_impersonation": "impersonate your user account"
      },
      "type": "oauth2"
    }
  },
  "security": [
    {
      "azure_auth": [
        "user_impersonation"
      ]
    }
  ],
  "tags": []
}