openapi: 3.2.0
info:
  title: Microsoft Azure Workflow Runs API
  version: '1.0'
  description: 'Operations tagged WorkflowRuns across 3 of this provider''s published API definitions: logicmanagementclient-openapi-original.yml, purview-workflow-service-openapi-original.yml, webapps-api-client-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
- url: https://purview.azure.com/workflow
tags:
- name: Workflow Runs
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs:
    get:
      tags:
      - Workflow Runs
      operationId: microsoftAzureWorkflowrunsList
      description: Gets a list of workflow runs.
      x-ms-examples:
        List workflow runs:
          $ref: ./examples/WorkflowRuns_List.json
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        schema:
          type: string
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      - name: $top
        description: The number of items to be included in the result.
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: $filter
        description: 'The filter to apply on the operation. Options for filters include: Status, StartTime, and ClientTrackingId.'
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowRunListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-odata: '#/definitions/WorkflowRunFilter'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
      security:
      - azure_auth:
        - user_impersonation
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}
  : get:
      tags:
      - Workflow Runs
      operationId: microsoftAzureWorkflowrunsGet
      description: Gets a workflow run.
      x-ms-examples:
        Get a run for a workflow:
          $ref: ./examples/WorkflowRuns_Get.json
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        schema:
          type: string
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        schema:
          type: string
      - name: runName
        description: The workflow run name.
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowRun'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
      security:
      - azure_auth:
        - user_impersonation
    delete:
      tags:
      - Workflow Runs
      operationId: microsoftAzureWorkflowrunsDelete
      description: Deletes a workflow run.
      x-ms-examples:
        Delete a run for a workflow:
          $ref: ./examples/WorkflowRuns_Delete.json
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        schema:
          type: string
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        schema:
          type: string
      - name: runName
        description: The workflow run name.
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
      security:
      - azure_auth:
        - user_impersonation
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/cancel
  : post:
      tags:
      - Workflow Runs
      operationId: microsoftAzureWorkflowrunsCancel
      description: Cancels a workflow run.
      x-ms-examples:
        Cancel a workflow run:
          $ref: ./examples/WorkflowRuns_Cancel.json
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        schema:
          type: string
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        schema:
          type: string
      - name: runName
        description: The workflow run name.
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups…
      security:
      - azure_auth:
        - user_impersonation
    servers:
    - url: https://management.azure.com
  /workflowruns:
    get:
      tags:
      - Workflow Runs
      description: List workflow runs.
      operationId: microsoftAzureListworkflowruns
      x-ms-examples:
        WorkflowRuns_List:
          $ref: ./examples/ListWorkflowRuns.json
      x-ms-pageable:
        nextLinkName: nextLink
      parameters:
      - $ref: '#/components/parameters/api-version_2'
      - $ref: '#/components/parameters/timeWindow'
      - name: orderby
        in: query
        required: false
        x-ms-enum:
          name: orderby
          modelAsString: true
        description: The key word which used to sort the results.
        x-ms-parameter-location: method
        schema:
          type: string
          enum:
          - status desc
          - status asc
          - requestor desc
          - requestor asc
          - startTime desc
          - startTime asc
      - $ref: '#/components/parameters/runStatuses'
      - $ref: '#/components/parameters/workflowIds'
      - $ref: '#/components/parameters/maxpagesize'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowRunList'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Microsoft Azure Get Workflowruns
      security:
      - azure_auth:
        - https://purview.azure.net/.default
    servers:
    - url: https://purview.azure.com/workflow
  /workflowruns/{workflowRunId}:
    get:
      tags:
      - Workflow Runs
      description: Get a workflow run.
      operationId: microsoftAzureGetworkflowrun
      x-ms-examples:
        WorkflowRun_Get:
          $ref: ./examples/GetWorkflowRun.json
      parameters:
      - $ref: '#/components/parameters/api-version_2'
      - $ref: '#/components/parameters/workflowRunId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowRun_2'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Microsoft Azure Get Workflowruns Workflowrunid
      security:
      - azure_auth:
        - https://purview.azure.net/.default
    servers:
    - url: https://purview.azure.com/workflow
  /workflowruns/{workflowRunId}/cancel:
    post:
      tags:
      - Workflow Runs
      description: Cancel a workflow run.
      operationId: microsoftAzureCancelworkflowrun
      x-ms-examples:
        WorkflowRun_Cancel:
          $ref: ./examples/CancelWorkflowRun.json
      parameters:
      - $ref: '#/components/parameters/api-version_2'
      - $ref: '#/components/parameters/workflowRunId'
      responses:
        '200':
          description: OK
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Microsoft Azure Post Workflowruns Workflowrunid Cancel
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowRunCancelRequest'
        description: Reply of canceling a workflow run.
        required: true
      security:
      - azure_auth:
        - https://purview.azure.net/.default
    servers:
    - url: https://purview.azure.com/workflow
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs
  : get:
      tags:
      - Workflow Runs
      operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftWebSitesByNameHostruntimeRuntimeWebhooksWorkflowApiManagementWorkflowsByWorkflowNameRuns
      description: Gets a list of workflow runs.
      x-ms-examples:
        List workflow runs:
          $ref: ./examples/WorkflowRuns_List.json
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/siteNameParameter'
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/apiVersionParameter'
      - name: $top
        description: The number of items to be included in the result.
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: $filter
        description: 'The filter to apply on the operation. Options for filters include: Status, StartTime, and ClientTrackingId.'
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowRunListResult'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-odata: '#/definitions/WorkflowRunFilter'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
      security:
      - azure_auth:
        - user_impersonation
      x-operation-id-source: normalized
      x-operation-id-original: microsoftAzureWorkflowrunsList
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}
  : get:
      tags:
      - Workflow Runs
      operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftWebSitesByNameHostruntimeRuntimeWebhooksWorkflowApiManagementWorkflowsByWorkflowNameRunsByRunName
      description: Gets a workflow run.
      x-ms-examples:
        Get a run for a workflow:
          $ref: ./examples/WorkflowRuns_Get.json
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/siteNameParameter'
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        schema:
          type: string
      - name: runName
        description: The workflow run name.
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowRun'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
      security:
      - azure_auth:
        - user_impersonation
      x-operation-id-source: normalized
      x-operation-id-original: microsoftAzureWorkflowrunsGet
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/cancel
  : post:
      tags:
      - Workflow Runs
      operationId: postSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftWebSitesByNameHostruntimeRuntimeWebhooksWorkflowApiManagementWorkflowsByWorkflowNameRunsByRunNameCancel
      description: Cancels a workflow run.
      x-ms-examples:
        Cancel a workflow run:
          $ref: ./examples/WorkflowRuns_Cancel.json
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/siteNameParameter'
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        schema:
          type: string
      - name: runName
        description: The workflow run name.
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups…
      security:
      - azure_auth:
        - user_impersonation
      x-operation-id-source: normalized
      x-operation-id-original: microsoftAzureWorkflowrunsCancel
    servers:
    - url: https://management.azure.com
