swagger: "2.0"
schemes:
  - https
host: azure.local
info:
  title: Run History APIs
  version: 2019-08-01
  x-apisguru-categories:
    - cloud
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png
  x-origin:
    - format: swagger
      url: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2019-08-01/runHistory.json
      version: "2.0"
  x-preferred: false
  x-providerName: azure.com
  x-serviceName: machinelearningservices-runHistory
  x-tags:
    - Azure
    - Microsoft
produces:
  - application/json
securityDefinitions:
  azure_auth:
    authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
    flow: implicit
    scopes:
      user_impersonation: impersonate your user account
    type: oauth2
security:
  - azure_auth:
      - user_impersonation
parameters:
  resourceGroupNameParameter:
    description: The Name of the resource group in which the workspace is located.
    in: path
    name: resourceGroupName
    required: true
    type: string
    x-ms-parameter-location: method
  subscriptionIdParameter:
    description: The Azure Subscription ID.
    format: uuid
    in: path
    name: subscriptionId
    required: true
    type: string
    x-ms-parameter-location: method
  workspaceNameParameter:
    description: The name of the workspace.
    in: path
    name: workspaceName
    required: true
    type: string
    x-ms-parameter-location: method
tags: []
paths:
  "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}":
    get:
      consumes: []
      description: Get details of an Experiment with specific Experiment Id.
      operationId: Experiments_GetById
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: The identifier of the experiment.
          in: path
          name: experimentId
          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"
      summary: Get details of an Experiment.
      tags:
        - Experiments
    patch:
      consumes:
        - application/json
      description: Update details of an Experiment with specific Experiment Id.
      operationId: Experiments_Update
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: The identifier of the experiment.
          in: path
          name: experimentId
          required: true
          type: string
        - description: Experiment details which needs to be updated.
          in: body
          name: modifyExperimentDto
          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"
      summary: Update details of an Experiment.
      tags:
        - Experiments
  "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/tags":
    delete:
      consumes:
        - application/json
      description: Delete list of Tags from a specific Experiment Id.
      operationId: Experiments_DeleteTags
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: The identifier of the experiment.
          in: path
          name: experimentId
          required: true
          type: string
        - description: The requested tags list to be deleted.
          in: body
          name: tags
          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"
      summary: Delete list of Tags in an Experiment.
      tags:
        - Experiments
  "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}":
    get:
      consumes: []
      description: Get details of an Experiment with specific Experiment name.
      operationId: Experiments_Get
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: The experiment name.
          in: path
          name: experimentName
          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"
      summary: Get details of an Experiment.
      tags:
        - Experiments
    post:
      consumes: []
      description: Create a new Experiment.
      operationId: Experiments_Create
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: The experiment name.
          in: path
          name: experimentName
          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"
      summary: Create an Experiment.
      tags:
        - Experiments
  "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/batch/events":
    post:
      consumes:
        - application/json
      description: Post event data to a specific Run Id.
      operationId: Events_BatchPost
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: The experiment name.
          in: path
          name: experimentName
          required: true
          type: string
        - description: The batch of Event details.
          in: body
          name: batchEventCommand
          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"
      summary: Batch post event data.
      tags:
        - Events
  "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/batch/runs":
    patch:
      consumes:
        - application/json
      description: Add or Modify a batch of Runs for a given experiment.
      operationId: Runs_BatchAddOrModify
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: The experiment name.
          in: path
          name: experimentName
          required: true
          type: string
        - description: The list of requested Run Additions/modifications in an Experiment.
          in: body
          name: requestDto
          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"
      summary: Add or Modify a batch of Runs.
      tags:
        - Run
  "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/metrics/{metricId}":
    get:
      consumes: []
      description: Get Metric details for a specific Metric Id.
      operationId: RunMetrics_Get
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: The experiment name.
          in: path
          name: experimentName
          required: true
          type: string
        - description: The identifier for a Metric.
          format: uuid
          in: path
          name: metricId
          required: true
          type: string
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/RunMetric"
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: "#/definitions/ErrorResponse"
      summary: Get Metric details.
      tags:
        - RunMetrics
  "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/metrics:query":
    post:
      consumes:
        - application/json
      description: Get all Run Metrics for the specific Experiment with the specified query filters.
      operationId: RunMetrics_GetByQuery
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: The experiment name.
          in: path
          name: experimentName
          required: true
          type: string
        - description: Query Parameters for data sorting and filtering.
          in: body
          name: queryParams
          required: false
          schema:
            $ref: "#/definitions/QueryParams"
        - description: "The type of merge strategy. Currently supported strategies are:\r

            None - all logged values are returned as individual metrics.\r

            MergeToVector - merges multiple values into a vector of values.\r

            Default - the system determines the behavior."
          enum:
            - Default
            - None
            - MergeToVector
          in: query
          name: MergeStrategyType
          required: false
          type: string
        - description: Controls behavior of the merge strategy in certain cases; e.g. when a metric is not merged.
          enum:
            - None
            - ReportUnmergedMetricsValues
          in: query
          name: MergeStrategyOptions
          required: false
          type: string
        - description: The strategy settings version.
          in: query
          name: MergeStrategySettings.Version
          required: false
          type: string
        - description: Defines how to select metrics when merging them together.
          enum:
            - SelectAll
            - SelectByFirstValueSchema
            - SelectByFirstValueSchemaMergeNumericValues
          in: query
          name: MergeStrategySettings.SelectMetrics
          required: false
          type: string
      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"
      summary: Get all Run Metrics for the specific Experiment.
      tags:
        - RunMetrics
      x-ms-pageable:
        nextLinkName: nextLink
  "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}":
    get:
      consumes: []
      description: Get Run details of a specific Run Id.
      operationId: Runs_Get
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: The experiment name.
          in: path
          name: experimentName
          required: true
          type: string
        - description: The identifier of the Run.
          in: path
          name: runId
          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"
      summary: Get Run details.
      tags:
        - Run
    patch:
      consumes:
        - application/json
      description: Add a new Run or Modify an existing Run.
      operationId: Runs_Patch
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: The experiment name.
          in: path
          name: experimentName
          required: true
          type: string
        - description: The identifier of the Run.
          in: path
          name: runId
          pattern: ^[a-zA-Z0-9][\w-]{0,255}$
          required: true
          type: string
        - description: The requested Run parameter Additions/modifications.
          in: body
          name: createRunDto
          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"
      summary: Add or Modify a Run.
      tags:
        - Run
  "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts":
    get:
      consumes: []
      description: Get Artifacts in container for a specific Run Id.
      operationId: RunArtifacts_ListInContainer
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: The experiment name.
          in: path
          name: experimentName
          required: true
          type: string
        - description: The identifier of the Run.
          in: path
          name: runId
          required: true
          type: string
        - description: The Continuation Token.
          in: query
          name: continuationToken
          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"
      summary: Get Artifacts in a container.
      tags:
        - RunArtifacts
      x-ms-pageable:
        nextLinkName: nextLink
  "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/artifacturi":
    get:
      consumes: []
      description: Get URI of an Artifact for a specific Run Id.
      operationId: RunArtifacts_GetSasUri
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: The experiment name.
          in: path
          name: experimentName
          required: true
          type: string
        - description: The identifier of the Run.
          in: path
          name: runId
          required: true
          type: string
        - description: The Artifact Path.
          in: query
          name: 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"
      summary: Get URI of an Artifact.
      tags:
        - RunArtifacts
  "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/batch/metadata":
    post:
      consumes:
        - application/json
      description: Create a batch of empty Artifacts in a specific Run.
      operationId: RunArtifacts_BatchCreateEmptyArtifacts
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: The experiment name.
          in: path
          name: experimentName
          required: true
          type: string
        - description: The identifier of the Run.
          in: path
          name: runId
          required: true
          type: string
        - description: The list of artifact paths.
          in: body
          name: artifactPaths
          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"
      summary: Create a batch of empty Artifacts.
      tags:
        - RunArtifacts
  "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/contentinfo":
    get:
      consumes: []
      description: Get Artifact content information for give Run Id.
      operationId: RunArtifacts_GetContentInformation
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: The experiment name.
          in: path
          name: experimentName
          required: true
          type: string
        - description: The identifier of the Run.
          in: path
          name: runId
          required: true
          type: string
        - description: The Artifact Path.
          in: query
          name: 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"
      summary: Get Artifact content information.
      tags:
        - RunArtifacts
  "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/metadata":
    get:
      consumes: []
      description: Get Artifact for a specific Id.
      operationId: RunArtifacts_GetById
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: The experiment name.
          in: path
          name: experimentName
          required: true
          type: string
        - description: The identifier of the Run.
          in: path
          name: runId
          required: true
          type: string
        - description: The Artifact Path.
          in: query
          name: 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"
      summary: Get Artifact by Id.
      tags:
        - RunArtifacts
  "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/path":
    get:
      consumes: []
      description: Get Artifacts in the provided path for a specific Run Id.
      operationId: RunArtifacts_ListInPath
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: The experiment name.
          in: path
          name: experimentName
          required: true
          type: string
        - description: The identifier of the Run.
          in: path
          name: runId
          required: true
          type: string
        - description: The Artifact Path.
          in: query
          name: path
          required: false
          type: string
        - description: The Continuation Token.
          in: query
          name: continuationToken
          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"
      summary: Get Artifacts in the provided path.
      tags:
        - RunArtifacts
      x-ms-pageable:
        nextLinkName: nextLink
  "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/prefix/contentinfo":
    get:
      consumes: []
      description: Get SAS of an Artifact in the specified path.
      operationId: RunArtifacts_ListSasByPrefix
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: The experiment name.
          in: path
          name: experimentName
          required: true
          type: string
        - description: The identifier of the Run.
          in: path
          name: runId
          required: true
          type: string
        - description: The Artifact Path.
          in: query
          name: path
          required: false
          type: string
        - description: The Continuation Token.
          in: query
          name: continuationToken
          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"
      summary: Get SAS of an Artifact.
      tags:
        - RunArtifacts
      x-ms-pageable:
        nextLinkName: nextLink
  "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/batch/metrics":
    post:
      consumes:
        - application/json
      description: Post Metrics to a specific Run Id.
      operationId: RunMetrics_BatchPost
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: The experiment name.
          in: path
          name: experimentName
          required: true
          type: string
        - description: The identifier for a run.
          in: path
          name: runId
          required: true
          type: string
        - description: Details of the Metrics which will be added to the Run Id.
          in: body
          name: batchMetricDto
          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"
      summary: Post Metrics to a Run.
      tags:
        - RunMetrics
  "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/children":
    get:
      consumes: []
      description: Get details of all child runs for the specified Run Id with the specified filters.
      operationId: Runs_GetChild
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: The experiment name.
          in: path
          name: experimentName
          required: true
          type: string
        - description: The identifier of the Run.
          in: path
          name: runId
          required: true
          type: string
        - description: "Allows for filtering the collection of resources.\r

            The expression specified is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response."
          in: query
          name: $filter
          required: false
          type: string
        - description: The continuation token to use for getting the next set of resources.
          in: query
          name: $continuationtoken
          required: false
          type: string
        - collectionFormat: multi
          description: The list of resource properties to use for sorting the requested resources.
          in: query
          items:
            type: string
          name: $orderby
          required: false
          type: array
          uniqueItems: false
        - description: The sort order of the returned resources. Not used, specify asc or desc after each property name in the OrderBy parameter.
          enum:
            - Asc
            - Desc
          in: query
          name: $sortorder
          required: false
          type: string
        - description: "The maximum number of items in the resource collection to be included in the result.\r

            If not specified, all items are returned."
          format: int32
          in: query
          name: $top
          required: false
          type: integer
        - description: Whether to include a count of the matching resources along with the resources returned in the response.
          in: query
          name: $count
          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"
      summary: Get details of all child runs.
      tags:
        - Run
      x-ms-pageable:
        nextLinkName: nextLink
  "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/details":
    get:
      consumes: []
      description: Get Run Details for a specific Run Id.
      operationId: Runs_GetDetails
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: The experiment name.
          in: path
          name: experimentName
          required: true
          type: string
        - description: The identifier of the Run.
          in: path
          name: runId
          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"
      summary: Get Run Details.
      tags:
        - Run
  "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/events":
    post:
      consumes:
        - application/json
      description: Post event data to a specific Run Id.
      operationId: Events_Post
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: The experiment name.
          in: path
          name: experimentName
          required: true
          type: string
        - description: The identifier of the Run.
          in: path
          name: runId
          required: true
          type: string
        - description: The Event details.
          in: body
          name: eventMessage
          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"
      summary: Post event data.
      tags:
        - Events
  "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/metrics":
    post:
      consumes:
        - application/json
      description: Post a Metric to a specific Run Id.
      operationId: RunMetrics_Post
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: The experiment name.
          in: path
          name: experimentName
          required: true
          type: string
        - description: The identifier for a run.
          in: path
          name: runId
          required: true
          type: string
        - description: Details of the metric which will be added to the Run Id.
          in: body
          name: metricDto
          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"
      summary: Post Metric to a Run.
      tags:
        - RunMetrics
  "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/tags":
    delete:
      consumes:
        - application/json
      description: Delete list of Tags from a specific Run Id.
      operationId: Runs_DeleteTags
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: The experiment name.
          in: path
          name: experimentName
          required: true
          type: string
        - description: The identifier of the Run.
          in: path
          name: runId
          required: true
          type: string
        - description: The requested tags list to be deleted.
          in: body
          name: tags
          required: false
          schema:
            items:
              type: string
            type: array
            uniqueItems: false
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/Run"
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: "#/definitions/ErrorResponse"
      summary: Delete list of Tags in a Run.
      tags:
        - Run
  "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs:query":
    post:
      consumes:
        - application/json
      description: Get all Runs for a specific Experiment with the specified query filters.
      operationId: Runs_GetByQuery
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: The experiment name.
          in: path
          name: experimentName
          required: true
          type: string
        - description: Query parameters for data sorting and filtering.
          in: body
          name: queryParams
          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"
      summary: Get all Runs for a specific Experiment.
      tags:
        - Run
      x-ms-pageable:
        nextLinkName: nextLink
  "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments:query":
    post:
      consumes:
        - application/json
      description: Get all experiments in a specific workspace with the specified query filters.
      operationId: Experiments_GetByQuery
      parameters:
        - $ref: "#/parameters/subscriptionIdParameter"
        - $ref: "#/parameters/resourceGroupNameParameter"
        - $ref: "#/parameters/workspaceNameParameter"
        - description: Query parameters for data sorting and filtering.
          in: body
          name: queryParams
          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"
      summary: Get all Experiments in a specific workspace.
      tags:
        - Experiments
      x-ms-pageable:
        nextLinkName: nextLink
