swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector WorkflowRuns API
schemes:
- https
tags:
- name: WorkflowRuns
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs:
    get:
      tags:
      - WorkflowRuns
      operationId: microsoftAzureWorkflowrunsList
      description: Gets a list of workflow runs.
      x-ms-examples:
        List workflow runs:
          $ref: ./examples/WorkflowRuns_List.json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        type: string
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      - name: $top
        description: The number of items to be included in the result.
        in: query
        required: false
        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
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/WorkflowRunListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-odata: '#/definitions/WorkflowRunFilter'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Workflows Workflowname Runs
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}
  : get:
      tags:
      - WorkflowRuns
      operationId: microsoftAzureWorkflowrunsGet
      description: Gets a workflow run.
      x-ms-examples:
        Get a run for a workflow:
          $ref: ./examples/WorkflowRuns_Get.json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        type: string
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        type: string
      - name: runName
        description: The workflow run name.
        in: path
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/WorkflowRun'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Workflows Workflowname Runs Runname
    delete:
      tags:
      - WorkflowRuns
      operationId: microsoftAzureWorkflowrunsDelete
      description: Deletes a workflow run.
      x-ms-examples:
        Delete a run for a workflow:
          $ref: ./examples/WorkflowRuns_Delete.json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        type: string
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        type: string
      - name: runName
        description: The workflow run name.
        in: path
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Workflows Workflowname Runs Runname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/cancel
  : post:
      tags:
      - WorkflowRuns
      operationId: microsoftAzureWorkflowrunsCancel
      description: Cancels a workflow run.
      x-ms-examples:
        Cancel a workflow run:
          $ref: ./examples/WorkflowRuns_Cancel.json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        type: string
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        type: string
      - name: runName
        description: The workflow run name.
        in: path
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Workflows Workflowname Runs Runname Cancel
  /workflowruns:
    get:
      tags:
      - WorkflowRuns
      description: List workflow runs.
      operationId: microsoftAzureListworkflowruns
      x-ms-examples:
        WorkflowRuns_List:
          $ref: ./examples/ListWorkflowRuns.json
      x-ms-pageable:
        nextLinkName: nextLink
      parameters:
      - $ref: '#/parameters/api-version_2'
      - $ref: '#/parameters/timeWindow'
      - name: orderby
        in: query
        required: false
        type: string
        enum:
        - status desc
        - status asc
        - requestor desc
        - requestor asc
        - startTime desc
        - startTime asc
        x-ms-enum:
          name: orderby
          modelAsString: true
        description: The key word which used to sort the results.
        x-ms-parameter-location: method
      - $ref: '#/parameters/runStatuses'
      - $ref: '#/parameters/workflowIds'
      - $ref: '#/parameters/maxpagesize'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/WorkflowRunList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Workflowruns
  /workflowruns/{workflowRunId}:
    get:
      tags:
      - WorkflowRuns
      description: Get a workflow run.
      operationId: microsoftAzureGetworkflowrun
      x-ms-examples:
        WorkflowRun_Get:
          $ref: ./examples/GetWorkflowRun.json
      parameters:
      - $ref: '#/parameters/api-version_2'
      - $ref: '#/parameters/workflowRunId'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/WorkflowRun_2'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Workflowruns Workflowrunid
  /workflowruns/{workflowRunId}/cancel:
    post:
      tags:
      - WorkflowRuns
      description: Cancel a workflow run.
      operationId: microsoftAzureCancelworkflowrun
      x-ms-examples:
        WorkflowRun_Cancel:
          $ref: ./examples/CancelWorkflowRun.json
      parameters:
      - $ref: '#/parameters/api-version_2'
      - $ref: '#/parameters/workflowRunId'
      - name: runCancelReply
        in: body
        required: true
        description: Reply of canceling a workflow run.
        schema:
          $ref: '#/definitions/WorkflowRunCancelRequest'
      responses:
        '200':
          description: OK
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Workflowruns Workflowrunid Cancel
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs
  : get:
      tags:
      - WorkflowRuns
      operationId: microsoftAzureWorkflowrunsList
      description: Gets a list of workflow runs.
      x-ms-examples:
        List workflow runs:
          $ref: ./examples/WorkflowRuns_List.json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/siteNameParameter'
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        type: string
      - $ref: '#/parameters/apiVersionParameter'
      - name: $top
        description: The number of items to be included in the result.
        in: query
        required: false
        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
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/WorkflowRunListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse_2'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-odata: '#/definitions/WorkflowRunFilter'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Runs
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}
  : get:
      tags:
      - WorkflowRuns
      operationId: microsoftAzureWorkflowrunsGet
      description: Gets a workflow run.
      x-ms-examples:
        Get a run for a workflow:
          $ref: ./examples/WorkflowRuns_Get.json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/siteNameParameter'
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        type: string
      - name: runName
        description: The workflow run name.
        in: path
        required: true
        type: string
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/WorkflowRun'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse_2'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Runs Runname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/cancel
  : post:
      tags:
      - WorkflowRuns
      operationId: microsoftAzureWorkflowrunsCancel
      description: Cancels a workflow run.
      x-ms-examples:
        Cancel a workflow run:
          $ref: ./examples/WorkflowRuns_Cancel.json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/siteNameParameter'
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        type: string
      - name: runName
        description: The workflow run name.
        in: path
        required: true
        type: string
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse_2'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Runs Runname Cancel
definitions:
  WorkflowRunId:
    type: string
    format: uuid
    description: The workflow run id.
  WorkflowStatus:
    type: string
    enum:
    - NotSpecified
    - Paused
    - Running
    - Waiting
    - Succeeded
    - Skipped
    - Suspended
    - Cancelled
    - Failed
    - Faulted
    - TimedOut
    - Aborted
    - Ignored
    x-ms-enum:
      name: WorkflowStatus
      modelAsString: true
  WorkflowRunListResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/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.
  WorkflowRunPayloadType:
    type: string
    description: The workflow run payload type.
    enum:
    - CreateTerm
    - UpdateTerm
    - DeleteTerm
    - ImportTerms
    - UpdateAsset
    - GrantDataAccess
    x-ms-enum:
      name: WorkflowRunPayloadType
      modelAsString: true
  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: '#/definitions/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.
  WorkflowRunPayload:
    type: object
    description: 'The input of a workflow run. Align with operation in user request. '
    properties:
      type:
        $ref: '#/definitions/WorkflowRunPayloadType'
      targetValue:
        type: string
        description: The target value which need involve workflow to update.
    required:
    - type
    - targetValue
  WorkflowParameter:
    type: object
    properties:
      type:
        $ref: '#/definitions/ParameterType'
        description: The type.
      value:
        $ref: '#/definitions/Object'
        description: The value.
      metadata:
        $ref: '#/definitions/Object'
        description: The metadata.
      description:
        type: string
        description: The description.
    description: The workflow parameters.
  WorkflowRunTrigger:
    type: object
    properties:
      name:
        type: string
        readOnly: true
        description: Gets the name.
      inputs:
        $ref: '#/definitions/Object'
        readOnly: true
        description: Gets the inputs.
      inputsLink:
        $ref: '#/definitions/ContentLink'
        readOnly: true
        description: Gets the link to inputs.
      outputs:
        $ref: '#/definitions/Object'
        readOnly: true
        description: Gets the outputs.
      outputsLink:
        $ref: '#/definitions/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: '#/definitions/Correlation'
        description: The run correlation.
      code:
        type: string
        readOnly: true
        description: Gets the code.
      status:
        $ref: '#/definitions/WorkflowStatus'
        readOnly: true
        description: Gets the status.
      error:
        $ref: '#/definitions/Object'
        readOnly: true
        description: Gets the error.
      trackedProperties:
        $ref: '#/definitions/Object'
        readOnly: true
        description: Gets the tracked properties.
    description: The workflow run trigger.
  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: '#/definitions/ErrorProperties'
        description: The error properties.
  WorkflowOutputParameter:
    type: object
    properties:
      error:
        $ref: '#/definitions/Object'
        readOnly: true
        description: Gets the error.
    description: The workflow output parameter.
    allOf:
    - $ref: '#/definitions/WorkflowParameter'
  ParameterType:
    type: string
    enum:
    - NotSpecified
    - String
    - SecureString
    - Int
    - Float
    - Bool
    - Array
    - Object
    - SecureObject
    x-ms-enum:
      name: ParameterType
      modelAsString: true
  RequestorId:
    type: string
    format: uuid
    description: The person who submitted the user request.
  WorkflowRunList:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/WorkflowRunMetadata'
        description: The value of workflow run list.
      nextLink:
        type: string
        description: The URL to get the next set of results.
    required:
    - value
  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: '#/definitions/WorkflowRunId'
      workflowId:
        $ref: '#/definitions/WorkflowId'
      startTime:
        type: string
        description: Workflow run start time.
        format: date-time
      requestor:
        $ref: '#/definitions/RequestorId'
      userRequestId:
        type: string
        format: uuid
        description: The user request id.
      runPayload:
        $ref: '#/definitions/WorkflowRunPayload'
      status:
        $ref: '#/definitions/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
  SubResource:
    properties:
      id:
        type: string
        readOnly: true
        description: The resource id.
    x-ms-azure-resource: true
    description: The sub resource type.
  Status:
    type: string
    description: The status.
    enum:
    - NotStarted
    - InProgress
    - Failed
    - Completed
    - Canceling
    - CancellationFailed
    - Canceled
    x-ms-enum:
      name: UserRequestStatus
      modelAsString: true
  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
  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: '#/definitions/ContentHash'
        description: The content hash.
      metadata:
        $ref: '#/definitions/Object'
        description: The metadata.
    description: The content link.
  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.
  ErrorResponse:
    description: Default error response model
    type: object
    properties:
      error:
        $ref: '#/definitions/ErrorModel'
    required:
    - error
  WorkflowId:
    type: string
    format: uuid
    description: The workflow id.
  WorkflowRun:
    type: object
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/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: '#/definitions/SubResource'
  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: '#/definitions/WorkflowStatus'
        readOnly: true
        description: Gets the status.
      code:
        type: string
        readOnly: true
        description: Gets the code.
      error:
        $ref: '#/definitions/Object'
        readOnly: true
        description: Gets the error.
      correlationId:
        type: string
        readOnly: true
        description: Gets the correlation id.
      correlation:
        $ref: '#/definitions/Correlation'
        description: The run correlation.
      workflow:
        $ref: '#/definitions/ResourceReference'
        readOnly: true
        description: Gets the reference to workflow version.
      trigger:
        $ref: '#/definitions/WorkflowRunTrigger'
        readOnly: true
        description: Gets the fired trigger.
      outputs:
        type: object
        readOnly: true
        additionalProperties:
          $ref: '#/definitions/WorkflowOutputParameter'
        description: Gets the outputs.
      response:
        $ref: '#/definitions/WorkflowRunTrigger'
        readOnly: true
        description: Gets the response of the flow run.
    description: The workflow run properties.
  Correlation:
    type: object
    properties:
      clientTrackingId:
        type: string
        description: The client tracking id.
    description: The correlation property.
  Object:
    type: object
    properties: {}
  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: '#/definitions/WorkflowRunId'
      workflowId:
        $ref: '#/definitions/WorkflowId'
      startTime:
        type: string
        description: Workflow run start time.
        format: date-time
      requestor:
        $ref: '#/definitions/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: '#/definitions/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: '#/definitions/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: '#/definitions/WorkflowRunDetail'
    required:
    - actionDag
    - detail
  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
  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.