components:
  schemas:
    WorkflowRun:
      type: object
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/WorkflowRunProperties'
          description: The workflow run properties.
        name:
          type: string
          readOnly: true
          description: Gets the workflow run name.
        type:
          type: string
          readOnly: true
          description: Gets the workflow run type.
      description: The workflow run.
      allOf:
      - $ref: '#/components/schemas/SubResource'
    Correlation:
      type: object
      properties:
        clientTrackingId:
          type: string
          description: The client tracking id.
      description: The correlation property.
    WorkflowRunProperties:
      type: object
      properties:
        waitEndTime:
          type: string
          format: date-time
          readOnly: true
          description: Gets the wait end time.
        startTime:
          type: string
          format: date-time
          readOnly: true
          description: Gets the start time.
        endTime:
          type: string
          format: date-time
          readOnly: true
          description: Gets the end time.
        status:
          $ref: '#/components/schemas/WorkflowStatus'
          readOnly: true
          description: Gets the status.
        code:
          type: string
          readOnly: true
          description: Gets the code.
        error:
          $ref: '#/components/schemas/Object'
          readOnly: true
          description: Gets the error.
        correlationId:
          type: string
          readOnly: true
          description: Gets the correlation id.
        correlation:
          $ref: '#/components/schemas/Correlation'
          description: The run correlation.
        workflow:
          $ref: '#/components/schemas/ResourceReference'
          readOnly: true
          description: Gets the reference to workflow version.
        trigger:
          $ref: '#/components/schemas/WorkflowRunTrigger'
          readOnly: true
          description: Gets the fired trigger.
        outputs:
          type: object
          readOnly: true
          additionalProperties:
            $ref: '#/components/schemas/WorkflowOutputParameter'
          description: Gets the outputs.
        response:
          $ref: '#/components/schemas/WorkflowRunTrigger'
          readOnly: true
          description: Gets the response of the flow run.
      description: The workflow run properties.
    Object:
      type: object
      properties: {}
    SubResource:
      properties:
        id:
          type: string
          readOnly: true
          description: The resource id.
      x-ms-azure-resource: true
      description: The sub resource type.
    ContentHash:
      type: object
      properties:
        algorithm:
          type: string
          description: The algorithm of the content hash.
        value:
          type: string
          description: The value of the content hash.
      description: The content hash.
    WorkflowOutputParameter:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/Object'
          readOnly: true
          description: Gets the error.
      description: The workflow output parameter.
      allOf:
      - $ref: '#/components/schemas/WorkflowParameter'
    ContentLink:
      type: object
      properties:
        uri:
          type: string
          description: The content link URI.
        contentVersion:
          type: string
          description: The content version.
        contentSize:
          type: integer
          format: int64
          description: The content size.
        contentHash:
          $ref: '#/components/schemas/ContentHash'
          description: The content hash.
        metadata:
          $ref: '#/components/schemas/Object'
          description: The metadata.
      description: The content link.
    WorkflowStatus:
      type: string
      enum:
      - NotSpecified
      - Paused
      - Running
      - Waiting
      - Succeeded
      - Skipped
      - Suspended
      - Cancelled
      - Failed
      - Faulted
      - TimedOut
      - Aborted
      - Ignored
      x-ms-enum:
        name: WorkflowStatus
        modelAsString: true
    WorkflowRunTrigger:
      type: object
      properties:
        name:
          type: string
          readOnly: true
          description: Gets the name.
        inputs:
          $ref: '#/components/schemas/Object'
          readOnly: true
          description: Gets the inputs.
        inputsLink:
          $ref: '#/components/schemas/ContentLink'
          readOnly: true
          description: Gets the link to inputs.
        outputs:
          $ref: '#/components/schemas/Object'
          readOnly: true
          description: Gets the outputs.
        outputsLink:
          $ref: '#/components/schemas/ContentLink'
          readOnly: true
          description: Gets the link to outputs.
        scheduledTime:
          type: string
          format: date-time
          readOnly: true
          description: Gets the scheduled time.
        startTime:
          type: string
          format: date-time
          readOnly: true
          description: Gets the start time.
        endTime:
          type: string
          format: date-time
          readOnly: true
          description: Gets the end time.
        trackingId:
          type: string
          readOnly: true
          description: Gets the tracking id.
        correlation:
          $ref: '#/components/schemas/Correlation'
          description: The run correlation.
        code:
          type: string
          readOnly: true
          description: Gets the code.
        status:
          $ref: '#/components/schemas/WorkflowStatus'
          readOnly: true
          description: Gets the status.
        error:
          $ref: '#/components/schemas/Object'
          readOnly: true
          description: Gets the error.
        trackedProperties:
          $ref: '#/components/schemas/Object'
          readOnly: true
          description: Gets the tracked properties.
      description: The workflow run trigger.
    WorkflowParameter:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ParameterType'
          description: The type.
        value:
          $ref: '#/components/schemas/Object'
          description: The value.
        metadata:
          $ref: '#/components/schemas/Object'
          description: The metadata.
        description:
          type: string
          description: The description.
      description: The workflow parameters.
    ParameterType:
      type: string
      enum:
      - NotSpecified
      - String
      - SecureString
      - Int
      - Float
      - Bool
      - Array
      - Object
      - SecureObject
      x-ms-enum:
        name: ParameterType
        modelAsString: true
    ResourceReference:
      type: object
      properties:
        id:
          type: string
          description: The resource id.
        name:
          type: string
          readOnly: true
          description: Gets the resource name.
        type:
          type: string
          readOnly: true
          description: Gets the resource type.
      description: The resource reference.
    WorkflowRunListResult:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowRun'
          description: A list of workflow runs.
        nextLink:
          type: string
          description: The URL to get the next set of results.
      description: The list of workflow runs.
    WorkflowRun_2:
      description: 'The execution of a workflow. It includes workflow action DAG at run time (action DAG snapshot), run payload, status of the entire run and other properties of a run. '
      type: object
      properties:
        id:
          $ref: '#/components/schemas/WorkflowRunId'
        workflowId:
          $ref: '#/components/schemas/WorkflowId'
        startTime:
          type: string
          description: Workflow run start time.
          format: date-time
        requestor:
          $ref: '#/components/schemas/RequestorId'
        userRequestId:
          type: string
          format: uuid
          description: The user request id.
        runPayload:
          type: object
          description: 'The input of a workflow run. Align with operation in user request. '
          properties:
            type:
              $ref: '#/components/schemas/WorkflowRunPayloadType'
            targetValue:
              type: string
              description: The target value which need involve workflow to update.
            payload:
              type: object
              description: The payload of each operation which user want to submit.
          required:
          - type
          - targetValue
          - payload
        status:
          $ref: '#/components/schemas/Status'
        endTime:
          type: string
          format: date-time
          description: The time of workflow run completed.
        cancelTime:
          type: string
          format: date-time
          description: The time of workflow run be canceled.
        cancelComment:
          type: string
          description: The comment when cancel a workflow run.
        actionDag:
          type: object
          description: The action DAG(Directed Acyclic Graph), it defines actual flow.
        detail:
          $ref: '#/components/schemas/WorkflowRunDetail'
      required:
      - actionDag
      - detail
    WorkflowRunMetadata:
      description: 'The execution of a workflow. It includes status of the entire run and other properties of a run. '
      type: object
      properties:
        id:
          $ref: '#/components/schemas/WorkflowRunId'
        workflowId:
          $ref: '#/components/schemas/WorkflowId'
        startTime:
          type: string
          description: Workflow run start time.
          format: date-time
        requestor:
          $ref: '#/components/schemas/RequestorId'
        userRequestId:
          type: string
          format: uuid
          description: The user request id.
        runPayload:
          $ref: '#/components/schemas/WorkflowRunPayload'
        status:
          $ref: '#/components/schemas/Status'
        endTime:
          type: string
          format: date-time
          description: The time of workflow run completed.
        cancelTime:
          type: string
          format: date-time
          description: The time of workflow run be canceled.
        cancelComment:
          type: string
          description: The comment when cancel a workflow run.
      required:
      - id
      - workflowId
      - startTime
      - requestor
      - runPayload
      - status
    ErrorModel:
      description: Default error model
      type: object
      properties:
        code:
          description: Gets or sets the code.
          type: string
        details:
          description: Gets or sets the details.
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/ErrorModel'
          x-ms-identifiers:
          - code
        message:
          description: Gets or sets the messages.
          type: string
        target:
          description: Gets or sets the target.
          type: string
      required:
      - code
      - message
    WorkflowRunCancelRequest:
      type: object
      properties:
        comment:
          type: string
          description: The comment of canceling a workflow run.
    WorkflowRunPayloadType:
      type: string
      description: The workflow run payload type.
      enum:
      - CreateTerm
      - UpdateTerm
      - DeleteTerm
      - ImportTerms
      - UpdateAsset
      - GrantDataAccess
      x-ms-enum:
        name: WorkflowRunPayloadType
        modelAsString: true
    Status:
      type: string
      description: The status.
      enum:
      - NotStarted
      - InProgress
      - Failed
      - Completed
      - Canceling
      - CancellationFailed
      - Canceled
      x-ms-enum:
        name: UserRequestStatus
        modelAsString: true
    RequestorId:
      type: string
      format: uuid
      description: The person who submitted the user request.
    WorkflowRunId:
      type: string
      format: uuid
      description: The workflow run id.
    WorkflowId:
      type: string
      format: uuid
      description: The workflow id.
    ErrorResponse:
      description: Default error response model
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorModel'
      required:
      - error
    WorkflowRunDetail:
      type: object
      description: It refers to the "detail" property of a workflow run object, which contains run context and runtime information of actions.
      properties:
        runInput:
          description: 'Built-in variables starts with @runInput. Its properties are determined by trigger type at workflow run time. '
          type: object
        actions:
          type: object
      required:
      - runInput
      - actions
    WorkflowRunList:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowRunMetadata'
          description: The value of workflow run list.
        nextLink:
          type: string
          description: The URL to get the next set of results.
      required:
      - value
    WorkflowRunPayload:
      type: object
      description: 'The input of a workflow run. Align with operation in user request. '
      properties:
        type:
          $ref: '#/components/schemas/WorkflowRunPayloadType'
        targetValue:
          type: string
          description: The target value which need involve workflow to update.
      required:
      - type
      - targetValue
    WorkflowRunProperties_2:
      type: object
      properties:
        waitEndTime:
          type: string
          format: date-time
          readOnly: true
          description: Gets the wait end time.
        startTime:
          type: string
          format: date-time
          readOnly: true
          description: Gets the start time.
        endTime:
          type: string
          format: date-time
          readOnly: true
          description: Gets the end time.
        status:
          $ref: '#/components/schemas/WorkflowStatus_2'
          readOnly: true
          description: Gets the status.
        code:
          type: string
          readOnly: true
          description: Gets the code.
        error:
          $ref: '#/components/schemas/Object'
          readOnly: true
          description: Gets the error.
        correlationId:
          type: string
          readOnly: true
          description: Gets the correlation id.
        correlation:
          $ref: '#/components/schemas/Correlation'
          description: The run correlation.
        workflow:
          $ref: '#/components/schemas/ResourceReference'
          readOnly: true
          description: Gets the reference to workflow version.
        trigger:
          $ref: '#/components/schemas/WorkflowRunTrigger'
          readOnly: true
          description: Gets the fired trigger.
        outputs:
          type: object
          readOnly: true
          additionalProperties:
            $ref: '#/components/schemas/WorkflowOutputParameter'
            description: The workflow output parameter.
          description: Gets the outputs.
        response:
          $ref: '#/components/schemas/WorkflowRunTrigger'
          readOnly: true
          description: Gets the response of the flow run.
      description: The workflow run properties.
    ErrorProperties:
      description: Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message.
      type: object
      properties:
        code:
          description: Error code.
          type: string
        message:
          description: Error message indicating why the operation failed.
          type: string
    SubResource_2:
      type: object
      properties:
        id:
          type: string
          readOnly: true
          description: The resource id.
      x-ms-azure-resource: true
      description: The sub resource type.
    ContentLink_2:
      type: object
      properties:
        uri:
          type: string
          description: The content link URI.
        contentVersion:
          type: string
          description: The content version.
          readOnly: true
        contentSize:
          type: integer
          format: int64
          description: The content size.
          readOnly: true
        contentHash:
          $ref: '#/components/schemas/ContentHash'
          description: The content hash.
          readOnly: true
        metadata:
          $ref: '#/components/schemas/Object'
          description: The metadata.
          readOnly: true
      description: The content link.
    ErrorResponse_2:
      description: Error response indicates Logic service is not able to process the incoming request. The error property contains the error details.
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorProperties'
          description: The error properties.
    WorkflowStatus_2:
      type: string
      description: The workflow status.
      enum:
      - NotSpecified
      - Paused
      - Running
      - Waiting
      - Succeeded
      - Skipped
      - Suspended
      - Cancelled
      - Failed
      - Faulted
      - TimedOut
      - Aborted
      - Ignored
      x-ms-enum:
        name: WorkflowStatus
        modelAsString: true
    ParameterType_2:
      type: string
      description: The parameter type.
      enum:
      - NotSpecified
      - String
      - SecureString
      - Int
      - Float
      - Bool
      - Array
      - Object
      - SecureObject
      x-ms-enum:
        name: ParameterType
        modelAsString: true
  parameters:
    api-version:
      name: api-version
      description: The API version.
      in: query
      required: true
      schema:
        type: string
    subscriptionId:
      name: subscriptionId
      description: The subscription id.
      in: path
      required: true
      schema:
        type: string
    workflowIds:
      name: workflowIds
      in: query
      required: false
      description: Filter items by workflow id list.
      x-ms-parameter-location: method
      schema:
        type: array
        items:
          type: string
    workflowRunId:
      name: workflowRunId
      in: path
      required: true
      description: The workflow run id.
      x-ms-parameter-location: method
      schema:
        type: string
        format: uuid
    api-version_2:
      name: api-version
      description: Version of Purview APIs
      in: query
      required: true
      x-ms-parameter-location: client
      schema:
        type: string
    maxpagesize:
      name: maxpagesize
      in: query
      required: false
      description: The maximum page size to get the items at one time.
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
    timeWindow:
      name: timeWindow
      in: query
      required: false
      x-ms-enum:
        name: TimeWindow
        modelAsString: true
      description: Time window of filtering items.
      x-ms-parameter-location: method
      schema:
        type: string
        enum:
        - 1d
        - 7d
        - 30d
        - 90d
    runStatuses:
      name: runStatuses
      in: query
      required: false
      description: Filter workflow runs by workflow run status.
      x-ms-parameter-location: method
      schema:
        type: array
        items:
          type: string
          enum:
          - InProgress
          - Failed
          - Completed
          - NotStarted
          - Canceling
          - CancellationFailed
          - Canceled
          x-ms-enum:
            name: status
            modelAsString: true
    resourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: Name of the resource group to which the resource belongs.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
        pattern: ^[-\w\._\(\)]+[^\.]$
    siteNameParameter:
      name: name
      in: path
      description: Site name.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    apiVersionParameter:
      name: api-version
      in: query
      description: API Version
      required: true
      x-ms-parameter-location: client
      schema:
        type: string
    subscriptionIdParameter:
      name: subscriptionId
      in: path
      description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
      required: true
      x-ms-parameter-location: client
      schema:
        type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.
x-refined-from:
- logicmanagementclient-openapi-original.yml
- purview-workflow-service-openapi-original.yml
- webapps-api-client-openapi-original.yml
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'