definitions:
  Artifact:
    description: Details of an Artifact.
    properties:
      artifactId:
        description: The identifier of an Artifact. Format of ArtifactId - {Origin}/{Container}/{Path}.
        type: string
      container:
        description: The name of container. Artifacts can be grouped by container.
        type: string
      createdTime:
        description: The Date and Time at which the Artifact is created. The DateTime is in UTC.
        format: date-time
        readOnly: true
        type: string
      dataPath:
        $ref: "#/definitions/DataPath"
      etag:
        description: The Etag of the Artifact.
        readOnly: true
        type: string
      origin:
        description: The origin of the Artifact creation request. Available origins are 'ExperimentRun', 'LocalUpload', 'WebUpload', 'Dataset' and 'Unknown'.
        type: string
      path:
        description: The path to the Artifact in a container.
        type: string
    required:
      - origin
      - container
      - path
    type: object
  ArtifactContentInformation:
    description: Details of an Artifact Content Information.
    properties:
      container:
        description: The name of container. Artifacts can be grouped by container.
        type: string
      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
      path:
        description: The path to the Artifact in a container.
        type: string
    type: object
  ArtifactPath:
    description: Details of an Artifact Path.
    properties:
      path:
        description: The path to the Artifact in a container.
        type: string
    required:
      - path
    type: object
  ArtifactPathList:
    description: Contains list of Artifact Paths.
    properties:
      paths:
        description: List of Artifact Paths.
        items:
          $ref: "#/definitions/ArtifactPath"
        type: array
        uniqueItems: false
    required:
      - paths
    type: object
  BaseEvent:
    description: Base event is the envelope used to post event data to the Event controller
    properties:
      data:
        type: object
      name:
        type: string
      timestamp:
        format: date-time
        type: string
    type: object
  BatchAddOrModifyRunRequest:
    properties:
      runs:
        items:
          $ref: "#/definitions/CreateRun"
        type: array
        uniqueItems: false
    type: object
  BatchAddOrModifyRunResult:
    properties:
      errors:
        additionalProperties:
          $ref: "#/definitions/ErrorResponse"
        type: object
      runs:
        additionalProperties:
          $ref: "#/definitions/Run"
        type: object
    type: object
  BatchArtifactContentInformationResult:
    description: Results of the Batch Artifact Content Information request.
    properties:
      artifactContentInformation:
        additionalProperties:
          $ref: "#/definitions/ArtifactContentInformation"
        description: Artifact Content Information details of the Artifact Ids requested.
        type: object
      artifacts:
        additionalProperties:
          $ref: "#/definitions/Artifact"
        description: Artifact details of the Artifact Ids requested.
        type: object
      errors:
        additionalProperties:
          $ref: "#/definitions/ErrorResponse"
        description: Errors occurred while fetching the requested Artifact Ids.
        type: object
    type: object
  BatchEventCommand:
    properties:
      events:
        items:
          $ref: "#/definitions/BaseEvent"
        type: array
        uniqueItems: false
    type: object
  BatchEventCommandResult:
    properties:
      errors:
        items:
          $ref: "#/definitions/KeyValuePairBaseEventErrorResponse"
        type: array
        uniqueItems: false
    type: object
  BatchMetric:
    properties:
      values:
        items:
          $ref: "#/definitions/Metric"
        type: array
        uniqueItems: false
    type: object
  CreateRun:
    properties:
      cancelUri:
        type: string
      createdFrom:
        $ref: "#/definitions/CreatedFrom"
      dataContainerId:
        type: string
      description:
        type: string
      diagnosticsUri:
        type: string
      endTimeUtc:
        description: The end time of the run in UTC.
        format: date-time
        type: string
      heartbeatEnabled:
        type: boolean
      hidden:
        type: boolean
      name:
        type: string
      options:
        $ref: "#/definitions/RunOptions"
      parentRunId:
        description: The parent of the run if the run is hierarchical; otherwise, Null.
        type: string
      properties:
        additionalProperties:
          type: string
        type: object
      runDefinition:
        type: object
      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
      runType:
        type: string
      scriptName:
        type: string
      startTimeUtc:
        description: The start time of the run in UTC.
        format: date-time
        type: string
      status:
        description: The status of the run. The Status string value maps to the RunStatus Enum.
        type: string
      tags:
        additionalProperties:
          type: string
        type: object
      target:
        type: string
    type: object
  CreatedBy:
    properties:
      userName:
        description: "A user's full name or a service principal's app ID.\r

          This is PII and should never be logged."
        type: string
      userObjectId:
        description: "A user or service principal's object ID.\r

          This is PII and should never be logged."
        type: string
      userTenantId:
        description: A user or service principal's tenant ID.
        type: string
    type: object
  CreatedFrom:
    properties:
      location:
        type: string
      locationType:
        enum:
          - ArtifactId
        type: string
        x-ms-enum:
          modelAsString: false
          name: CreatedFromLocationType
      type:
        enum:
          - Notebook
        type: string
        x-ms-enum:
          modelAsString: false
          name: CreatedFromType
    type: object
  DataPath:
    properties:
      dataStoreName:
        type: string
      relativePath:
        type: string
      sqlDataPath:
        $ref: "#/definitions/SqlDataPath"
    type: object
  DeleteTagsCommand:
    properties:
      tags:
        items:
          type: string
        type: array
        uniqueItems: false
    type: object
  ErrorDetails:
    description: The error details.
    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
    type: object
  ErrorResponse:
    description: The error response.
    properties:
      correlation:
        additionalProperties:
          type: string
        description: Dictionary containing correlation details for the error.
        type: object
      environment:
        description: The hosting environment.
        type: string
      error:
        $ref: "#/definitions/RootError"
        description: The top level error that occurred.
      location:
        description: The Azure region.
        type: string
      time:
        description: The time in UTC.
        format: date-time
        type: string
    type: object
  Experiment:
    properties:
      archivedTime:
        format: date-time
        type: string
      createdUtc:
        format: date-time
        type: string
      description:
        type: string
      experimentId:
        type: string
      latestCreatedRunCreatedUtc:
        format: date-time
        type: string
      latestCreatedRunId:
        type: string
      name:
        type: string
      tags:
        additionalProperties:
          type: string
        type: object
    type: object
  InnerErrorResponse:
    description: A nested structure of errors.
    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.
    type: object
  KeyValuePairBaseEventErrorResponse:
    properties:
      key:
        $ref: "#/definitions/BaseEvent"
        readOnly: true
      value:
        $ref: "#/definitions/ErrorResponse"
        readOnly: true
    type: object
  Metric:
    properties:
      cells:
        items:
          additionalProperties:
            type: object
          type: object
        type: array
        uniqueItems: false
      createdUtc:
        format: date-time
        type: string
      dataContainerId:
        type: string
      dataLocation:
        type: string
      description:
        type: string
      label:
        type: string
      metricId:
        format: uuid
        type: string
      metricType:
        type: string
      name:
        type: string
      numCells:
        format: int32
        type: integer
      schema:
        $ref: "#/definitions/MetricSchema"
    type: object
  MetricSchema:
    properties:
      numProperties:
        format: int32
        type: integer
      properties:
        items:
          $ref: "#/definitions/MetricSchemaProperty"
        type: array
        uniqueItems: false
    type: object
  MetricSchemaProperty:
    properties:
      name:
        type: string
      propertyId:
        type: string
      type:
        type: string
    type: object
  ModifyExperiment:
    properties:
      archive:
        type: boolean
      description:
        type: string
      tags:
        additionalProperties:
          type: string
        type: object
    type: object
  PaginatedArtifactContentInformationList:
    description: A paginated list of ArtifactContentInformations.
    properties:
      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
      value:
        description: An array of objects of type ArtifactContentInformation.
        items:
          $ref: "#/definitions/ArtifactContentInformation"
        type: array
        uniqueItems: false
    type: object
  PaginatedArtifactList:
    description: A paginated list of Artifacts.
    properties:
      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
      value:
        description: An array of objects of type Artifact.
        items:
          $ref: "#/definitions/Artifact"
        type: array
        uniqueItems: false
    type: object
  PaginatedExperimentList:
    description: A paginated list of Experiments.
    properties:
      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
      value:
        description: An array of objects of type Experiment.
        items:
          $ref: "#/definitions/Experiment"
        type: array
        uniqueItems: false
    type: object
  PaginatedRunList:
    description: A paginated list of Runs.
    properties:
      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
      value:
        description: An array of objects of type Run.
        items:
          $ref: "#/definitions/Run"
        type: array
        uniqueItems: false
    type: object
  PaginatedRunMetricList:
    description: A paginated list of RunMetrics.
    properties:
      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
      value:
        description: An array of objects of type RunMetric.
        items:
          $ref: "#/definitions/RunMetric"
        type: array
        uniqueItems: false
    type: object
  QueryParams:
    description: The set of supported filters.
    properties:
      continuationToken:
        description: The continuation token to use for getting the next set of resources.
        type: string
      filter:
        description: "Allows for filtering the collection of resources.\r

          The 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

          See https://docs.microsoft.com/en-us/azure/search/query-odata-filter-orderby-syntax for details on the expression syntax."
        type: string
      orderBy:
        description: "The comma separated list of resource properties to use for sorting the requested resources.\r

          Optionally, can be followed by either 'asc' or 'desc'"
        example: Color, Size desc
        type: string
      top:
        description: "The maximum number of items in the resource collection to be included in the result.\r

          If not specified, all items are returned."
        format: int32
        type: integer
    type: object
  RootError:
    description: The root error.
    properties:
      code:
        description: "The service-defined error code. Supported error codes: ServiceError, UserError, ValidationError, AzureStorageError, TransientError, RequestThrottled."
        type: string
      details:
        description: The related errors that occurred during the request.
        items:
          $ref: "#/definitions/ErrorDetails"
        type: array
        uniqueItems: false
      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.
      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
    type: object
  Run:
    description: The definition of a Run.
    properties:
      cancelUri:
        type: string
      createdBy:
        $ref: "#/definitions/CreatedBy"
        description: The details of the user who created the run.
      createdFrom:
        $ref: "#/definitions/CreatedFrom"
      createdUtc:
        description: The time the run was created in UTC.
        format: date-time
        type: string
      dataContainerId:
        type: string
      description:
        type: string
      diagnosticsUri:
        type: string
      endTimeUtc:
        description: The end time of the run in UTC.
        format: date-time
        type: string
      error:
        $ref: "#/definitions/ErrorResponse"
        description: If an error occurred during the run, this will be populated.
      experimentId:
        description: The Id of the experiment that created this run.
        type: string
      heartbeatEnabled:
        type: boolean
      hidden:
        type: boolean
      name:
        type: string
      options:
        $ref: "#/definitions/RunOptions"
      parentRunId:
        description: The parent of the run if the run is hierarchical; otherwise, Null.
        type: string
      properties:
        additionalProperties:
          type: string
        type: object
      revision:
        format: int32
        type: integer
      rootRunId:
        type: string
      runDefinition:
        type: object
      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
      runNumber:
        format: int32
        type: integer
      runType:
        type: string
      scriptName:
        type: string
      startTimeUtc:
        description: The start time of the run in UTC.
        format: date-time
        type: string
      status:
        description: The status of the run. The Status string value maps to the RunStatus Enum.
        type: string
      tags:
        additionalProperties:
          type: string
        type: object
      target:
        type: string
      token:
        description: A token used for authenticating a run.
        type: string
      tokenExpiryTimeUtc:
        description: The Token expiration time in UTC.
        format: date-time
        type: string
      userId:
        description: The Id of the user that created the run.
        type: string
      warnings:
        description: A list of warnings that occurred during the run.
        items:
          $ref: "#/definitions/RunDetailsWarning"
        type: array
        uniqueItems: false
    type: object
  RunDetails:
    description: The details of the run.
    properties:
      endTimeUtc:
        description: The end time of the run in UTC.
        format: date-time
        type: string
      error:
        $ref: "#/definitions/ErrorResponse"
        description: If an error occurred during the run, this will be populated.
      logFiles:
        additionalProperties:
          type: string
        type: object
      parentRunId:
        description: The parent of the run if the run is hierarchical.
        type: string
      properties:
        additionalProperties:
          type: string
        description: The properties dictionary for the run. Properties are immutable.
        type: object
      revision:
        format: int32
        type: integer
      runDefinition:
        description: The run definition specification.
        type: object
      runId:
        description: The identifier for the run.
        type: string
      startTimeUtc:
        description: The start time of the run in UTC.
        format: date-time
        type: string
      status:
        description: The status of the run. The Status string value maps to the RunStatus Enum.
        type: string
      tags:
        additionalProperties:
          type: string
        description: The tag dictionary for the run. Tags are mutable.
        type: object
      target:
        description: The name of the compute target where the run is executed.
        type: string
      warnings:
        description: A list of warnings that occurred during the run.
        items:
          $ref: "#/definitions/RunDetailsWarning"
        type: array
        uniqueItems: false
    type: object
  RunDetailsWarning:
    properties:
      message:
        type: string
      source:
        type: string
    type: object
  RunMetric:
    properties:
      cells:
        items:
          additionalProperties:
            type: object
          type: object
        type: array
        uniqueItems: false
      createdUtc:
        format: date-time
        type: string
      dataContainerId:
        type: string
      dataLocation:
        type: string
      description:
        type: string
      label:
        type: string
      metricId:
        format: uuid
        type: string
      metricType:
        type: string
      name:
        type: string
      numCells:
        format: int32
        type: integer
      runId:
        type: string
      schema:
        $ref: "#/definitions/MetricSchema"
    type: object
  RunOptions:
    properties:
      generateDataContainerIdIfNotSpecified:
        type: boolean
    type: object
  SqlDataPath:
    properties:
      sqlQuery:
        type: string
      sqlStoredProcedureName:
        type: string
      sqlStoredProcedureParams:
        items:
          $ref: "#/definitions/StoredProcedureParameter"
        type: array
        uniqueItems: false
      sqlTableName:
        type: string
    type: object
  StoredProcedureParameter:
    properties:
      name:
        type: string
      type:
        enum:
          - String
          - Int
          - Decimal
          - Guid
          - Boolean
          - Date
        type: string
        x-ms-enum:
          modelAsString: false
          name: StoredProcedureParameterType
      value:
        type: string
    type: object