parameters:
  resourceGroupNameParameter:
    name: resourceGroupName
    in: path
    description: Name of the resource group to which the resource belongs.
    required: true
    type: string
    maxLength: 90
    minLength: 1
    pattern: ^[-\w\._\(\)]+[^\.]$
    x-ms-parameter-location: method
  api-version:
    name: api-version
    description: The API version.
    in: query
    required: true
    type: string
  workflowRunId:
    name: workflowRunId
    in: path
    required: true
    type: string
    format: uuid
    description: The workflow run id.
    x-ms-parameter-location: method
  subscriptionId:
    name: subscriptionId
    description: The subscription id.
    in: path
    required: true
    type: string
  workflowIds:
    name: workflowIds
    in: query
    required: false
    type: array
    items:
      type: string
    description: Filter items by workflow id list.
    x-ms-parameter-location: method
  maxpagesize:
    name: maxpagesize
    in: query
    required: false
    type: integer
    format: int32
    description: The maximum page size to get the items at one time.
    x-ms-parameter-location: method
  apiVersionParameter:
    name: api-version
    in: query
    description: API Version
    required: true
    type: string
    x-ms-parameter-location: client
  api-version_2:
    name: api-version
    description: Version of Purview APIs
    in: query
    required: true
    type: string
    x-ms-parameter-location: client
  runStatuses:
    name: runStatuses
    in: query
    required: false
    type: array
    items:
      type: string
      enum:
      - InProgress
      - Failed
      - Completed
      - NotStarted
      - Canceling
      - CancellationFailed
      - Canceled
      x-ms-enum:
        name: status
        modelAsString: true
    description: Filter workflow runs by workflow run status.
    x-ms-parameter-location: method
  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
    type: string
    x-ms-parameter-location: client
  siteNameParameter:
    name: name
    in: path
    description: Site name.
    required: true
    type: string
    x-ms-parameter-location: method
  timeWindow:
    name: timeWindow
    in: query
    required: false
    type: string
    enum:
    - 1d
    - 7d
    - 30d
    - 90d
    x-ms-enum:
      name: TimeWindow
      modelAsString: true
    description: Time window of filtering items.
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'