swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Workflow Resource API
schemes:
- https
tags:
- name: Workflow Resource
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows
  : get:
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - name: storageSyncServiceName
        in: path
        description: Name of Storage Sync Service resource.
        required: true
        type: string
      tags:
      - Workflow Resource
      operationId: microsoftAzureWorkflowsListbystoragesyncservice
      description: Get a Workflow List
      x-ms-examples:
        Workflows_ListByStorageSyncService:
          $ref: ./examples/Workflows_ListByStorageSyncService.json
      responses:
        '200':
          description: Array of Workflow resources in Storage Sync Service
          schema:
            $ref: '#/definitions/WorkflowArray'
          headers:
            x-ms-request-id:
              description: request id.
              type: string
            x-ms-correlation-request-id:
              description: correlation request id.
              type: string
        default:
          description: Error message indicating why the operation failed.
          schema:
            $ref: '#/definitions/StorageSyncError'
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Workflows
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows/{workflowId}
  : get:
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - name: storageSyncServiceName
        in: path
        description: Name of Storage Sync Service resource.
        required: true
        type: string
      - name: workflowId
        in: path
        description: workflow Id
        required: true
        type: string
      tags:
      - Workflow Resource
      operationId: microsoftAzureWorkflowsGet
      description: Get Workflows resource
      x-ms-examples:
        Workflows_Get:
          $ref: ./examples/Workflows_Get.json
      responses:
        '200':
          description: Workflow object
          schema:
            $ref: '#/definitions/Workflow'
          headers:
            x-ms-request-id:
              description: request id.
              type: string
            x-ms-correlation-request-id:
              description: correlation request id.
              type: string
        default:
          description: Error message indicating why the operation failed.
          schema:
            $ref: '#/definitions/StorageSyncError'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Workflows Workflowid
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows/{workflowId}/abort
  : post:
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - name: storageSyncServiceName
        in: path
        description: Name of Storage Sync Service resource.
        required: true
        type: string
      - name: workflowId
        in: path
        description: workflow Id
        required: true
        type: string
      tags:
      - Workflow Resource
      operationId: microsoftAzureWorkflowsAbort
      description: Abort the given workflow.
      x-ms-examples:
        Workflows_Abort:
          $ref: ./examples/Workflows_Abort.json
      responses:
        '200':
          description: success
          headers:
            x-ms-request-id:
              description: request id.
              type: string
            x-ms-correlation-request-id:
              description: correlation request id.
              type: string
        default:
          description: Error message indicating why the operation failed.
          schema:
            $ref: '#/definitions/StorageSyncError'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Workflows Workflowid Abort
definitions:
  StorageSyncError:
    type: object
    description: Error type
    properties:
      error:
        $ref: '#/definitions/StorageSyncApiError'
        description: Error details of the given entry.
      innererror:
        $ref: '#/definitions/StorageSyncApiError'
        description: Error details of the given entry.
  WorkflowStatus:
    type: string
    description: Type of the Workflow Status
    enum:
    - active
    - expired
    - succeeded
    - aborted
    - failed
    x-ms-enum:
      name: WorkflowStatus
      modelAsString: true
  StorageSyncApiError:
    type: object
    description: Error type
    properties:
      code:
        type: string
        description: Error code of the given entry.
      message:
        type: string
        description: Error message of the given entry.
      target:
        type: string
        description: Target of the given error entry.
      details:
        $ref: '#/definitions/StorageSyncErrorDetails'
        description: Error details of the given entry.
      innererror:
        $ref: '#/definitions/StorageSyncInnerErrorDetails'
        description: Inner error details of the given entry.
  WorkflowProperties:
    type: object
    description: Workflow Properties object.
    properties:
      lastStepName:
        type: string
        description: last step name
      status:
        $ref: '#/definitions/WorkflowStatus'
        description: workflow status.
      operation:
        $ref: '#/definitions/OperationDirection'
        description: operation direction.
      steps:
        type: string
        description: workflow steps
      lastOperationId:
        type: string
        description: workflow last operation identifier.
      commandName:
        type: string
        description: workflow command name.
        readOnly: true
      createdTimestamp:
        type: string
        format: date-time
        description: workflow created timestamp.
        readOnly: true
      lastStatusTimestamp:
        type: string
        format: date-time
        description: workflow last status timestamp.
        readOnly: true
  Workflow:
    type: object
    description: Workflow resource.
    allOf:
    - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/WorkflowProperties'
        description: Workflow properties.
  OperationDirection:
    type: string
    description: Type of the Operation Direction
    enum:
    - do
    - undo
    - cancel
    x-ms-enum:
      name: OperationDirection
      modelAsString: true
  StorageSyncErrorDetails:
    type: object
    description: Error Details object.
    properties:
      code:
        type: string
        description: Error code of the given entry.
      message:
        type: string
        description: Error message of the given entry.
      target:
        type: string
        description: Target of the given entry.
      requestUri:
        type: string
        description: Request URI of the given entry.
      exceptionType:
        type: string
        description: Exception type of the given entry.
      httpMethod:
        type: string
        description: HTTP method of the given entry.
      hashedMessage:
        type: string
        description: Hashed message of the given entry.
      httpErrorCode:
        type: string
        description: HTTP error code of the given entry.
  StorageSyncInnerErrorDetails:
    type: object
    description: Error Details object.
    properties:
      callStack:
        type: string
        description: Call stack of the error.
      message:
        type: string
        description: Error message of the error.
      innerException:
        type: string
        description: Exception of the inner error.
      innerExceptionCallStack:
        type: string
        description: Call stack of the inner error.
  WorkflowArray:
    description: Array of Workflow
    type: object
    properties:
      value:
        type: array
        description: Collection of workflow items.
        items:
          $ref: '#/definitions/Workflow'
        x-ms-identifiers:
        - id
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'