swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector WorkflowTasks API
schemes:
- https
tags:
- name: WorkflowTasks
paths:
  /workflowtasks:
    get:
      tags:
      - WorkflowTasks
      description: Get all workflow tasks.
      operationId: microsoftAzureListworkflowtasks
      x-ms-examples:
        WorkflowTasks_List:
          $ref: ./examples/ListWorkflowTasks.json
      x-ms-pageable:
        nextLinkName: nextLink
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/viewMode'
      - $ref: '#/parameters/workflowIds'
      - $ref: '#/parameters/timeWindow'
      - $ref: '#/parameters/maxpagesize'
      - name: orderby
        in: query
        required: false
        type: string
        enum:
        - createdTime desc
        - createdTime asc
        - requestor desc
        - requestor 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/taskTypes'
      - $ref: '#/parameters/taskStatuses'
      - $ref: '#/parameters/workflowNameKeyword'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/TasksList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Workflowtasks
  /workflowtasks/{taskId}:
    get:
      tags:
      - WorkflowTasks
      description: Get a workflow task.
      operationId: microsoftAzureGetworkflowtask
      x-ms-examples:
        WorkTask_Get:
          $ref: ./examples/GetWorkflowTask.json
      parameters:
      - $ref: '#/parameters/taskId'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/WorkflowTask'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Workflowtasks Taskid
  /workflowtasks/{taskId}/approve-approval:
    post:
      tags:
      - WorkflowTasks
      description: Approve an approval task.
      operationId: microsoftAzureApproveapprovaltask
      x-ms-examples:
        ApprovalTask_Approve:
          $ref: ./examples/ApproveApprovalTask.json
      parameters:
      - $ref: '#/parameters/taskId'
      - $ref: '#/parameters/api-version'
      - name: approvalResponseComment
        in: body
        required: true
        description: The request body of approving an approval request.
        schema:
          $ref: '#/definitions/ApprovalResponseComment'
      responses:
        '200':
          description: OK
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Workflowtasks Taskid Approve Approval
  /workflowtasks/{taskId}/reject-approval:
    post:
      tags:
      - WorkflowTasks
      description: Reject an approval task.
      operationId: microsoftAzureRejectapprovaltask
      x-ms-examples:
        ApprovalRequest_Reject:
          $ref: ./examples/RejectApprovalTask.json
      parameters:
      - $ref: '#/parameters/taskId'
      - $ref: '#/parameters/api-version'
      - name: approvalResponseComment
        in: body
        required: true
        description: The request body of rejecting an approval request.
        schema:
          $ref: '#/definitions/ApprovalResponseComment'
      responses:
        '200':
          description: OK
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Workflowtasks Taskid Reject Approval
  /workflowtasks/{taskId}/reassign:
    post:
      tags:
      - WorkflowTasks
      description: Reassign a workflow task.
      operationId: microsoftAzureReassignworkflowtask
      x-ms-examples:
        ApprovalRequest_Reassign:
          $ref: ./examples/ReassignWorkflowTask.json
      parameters:
      - $ref: '#/parameters/taskId'
      - $ref: '#/parameters/api-version'
      - name: reassignCommand
        in: body
        required: true
        description: The request body of reassigning a workflow task.
        schema:
          $ref: '#/definitions/ReassignCommand'
      responses:
        '200':
          description: OK
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Workflowtasks Taskid Reassign
  /workflowtasks/{taskId}/change-task-status:
    post:
      tags:
      - WorkflowTasks
      description: Update the status of a workflow task request.
      operationId: microsoftAzureUpdatetaskstatus
      x-ms-examples:
        TaskRequest_Update:
          $ref: ./examples/UpdateTaskRequest.json
      parameters:
      - $ref: '#/parameters/taskId'
      - name: taskUpdateCommand
        in: body
        required: true
        description: Request body of updating workflow task request.
        schema:
          $ref: '#/definitions/TaskUpdateCommand'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Workflowtasks Taskid Change Task Status
