swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector UserRequests API
schemes:
- https
tags:
- name: UserRequests
paths:
  /userrequests:
    post:
      tags:
      - UserRequests
      description: Submit a user request for requestor, a user  request describes user ask to do operation(s) on Purview. If any workflow's trigger matches with an operation in request, a run of the workflow is created.
      operationId: microsoftAzureSubmituserrequests
      x-ms-examples:
        UserRequests_Submit:
          $ref: ./examples/SubmitUserRequests.json
      parameters:
      - name: userRequestsPayload
        in: body
        required: true
        description: The payload of submitting a user request.
        schema:
          $ref: '#/definitions/UserRequestPayload'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/UserRequestResponse'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Userrequests
definitions:
  WorkflowRunId:
    type: string
    format: uuid
    description: The workflow run id.
  ErrorResponse:
    description: Default error response model
    type: object
    properties:
      error:
        $ref: '#/definitions/ErrorModel'
    required:
    - error
  RequestorId:
    type: string
    format: uuid
    description: The person who submitted the user request.
  Operation:
    type: object
    description: The operation user wants to perform.
    properties:
      type:
        $ref: '#/definitions/OperationType'
      payload:
        type: object
        description: The payload of each operation which user want to submit.
    required:
    - type
    - payload
  UserRequestPayload:
    type: object
    properties:
      operations:
        type: array
        description: The list of operations user want to submit, each operation matches one Purview API call and will do the operation directly.
        items:
          $ref: '#/definitions/Operation'
      comment:
        type: string
        description: The comment when submit a user request.
    required:
    - operations
  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
  UserRequestResponse:
    description: Describes user ask to do operation(s) on Purview.
    type: object
    properties:
      requestId:
        type: string
        format: uuid
        description: The user request id.
      requestor:
        $ref: '#/definitions/RequestorId'
      operations:
        type: array
        description: The list of operations user want to submit, each operation matches one Purview API call and will do the operation directly.
        items:
          type: object
          description: The operation user wants to perform.
          properties:
            type:
              $ref: '#/definitions/OperationType'
            payload:
              type: object
              description: The payload of each operation which user want to submit.
            workflowRunIds:
              type: array
              items:
                $ref: '#/definitions/WorkflowRunId'
          required:
          - type
          - payload
      comment:
        type: string
        description: The comment when submit a user request.
      status:
        $ref: '#/definitions/Status'
    required:
    - requestId
    - requestor
    - operations
    - status
  Status:
    type: string
    description: The status.
    enum:
    - NotStarted
    - InProgress
    - Failed
    - Completed
    - Canceling
    - CancellationFailed
    - Canceled
    x-ms-enum:
      name: UserRequestStatus
      modelAsString: true
  OperationType:
    type: string
    description: The operation type.
    enum:
    - CreateTerm
    - UpdateTerm
    - DeleteTerm
    - ImportTerms
    - UpdateAsset
    - GrantDataAccess
    x-ms-enum:
      name: OperationType
      modelAsString: true
parameters:
  api-version:
    name: api-version
    description: Version of Purview APIs
    in: query
    required: true
    type: string
    x-ms-parameter-location: client
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'