Microsoft Azure Business Processes API

openapi: 3.2.0
info:
  title: Microsoft Azure Microsoft.IntegrationSpaces Business…
  version: 2023-11-14-preview
  description: The azure integration spaces resource provider.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Business Processes
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IntegrationSpaces/spaces/{spaceName}/applications/{applicationName}/businessProcesses
  : get:
      operationId: microsoftAzureBusinessprocessesListbyapplication
      tags:
      - Business Processes
      description: List BusinessProcess resources by Application
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/Azure.Core.TopQueryParameter'
      - $ref: '#/components/parameters/Azure.Core.SkipQueryParameter'
      - $ref: '#/components/parameters/Azure.Core.MaxPageSizeQueryParameter'
      - $ref: '#/components/parameters/Azure.Core.FilterQueryParameter'
      - $ref: '#/components/parameters/Azure.Core.SelectQueryParameter'
      - $ref: '#/components/parameters/Azure.Core.ExpandQueryParameter'
      - $ref: '#/components/parameters/Azure.Core.OrderByQueryParameter'
      - name: spaceName
        in: path
        description: The name of the space
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9_.()-]{0,79}$'
      - name: applicationName
        in: path
        description: The name of the Application
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9_.()-]{0,79}$'
      responses:
        '200':
          description: ARM operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessProcessListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        ListBusinessProcessesByApplication:
          $ref: ./examples/BusinessProcesses_ListByApplication.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IntegrationSpaces/spaces/{spaceName}/applications/{applicationName}/businessProcesses/{businessProcessName}
  : get:
      operationId: microsoftAzureBusinessprocessesGet
      tags:
      - Business Processes
      description: Get a BusinessProcess
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: spaceName
        in: path
        description: The name of the space
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9_.()-]{0,79}$'
      - name: applicationName
        in: path
        description: The name of the Application
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9_.()-]{0,79}$'
      - name: businessProcessName
        in: path
        description: The name of the business process
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9_.()-]{0,79}$'
      responses:
        '200':
          description: ARM operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessProcess'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        GetBusinessProcess:
          $ref: ./examples/BusinessProcesses_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    put:
      operationId: microsoftAzureBusinessprocessesCreateorupdate
      tags:
      - Business Processes
      description: Create a BusinessProcess
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: spaceName
        in: path
        description: The name of the space
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9_.()-]{0,79}$'
      - name: applicationName
        in: path
        description: The name of the Application
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9_.()-]{0,79}$'
      - name: businessProcessName
        in: path
        description: The name of the business process
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9_.()-]{0,79}$'
      responses:
        '200':
          description: Resource 'BusinessProcess' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessProcess'
        '201':
          description: Resource 'BusinessProcess' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessProcess'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        CreateOrUpdateBusinessProcess:
          $ref: ./examples/BusinessProcesses_CreateOrUpdate.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessProcess'
        description: Resource create parameters.
        required: true
    patch:
      operationId: microsoftAzureBusinessprocessesPatch
      tags:
      - Business Processes
      description: Update a BusinessProcess
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: spaceName
        in: path
        description: The name of the space
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9_.()-]{0,79}$'
      - name: applicationName
        in: path
        description: The name of the Application
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9_.()-]{0,79}$'
      - name: businessProcessName
        in: path
        description: The name of the business process
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9_.()-]{0,79}$'
      responses:
        '200':
          description: ARM operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessProcess'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        PatchBusinessProcess:
          $ref: ./examples/BusinessProcesses_Patch.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessProcessUpdate'
        description: The resource properties to be updated.
        required: true
    delete:
      operationId: microsoftAzureBusinessprocessesDelete
      tags:
      - Business Processes
      description: Delete a BusinessProcess
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: spaceName
        in: path
        description: The name of the space
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9_.()-]{0,79}$'
      - name: applicationName
        in: path
        description: The name of the Application
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9_.()-]{0,79}$'
      - name: businessProcessName
        in: path
        description: The name of the business process
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9_.()-]{0,79}$'
      responses:
        '200':
          description: Resource deleted successfully.
        '204':
          description: Resource deleted successfully.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        DeleteBusinessProcess:
          $ref: ./examples/BusinessProcesses_Delete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