definitions:
  WorkflowRunId:
    type: string
    format: uuid
    description: The workflow run id.
  TasksList:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/WorkflowTask'
        description: The value of workflow tasks list.
      nextLink:
        type: string
        description: The URL to get the next set of results.
    required:
    - value
  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
  TaskPayloadType:
    type: string
    description: The task payload type.
    enum:
    - CreateTerm
    - UpdateTerm
    - DeleteTerm
    - ImportTerms
    - UpdateAsset
    - GrantDataAccess
    x-ms-enum:
      name: TaskPayloadType
      modelAsString: true
  RequestorId:
    type: string
    format: uuid
    description: The person who submitted the user request.
  TaskPayload:
    type: object
    description: Info and material that helps assignees to take action.
    properties:
      type:
        $ref: '#/definitions/TaskPayloadType'
      targetValue:
        type: string
        description: The target value of entity which user want to involve workflow to update.
      payload:
        type: object
        description: The payload of the task.
    required:
    - type
    - targetValue
  ReassignCommand:
    type: object
    description: The request payload of reassigning a workflow task.
    properties:
      reassignments:
        type: array
        description: The request body of reassigning a workflow task.
        items:
          type: object
          properties:
            reassignFrom:
              type: string
              format: uuid
              description: Reassign a workflow task from a user or a group.
            reassignTo:
              type: string
              format: uuid
              description: Reassign a workflow task to a user or a group.
          required:
          - reassignFrom
          - reassignTo
  TaskUpdateCommand:
    type: object
    properties:
      newStatus:
        type: string
        description: The new status will be used to update the task.
        enum:
        - NotStarted
        - InProgress
        - Completed
        - Canceled
        x-ms-enum:
          name: TaskStatus
          modelAsString: true
      comment:
        type: string
        description: The comment when update a task.
    required:
    - newStatus
  LastUpdateTime:
    type: string
    format: date-time
    description: The last update time.
  ApprovalResponseComment:
    type: object
    properties:
      comment:
        type: string
        description: The comment of approving or rejecting an approval request.
  ErrorResponse:
    description: Default error response model
    type: object
    properties:
      error:
        $ref: '#/definitions/ErrorModel'
    required:
    - error
  WorkflowId:
    type: string
    format: uuid
    description: The workflow id.
  WorkflowTask:
    discriminator: type
    type: object
    description: An actionable item assigned to assignees. It is created when approval or task action starts to execute. Approval is one kind of task.
    properties:
      type:
        type: string
        description: The workflow task type.
        enum:
        - Approval
        - SimpleTask
        x-ms-enum:
          name: TaskType
          modelAsString: true
      id:
        type: string
        format: uuid
        description: The workflow task id.
      title:
        type: string
        description: The workflow task title.
      workflowRunId:
        $ref: '#/definitions/WorkflowRunId'
      workflowId:
        $ref: '#/definitions/WorkflowId'
      requestor:
        $ref: '#/definitions/RequestorId'
      createdTime:
        $ref: '#/definitions/CreatedTime'
      lastUpdateTime:
        $ref: '#/definitions/LastUpdateTime'
      payload:
        $ref: '#/definitions/TaskPayload'
      reminderInfo:
        type: object
        description: Info of task reminder.
        properties:
          lastRemindTime:
            type: string
            format: date-time
            description: The last update time.
          nextRemindTime:
            type: string
            format: date-time
            description: The next remind time.
          reminderSettings:
            type: object
            description: The reminder settings.
        required:
        - nextRemindTime
        - reminderSettings
      expiryInfo:
        type: object
        description: Info of task expiry.
        properties:
          lastExpiryNotificationTime:
            type: string
            format: date-time
            description: The last expiry notification time.
          nextExpiryNotificationTime:
            type: string
            format: date-time
            description: The next expiry notification time.
          expiryTime:
            type: string
            format: date-time
            description: The expiry time.
          expirySettings:
            type: object
            properties:
              expireAfter:
                type: object
                description: The time of expiry.
              notifyOnExpiration:
                type: array
                items:
                  type: string
                  format: uuid
                  description: Notify user on expiration.
            required:
            - expireAfter
        required:
        - nextExpiryNotificationTime
        - expiryTime
        - expirySettings
    required:
    - type
    - id
    - workflowRunId
    - workflowId
    - requestor
    - createdTime
    - lastUpdateTime
    - payload
  CreatedTime:
    type: string
    format: date-time
    description: The created time.
parameters:
  taskStatuses:
    name: taskStatuses
    in: query
    required: false
    type: array
    items:
      type: string
      enum:
      - Pending
      - Approved
      - Rejected
      - Canceled
      - NotStarted
      - InProgress
      - Completed
      x-ms-enum:
        name: status
        modelAsString: true
    description: Filter workflow tasks by status.
    x-ms-parameter-location: method
  taskId:
    name: taskId
    in: path
    required: true
    type: string
    format: uuid
    description: The task id.
    x-ms-parameter-location: method
  api-version:
    name: api-version
    description: Version of Purview APIs
    in: query
    required: true
    type: string
    x-ms-parameter-location: client
  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
  taskTypes:
    name: taskTypes
    in: query
    required: false
    type: array
    items:
      type: string
      enum:
      - approval
      - simpleTask
      x-ms-enum:
        name: TaskType
        modelAsString: true
    description: Filter items by workflow task type.
    x-ms-parameter-location: method
  viewMode:
    name: viewMode
    in: query
    required: false
    type: string
    items:
      type: string
      enum:
      - sent
      - received
      - history
      x-ms-enum:
        name: status
        modelAsString: true
    description: To filter user's sent, received or history workflow tasks.
    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
  workflowNameKeyword:
    name: workflowNameKeyword
    in: query
    required: false
    type: string
    description: The key word which could used to filter workflow item with related workflow.
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'