Microsoft Azure Apps API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Apps API
schemes:
- https
tags:
- name: Apps
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/iotApps/{resourceName}:
    get:
      tags:
      - Apps
      description: Get the metadata of an IoT Central application.
      operationId: microsoftAzureAppsGet
      x-ms-examples:
        Apps_Get:
          $ref: ./examples/Apps_Get.json
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/resourceName'
      responses:
        '200':
          description: The body contains all the non-security properties of the IoT Central application. Security-related properties are set to null.
          schema:
            $ref: '#/definitions/App'
        default:
          description: Default error response
          schema:
            $ref: '#/definitions/CloudError'
      deprecated: false
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotcentral Iotapps Resourcename
    put:
      tags:
      - Apps
      description: Create or update the metadata of an IoT Central application. The usual pattern to modify a property is to retrieve the IoT Central application metadata and security metadata, and then combine them with the modified values in a new body to update the IoT Central application.
      operationId: microsoftAzureAppsCreateorupdate
      x-ms-long-running-operation: true
      x-ms-examples:
        Apps_CreateOrUpdate:
          $ref: ./examples/Apps_CreateOrUpdate.json
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/resourceName'
      - name: App
        in: body
        description: The IoT Central application metadata and security metadata.
        required: true
        schema:
          $ref: '#/definitions/App'
      responses:
        '200':
          description: This is returned as a response to the status polling request for the create or update operation. The body contains the resource representation that indicates a transitional provisioning state.
          schema:
            $ref: '#/definitions/App'
        '201':
          description: This is returned as a response to the status polling request for the create or update operation. The body contains the resource representation that indicates a transitional provisioning state.
          schema:
            $ref: '#/definitions/App'
        '202':
          description: Accepted - Put request accepted; the operation will complete asynchronously.
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/CloudError'
      deprecated: false
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotcentral Iotapps Resourcename
    patch:
      tags:
      - Apps
      description: Update the metadata of an IoT Central application.
      operationId: microsoftAzureAppsUpdate
      x-ms-long-running-operation: true
      x-ms-examples:
        Apps_Update:
          $ref: ./examples/Apps_Update.json
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/resourceName'
      - name: AppPatch
        in: body
        description: The IoT Central application metadata and security metadata.
        required: true
        schema:
          $ref: '#/definitions/AppPatch'
      responses:
        '200':
          description: This is returned as a response to the status polling request for the create or update operation. The body contains the resource representation that indicates a transitional provisioning state.
          schema:
            $ref: '#/definitions/App'
        '202':
          description: Accepted - Put request accepted; the operation will complete asynchronously.
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/CloudError'
      deprecated: false
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotcentral Iotapps Resourcename
    delete:
      tags:
      - Apps
      description: Delete an IoT Central application.
      operationId: microsoftAzureAppsDelete
      x-ms-long-running-operation: true
      x-ms-examples:
        Apps_Delete:
          $ref: ./examples/Apps_Delete.json
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/resourceName'
      responses:
        '200':
          description: This is returned as a response to the status polling request for the delete operation. The body contains the resource representation that indicates a transitional provisioning state.
        '202':
          description: Accepted - Delete request accepted; the operation will complete asynchronously.
        '204':
          description: Once the long running delete operation completes successfully, a 204 No Content status code is returned when the status polling request finds the IoT Central application metadata in the service and the status of the delete operation is set to a completed state.
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotcentral Iotapps Resourcename
  /subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/iotApps:
    get:
      tags:
      - Apps
      description: Get all IoT Central Applications in a subscription.
      operationId: microsoftAzureAppsListbysubscription
      x-ms-examples:
        Apps_ListBySubscription:
          $ref: ./examples/Apps_ListBySubscription.json
      x-ms-pageable:
        nextLinkName: nextLink
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/subscriptionId'
      responses:
        '200':
          description: This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the IoT Central Applications in the subscription.
          schema:
            $ref: '#/definitions/AppListResult'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/CloudError'
      deprecated: false
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Iotcentral Iotapps
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/iotApps:
    get:
      tags:
      - Apps
      description: Get all the IoT Central Applications in a resource group.
      operationId: microsoftAzureAppsListbyresourcegroup
      x-ms-examples:
        Apps_ListByResourceGroup:
          $ref: ./examples/Apps_ListByResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      responses:
        '200':
          description: This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the IoT Central Applications in the resource group.
          schema:
            $ref: '#/definitions/AppListResult'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/CloudError'
      deprecated: false
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotcentral Iotapps
  /subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/checkNameAvailability:
    post:
      tags:
      - Apps
      description: Check if an IoT Central application name is available.
      operationId: microsoftAzureAppsChecknameavailability
      x-ms-examples:
        Apps_CheckNameAvailability:
          $ref: ./examples/Apps_CheckNameAvailability.json
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/subscriptionId'
      - name: operationInputs
        in: body
        description: Set the name parameter in the OperationInputs structure to the name of the IoT Central application to check.
        required: true
        schema:
          $ref: '#/definitions/OperationInputs'
      responses:
        '200':
          description: This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the IoT Central application name is available. If the name is not available, the body contains the reason.
          schema:
            $ref: '#/definitions/AppAvailabilityInfo'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/CloudError'
      deprecated: false
      summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Iotcentral Checknameavailability
  /subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/checkSubdomainAvailability:
    post:
      tags:
      - Apps
      description: Check if an IoT Central application subdomain is available.
      operationId: microsoftAzureAppsChecksubdomainavailability
      x-ms-examples:
        Apps_SubdomainAvailability:
          $ref: ./examples/Apps_CheckSubdomainAvailability.json
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/subscriptionId'
      - name: operationInputs
        in: body
        description: Set the name parameter in the OperationInputs structure to the subdomain of the IoT Central application to check.
        required: true
        schema:
          $ref: '#/definitions/OperationInputs'
      responses:
        '200':
          description: This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the IoT Central application subdomain is available. If the subdomain is not available, the body contains the reason.
          schema:
            $ref: '#/definitions/AppAvailabilityInfo'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/CloudError'
      deprecated: false
      summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Iotcentral Checksubdomainavailability
  /subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/appTemplates:
    post:
      tags:
      - Apps
      description: Get all available application templates.
      operationId: microsoftAzureAppsListtemplates
      x-ms-examples:
        Apps_ListTemplates:
          $ref: ./examples/Apps_Templates.json
      x-ms-pageable:
        nextLinkName: nextLink
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/subscriptionId'
      responses:
        '200':
          description: The body contains all the IoT Central application templates.
          schema:
            $ref: '#/definitions/AppTemplatesResult'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/CloudError'
      deprecated: false
      summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Iotcentral Apptemplates
  /apps/{appId}/versions/{versionId}/phraselists:
    post:
      description: Creates a new phraselist feature in a version of the application.
      operationId: microsoftAzureFeaturesAddphraselist
      parameters:
      - $ref: '#/parameters/AppIdInPath'
      - $ref: '#/parameters/VersionIdInPath'
      - name: phraselistCreateObject
        in: body
        required: true
        schema:
          $ref: '#/definitions/PhraselistCreateObject'
        description: A Phraselist object containing Name, comma-separated Phrases and the isExchangeable boolean. Default value for isExchangeable is true.
      consumes:
      - application/json
      responses:
        '201':
          description: The ID of the created feature.
          schema:
            $ref: '#/definitions/FeatureIDResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
      - application/json
      x-ms-examples:
        Successful Create Phraselist Feature request:
          $ref: ./examples/features/SuccessfulCreatePhraselistFeatureRequest.json
      summary: Microsoft Azure Post Apps Appid Versions Versionid Phraselists
      tags:
      - Apps
    get:
      description: Gets all the phraselist features in a version of the application.
      operationId: microsoftAzureFeaturesListphraselists
      parameters:
      - $ref: '#/parameters/AppIdInPath'
      - $ref: '#/parameters/VersionIdInPath'
      - $ref: '#/parameters/SkipInPath'
      - $ref: '#/parameters/TakeInPath'
      responses:
        '200':
          description: A list of all phraselist features.
          schema:
            $ref: '#/definitions/PhraseListFeatureInfoList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
      - application/json
      x-ms-examples:
        Successful Get Application Version Phraselist Features request:
          $ref: ./examples/features/SuccessfulGetApplicationVersionPhraselistFeaturesRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Phraselists
      tags:
      - Apps
  /apps/{appId}/versions/{versionId}/features:
    get:
      description: Gets all the extraction phraselist and pattern features in a version of the application.
      operationId: microsoftAzureFeaturesList
      parameters:
      - $ref: '#/parameters/AppIdInPath'
      - $ref: '#/parameters/VersionIdInPath'
      - $ref: '#/parameters/SkipInPath'
      - $ref: '#/parameters/TakeInPath'
      responses:
        '200':
          description: A list of all phraselist features and a list of all pattern features.
          schema:
            $ref: '#/definitions/FeaturesResponseObject'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
      - application/json
      x-ms-examples:
        Successful Get Application Version Features request:
          $ref: ./examples/features/SuccessfulGetApplicationVersionFeaturesRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Features
      tags:
      - Apps
  /apps/{appId}/versions/{versionId}/phraselists/{phraselistId}:
    get:
      description: Gets phraselist feature info in a version of the application.
      operationId: microsoftAzureFeaturesGetphraselist
      parameters:
      - $ref: '#/parameters/AppIdInPath'
      - $ref: '#/parameters/VersionIdInPath'
      - name: phraselistId
        in: path
        description: The ID of the feature to be retrieved.
        required: true
        type: integer
      responses:
        '200':
          description: A phraselist feature info.
          schema:
            $ref: '#/definitions/PhraseListFeatureInfo'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
      - application/json
      x-ms-examples:
        Successful Get Phraselist Feature Info request:
          $ref: ./examples/features/SuccessfulGetPhraselistFeatureInfoRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Phraselists Phraselistid
      tags:
      - Apps
    put:
      description: Updates the phrases, the state and the name of the phraselist feature in a version of the application.
      operationId: microsoftAzureFeaturesUpdatephraselist
      parameters:
      - $ref: '#/parameters/AppIdInPath'
      - $ref: '#/parameters/VersionIdInPath'
      - name: phraselistId
        in: path
        description: The ID of the feature to be updated.
        required: true
        type: integer
      - name: phraselistUpdateObject
        in: body
        schema:
          $ref: '#/definitions/PhraselistUpdateObject'
        description: 'The new values for: - Just a boolean called IsActive, in which case the status of the feature will be changed. - Name, Pattern, Mode, and a boolean called IsActive to update the feature.'
      consumes:
      - application/json
      responses:
        '200':
          description: Successfully updated phraselist.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
      - application/json
      x-ms-examples:
        Successful Update Phraselist Feature Info request:
          $ref: ./examples/features/SuccessfulUpdatePhraselistFeatureInfoRequest.json
      summary: Microsoft Azure Put Apps Appid Versions Versionid Phraselists Phraselistid
      tags:
      - Apps
    delete:
      description: Deletes a phraselist feature from a version of the application.
      operationId: microsoftAzureFeaturesDeletephraselist
      parameters:
      - $ref: '#/parameters/AppIdInPath'
      - $ref: '#/parameters/VersionIdInPath'
      - name: phraselistId
        in: path
        description: The ID of the feature to be deleted.
        required: true
        type: integer
      responses:
        '200':
          description: Successfully deleted phraselist.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
      - application/json
      x-ms-examples:
        Successful Delete Phraselist Feature Info request:
          $ref: ./examples/features/SuccessfulDeletePhraselistFeatureInfoRequest.json
      summary: Microsoft Azure Delete Apps Appid Versions Versionid Phraselists Phraselistid
      tags:
      - Apps
  /apps/{appId}/versions/{versionId}/example:
    post:
      description: Adds a labeled example utterance in a version of the application.
      operationId: microsoftAzureExamplesAdd
      parameters:
      - $ref: '#/parameters/AppIdInPath'
      - $ref: '#/parameters/VersionIdInPath'
      - $ref: '#/parameters/EnableNestedChildren'
      - name: exampleLabelObject
        in: body
        required: true
        schema:
          $ref: '#/definitions/ExampleLabelObject'
        description: A labeled example utterance with the expected intent and entities.
      consumes:
      - application/json
      responses:
        '201':
          description: The ID of the created example utterance.
          schema:
            $ref: '#/definitions/LabelExampleResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
      - application/json
      x-ms-examples:
        Successful Add Label request:
          $ref: ./examples/examples/SuccessfulAddLabelRequest.json
      summary: Microsoft Azure Post Apps Appid Versions Versionid Example
      tags:
      - Apps
  /apps/{appId}/versions/{versionId}/examples:
    post:
      description: Adds a batch of labeled example utterances to a version of the application.
      operationId: microsoftAzureExamplesBatch
      parameters:
      - $ref: '#/parameters/AppIdInPath'
      - $ref: '#/parameters/VersionIdInPath'
      - $ref: '#/parameters/EnableNestedChildren'
      - name: exampleLabelObjectArray
        in: body
        required: true
        schema:
          $ref: '#/definitions/ExampleLabelObjectArray'
        description: Array of example utterances.
      consumes:
      - application/json
      responses:
        '201':
          description: A string array determining which labeled example utterances were added successfully.
          schema:
            $ref: '#/definitions/BatchLabelExampleResponse'
        '207':
          description: Indicates that the request was partially successful. The response contains a string array indicating the status of each of the added labeled example utterances.
          schema:
            $ref: '#/definitions/BatchLabelExampleResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
      - application/json
      x-ms-examples:
        Successful Batch Add Labels request:
          $ref: ./examples/examples/SuccessfulBatchAddLabelsRequest.json
      summary: Microsoft Azure Post Apps Appid Versions Versionid Examples
      tags:
      - Apps
    get:
      description: Returns example utterances to be reviewed from a version of the application.
      operationId: microsoftAzureExamplesList
      parameters:
      - $ref: '#/parameters/AppIdInPath'
      - $ref: '#/parameters/VersionIdInPath'
      - $ref: '#/parameters/SkipInPath'
      - $ref: '#/parameters/TakeInPath'
      - $ref: '#/parameters/EnableNestedChildren'
      responses:
        '200':
          description: A list of predictions and label pairs for every example utterance in the application.
          schema:
            $ref: '#/definitions/LabeledUtterances'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
      - application/json
      x-ms-examples:
        Successful Review Labeled Examples request:
          $ref: ./examples/examples/SuccessfulReviewLabeledExamplesRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Examples
      tags:
      - Apps
  /apps/{appId}/versions/{versionId}/examples/{exampleId}:
    delete:
      description: Deletes the labeled example utterances with the specified ID from a version of the application.
      operationId: microsoftAzureExamplesDelete
      parameters:
      - $ref: '#/parameters/AppIdInPath'
      - $ref: '#/parameters/VersionIdInPath'
      - name: exampleId
        in: path
        description: The example ID.
        required: true
        type: integer
        format: int64
      responses:
        '200':
          description: Successfully deleted example utterance.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
      - application/json
      x-ms-examples:
        Successful Delete Example Label request:
          $ref: ./examples/examples/SuccessfulDeleteExampleLabelRequest.json
      summary: Microsoft Azure Delete Apps Appid Versions Versionid Examples Exampleid
      tags:
      - Apps
  /apps/{appId}/versions/{versionId}/intents:
    post:
      description: Adds an intent to a version of the application.
      operationId: microsoftAzureModelAddintent
      parameters:
      - $ref: '#/parameters/AppIdInPath'
      - $ref: '#/parameters/VersionIdInPath'
      - name: intentCreateObject
        in: body
        required: true
        schema:
          $ref: '#/definitions/ModelCreateObject'
        description: A model object containing the name of the new intent.
      consumes:
      - application/json
      responses:
        '201':
          description: The ID of the created intent model.
          x-nullable: false
          schema:
            $ref: '#/definitions/GuidResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
      - application/json
      x-ms-examples:
        Successful Create Intent Classifier request:
          $ref: ./examples/model/SuccessfulCreateIntentClassifierRequest.json
      summary: Microsoft Azure Post Apps Appid Versions Versionid Intents
      tags:
      - Apps
    get:
      description: Gets information about the intent models in a version of the application.
      operationId: microsoftAzureModelListintents
      parameters:
      - $ref: '#/parameters/AppIdInPath'
      - $ref: '#/parameters/VersionIdInPath'
      - $ref: '#/parameters/SkipInPath'
      - $ref: '#/parameters/TakeInPath'
      responses:
        '200':
          description: A list of intent model infos.
          schema:
            $ref: '#/definitions/IntentClassifiersList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
      - application/json
      x-ms-examples:
        Successful Get Application Version Intent Infos request:
          $ref: ./examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Intents
      tags:
      - Apps
  /apps/{appId}/versions/{versionId}/entities:
    post:
      description: Adds an entity extractor to a version of the application.
      operationId: microsoftAzureModelAddentity
      parameters:
      - $ref: '#/parameters/AppIdInPath'
      - $ref: '#/parameters/VersionIdInPath'
      - name: entityModelCreateObject
        in: body
        required: true
        schema:
          $ref: '#/definitions/EntityModelCreateObject'
        description: A model object containing the name of the new entity extractor and its children.
      consumes:
      - application/json
      responses:
        '201':
          description: The ID of the created model.
          x-nullable: false
          schema:
            $ref: '#/definitions/GuidResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
      - application/json
      x-ms-examples:
        Successful Create Entity Extractor request:
          $ref: ./examples/model/SuccessfulCreateEntityExtractorRequest.json
      summary: Microsoft Azure Post Apps Appid Versions Versionid Entities
      tags:
      - Apps
    get:
      description: Gets information about all the simple entity models in a version of the application.
      operationId: microsoftAzureModelListentities
      parameters:
      - $ref: '#/parameters/AppIdInPath'
      - $ref: '#/parameters/VersionIdInPath'
      - $ref: '#/parameters/SkipInPath'
      - $ref: '#/parameters/TakeInPath'
      responses:
        '200':
          description: A list of entity model infos.
          schema:
            $ref: '#/definitions/NDepthEntityExtractorsList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
      - application/json
      x-ms-examples:
        Successful Get Application Version Entity Infos request:
          $ref: ./examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Entities
      tags:
      - Apps
  /apps/{appId}/versions/{versionId}/hierarchicalentities:
    get:
      description: Gets information about all the hierarchical entity models in a version of the application.
      operationId: microsoftAzureModelListhierarchicalentities
      parameters:
      - $ref: '#/parameters/AppIdInPath'
      - $ref: '#/parameters/VersionIdInPath'
      - $ref: '#/parameters/SkipInPath'
      - $ref: '#/parameters/TakeInPath'
      responses:
        '200':
          description: A list of hierarchical entity model infos.
          schema:
            $ref: '#/definitions/HierarchicalEntityExtractorsList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
      - application/json
      x-ms-examples:
        Successful Get Application Version Hierarchical Entity Infos request:
          $ref: ./examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Hierarchicalentities
      tags:
      - Apps
  /apps/{appId}/versions/{versionId}/compositeentities:
    get:
      description: Gets information about all the composite entity models in a version of the application.
      operationId: microsoftAzureModelListcompositeentities
      parameters:
      - $ref: '#/parameters/AppIdInPath'
      - $ref: '#/parameters/VersionIdInPath'
      - $ref: '#/parameters/SkipInPath'
      - $ref: '#/parameters/TakeInPath'
      responses:
        '200':
          description: A list of composite entity model infos.
          schema:
            $ref: '#/definitions/CompositeEntityExtractorsList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
      - application/json
      x-ms-examples:
        Successful Get Application Version Composite Entity Infos request:
          $ref: ./examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Compositeentities
      tags:
      - Apps
  /apps/{appId}/versions/{versionId}/closedlists:
    get:
      description: Gets information about all the list entity models in a version of the application.
      operationId: microsoftAzureModelListclosedlists
      parameters:
      - $ref: '#/parameters/AppIdInPath'
      - $ref: '#/parameters/VersionIdInPath'
      - $ref: '#/parameters/SkipInPath'
      - $ref: '#/parameters/TakeInPath'
      responses:
        '200':
          description: A list of list entity model infos.
          schema:
            $ref: '#/definitions/ClosedListEntityExtractorsList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
      - application/json
      x-ms-examples:
        Successful Get Application Version Closed List Infos request:
          $ref: ./examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Closedlists
      tags:
      - Apps
    post:
      description: Adds a list entity model to a version of the application.
      operationId: microsoftAzureModelAddclosedlist
      parameters:
      - $ref: '#/parameters/AppIdInPath'
      - $ref: '#/parameters/VersionIdInPath'
      - name: closedListModelCreateObject
        in: body
        required: true
        schema:
          $ref: '#/definitions/ClosedListModelCreateObject'
        description: A model containing the name and words for the new list entity extractor.
      consumes:
      - application/json
      responses:
        '201':
          description: The ID of the created model.
          x-nullable: false
          schema:
            $ref: '#/definitions/GuidResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
      - application/json
      x-ms-examples:
        Successful Create Closed List Entity Model request:
          $ref: ./examples/model/SuccessfulCreateClosedListEntityModelRequest.json
      summary: Microsoft Azure Post Apps Appid Versions Versionid Closedlists
      tags:
      - Apps
  /apps/{appId}/versions/{versionId}/prebuilts:
    post:
      description: Adds a list of prebuilt entities to a version of the application.
      operationId: microsoftAzureModelAddprebuilt
      parameters:
      - $ref: '#/parameters/AppIdInPath'
      - $ref: '#/parameters/VersionIdInPath'
      - name: prebuiltExtractorNames
        in: body
        required: true
        schema:
          $ref: '#/definitions/PrebuiltExtractorNames'
        description: An array of prebuilt entity extractor names.
      consumes:
      - application/json
      responses:
        '201':
          description: An array of the created prebuilt extractor infos.
          schema:
            $ref: '#/definitions/PrebuiltEntityExtractorsList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
      - application/json
      x-ms-examples:
        Successful Add Application Version Prebuilt Infos request:
          $ref: ./examples/model/SuccessfulAddApplicationVersionPrebuiltInfosRequest.json
      summary: Microsoft Azure Post Apps Appid Versions

# --- truncated at 32 KB (265 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-apps-api-openapi.yml