components:
  schemas:
    ProvisioningState:
      type: string
      description: The status of the current operation.
      enum:
      - Succeeded
      - Failed
      - Canceled
      - Provisioning
      - Updating
      - Deleting
      - Accepted
      x-ms-enum:
        name: ProvisioningState
        modelAsString: true
        values:
        - name: Succeeded
          value: Succeeded
          description: Resource has been created.
        - name: Failed
          value: Failed
          description: Resource creation failed.
        - name: Canceled
          value: Canceled
          description: Resource creation was canceled.
        - name: Provisioning
          value: Provisioning
        - name: Updating
          value: Updating
        - name: Deleting
          value: Deleting
        - name: Accepted
          value: Accepted
    BusinessProcessProperties:
      type: object
      description: The properties of business process.
      properties:
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
          description: The status of the last operation.
          readOnly: true
        version:
          type: string
          description: The version of the business process.
          readOnly: true
        description:
          type: string
          description: The description of the business process.
        tableName:
          type: string
          description: The table name of the business process.
        trackingDataStoreReferenceName:
          type: string
          description: The tracking data store reference name.
        identifier:
          $ref: '#/components/schemas/BusinessProcessIdentifier'
          description: The business process identifier.
        businessProcessStages:
          type: object
          description: The business process stages.
          additionalProperties:
            $ref: '#/components/schemas/BusinessProcessStage'
        businessProcessMapping:
          type: object
          description: The business process mapping.
          additionalProperties:
            $ref: '#/components/schemas/BusinessProcessMappingItem'
    BusinessProcessUpdate:
      type: object
      description: The type used for update operations of the BusinessProcess.
      properties:
        properties:
          $ref: '#/components/schemas/BusinessProcessUpdateProperties'
          x-ms-client-flatten: true
    BusinessProcessUpdateProperties:
      type: object
      description: The updatable properties of the BusinessProcess.
      properties:
        description:
          type: string
          description: The description of the business process.
        tableName:
          type: string
          description: The table name of the business process.
        trackingDataStoreReferenceName:
          type: string
          description: The tracking data store reference name.
        identifier:
          $ref: '#/components/schemas/BusinessProcessIdentifier'
          description: The business process identifier.
        businessProcessStages:
          type: object
          description: The business process stages.
          additionalProperties:
            $ref: '#/components/schemas/BusinessProcessStage'
        businessProcessMapping:
          type: object
          description: The business process mapping.
          additionalProperties:
            $ref: '#/components/schemas/BusinessProcessMappingItem'
    BusinessProcess:
      type: object
      description: A business process under application.
      properties:
        properties:
          $ref: '#/components/schemas/BusinessProcessProperties'
          description: The resource-specific properties for this resource.
          x-ms-client-flatten: true
          x-ms-mutability:
          - read
          - create
      allOf:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource
    BusinessProcessMappingItem:
      type: object
      description: The properties of business process mapping.
      properties:
        logicAppResourceId:
          type: string
          description: The logic app resource id.
        workflowName:
          type: string
          description: The workflow name within the logic app.
        operationName:
          type: string
          description: The operation name.
        operationType:
          type: string
          description: The mapping item operation type of the business process.
    BusinessProcessIdentifier:
      type: object
      description: The properties of business process identifier.
      properties:
        propertyName:
          type: string
          description: The property name of the business process identifier.
        propertyType:
          type: string
          description: The property type of the business process identifier.
    BusinessProcessStage:
      type: object
      description: The properties of business process stage.
      properties:
        description:
          type: string
          description: The description of the business stage.
        properties:
          type: object
          description: The properties within the properties of the business process stage.
          additionalProperties:
            type: string
        stagesBefore:
          type: array
          description: The property to keep track of stages before current in the business process stage.
          items:
            type: string
    BusinessProcessListResult:
      type: object
      description: The response of a BusinessProcess list operation.
      properties:
        value:
          type: array
          description: The BusinessProcess items on this page
          items:
            $ref: '#/components/schemas/BusinessProcess'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
  parameters:
    Azure.Core.FilterQueryParameter:
      name: filter
      in: query
      description: Filter the result list using the given expression.
      required: false
      x-ms-parameter-location: method
      schema:
        type: string
    Azure.Core.OrderByQueryParameter:
      name: orderby
      in: query
      description: Expressions that specify the order of returned results.
      required: false
      x-ms-parameter-location: method
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
    Azure.Core.ExpandQueryParameter:
      name: expand
      in: query
      description: Expand the indicated resources into the response.
      required: false
      x-ms-parameter-location: method
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
    Azure.Core.TopQueryParameter:
      name: top
      in: query
      description: The number of result items to return.
      required: false
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
    Azure.Core.SkipQueryParameter:
      name: skip
      in: query
      description: The number of result items to skip.
      required: false
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
        default: 0
    Azure.Core.SelectQueryParameter:
      name: select
      in: query
      description: Select the specified fields to be included in the response.
      required: false
      x-ms-parameter-location: method
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
    Azure.Core.MaxPageSizeQueryParameter:
      name: maxpagesize
      in: query
      description: The maximum number of result items per page.
      required: false
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
  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.