Microsoft Azure Conversions API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Conversions API
schemes:
- https
tags:
- name: Conversions
paths:
  /conversions:
    post:
      x-publish: true
      description: '**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).<br><br>Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.<br><br>The Conversion API lets the caller import a set of DWG design files as a zipped [Drawing Package](https://aka.ms/am-drawing-package) into Azure Maps. The [Drawing Package](https://aka.ms/am-drawing-package) should first be uploaded using the [Azure Maps Data Service](https://docs.microsoft.com/rest/api/maps/data). Once uploaded, use the `udid` returned by the [Data Upload API](https://docs.microsoft.com/rest/api/maps/data-v2/upload-preview) to call this Conversion API.<br><br>## Convert DWG package<br><br>The Conversion API performs a [long-running operation](https://aka.ms/am-creator-lrt-v2).<br><br>## Debug DWG package issues<br><br><br>During the Conversion process, if there are any issues with the DWG package [errors and warnings](https://aka.ms/am-conversion-errors) are provided in the response along with a *diagnostic package* to visualize and diagnose these issues. In case any issues are encountered with your DWG package, the Conversion operation status process as detailed [here](https://aka.ms/am-creator-lrt-v2) returns the location of the *diagnostic package* that can be downloaded by the caller to help them visualize and diagnose these issues. The *diagnostic package* location can be found in the properties section of the conversion operation status response and looks like the following:<br><br>```json<br>{<br>    "properties": {<br>        "diagnosticPackageLocation": "https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0"                <br>    }            <br>}<br>```<br><br>The *diagnostic package* can be downloaded by executing a `HTTP GET` request on the `diagnosticPackageLocation`.<br>For more details on how to use the tool to visualize and diagnose all the errors and warnings see [Drawing Error Visualizer](https://aka.ms/am-drawing-errors-visualizer). <br><br>A conversion operation will be marked as *success* if there are zero or more warnings but will be marked as *failed* if any errors are encountered. '
      operationId: microsoftAzureConversionConvert
      x-ms-examples:
        Convert previously uploaded DWG Package:
          $ref: ./examples/Conversion.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/UdidQuery'
      - $ref: '#/parameters/OutputOntology'
      - $ref: '#/parameters/DescriptionDwgConversion'
      responses:
        '202':
          $ref: '#/responses/202Accepted'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      summary: Microsoft Azure Post Conversions
      tags:
      - Conversions
    get:
      x-publish: true
      description: '**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).<br><br>Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.<br><br>This API allows the caller to fetch a list of all successful data conversions submitted previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert).   <br><br>### Submit List Request<br><br>To list all successful conversions you will issue a `GET` request with no additional parameters.<br><br>### List Data Response<br><br>The Conversion List API returns the complete list of all conversion details in `json` format.<br><br>Here is a sample response returning the details of two successful conversion requests:  <br><br><br><br>```json<br>{<br>    "conversions": <br>    [<br>        {<br>            "conversionId": "54398242-ea6c-1f31-4fa6-79b1ae0fc24d",<br>            "udid": "31838736-8b84-11ea-bc55-0242ac130003",<br>            "created": "5/19/2020 9:00:00 AM +00:00",<br>            "description": "User provided description.",<br>            "featureCounts": {<br>                "DIR": 1,<br>                "LVL": 3,<br>                "FCL": 1,<br>                "UNIT": 150,<br>                "CTG": 8,<br>                "AEL": 0,<br>                "OPN": 10<br>            }<br>        },<br>        {<br>            "conversionId": "2acf7d32-8b84-11ea-bc55-0242ac130003",<br>            "udid": "1214bc58-8b84-11ea-bc55-0242ac1300039",<br>            "created": "5/19/2020 9:00:00 AM +00:00",<br>            "description": "User provided description.",<br>            "featureCounts": {<br>                "DIR": 1,<br>                "LVL": 3,<br>                "FCL": 1,<br>                "UNIT": 150,<br>                "CTG": 8,<br>                "AEL": 0,<br>                "OPN": 10<br>            }<br>        }<br>    ]<br>}<br>```<br><br>'
      operationId: microsoftAzureConversionList
      x-ms-examples:
        Returns a list of all the data processed by the Conversion Service for the account:
          $ref: ./examples/List.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      responses:
        '200':
          description: List request completed successfully.
          schema:
            $ref: '#/definitions/ConversionListResponse'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      summary: Microsoft Azure Get Conversions
      tags:
      - Conversions
  /conversions/{conversionId}:
    get:
      x-publish: true
      description: '**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).<br><br>Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.<br><br>This API allows the caller to fetch a successful data conversion submitted previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert).  '
      operationId: microsoftAzureConversionGet
      x-ms-examples:
        Get the details for one conversion operation:
          $ref: ./examples/Get.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ConversionId'
      responses:
        '200':
          description: Returns details of the specified conversion.
          schema:
            $ref: '#/definitions/ConversionListDetailInfo'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      summary: Microsoft Azure Get Conversions Conversionid
      tags:
      - Conversions
    delete:
      x-publish: true
      description: '**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).<br><br>Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.<br><br>This API allows the caller to delete any data conversions created previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert).<br><br>### Submit Delete Request<br><br>To delete your conversion data you will issue a `DELETE` request where the path will contain the `conversionId` of the data to delete.<br><br>### Conversion Delete Response<br><br>The Conversion Delete API returns a HTTP `204 No Content` response with an empty body, if the converted data resources were deleted successfully.    <br>A HTTP `400 Bad Request` error response will be returned if no resource associated with the passed-in `conversionId` is found.    '
      operationId: microsoftAzureConversionDelete
      x-ms-examples:
        Delete previously converted content:
          $ref: ./examples/Delete.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ConversionId'
      responses:
        '204':
          description: Conversion delete request completed successfully. The content for `conversionId` was deleted on the server.
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      summary: Microsoft Azure Delete Conversions Conversionid
      tags:
      - Conversions
  /conversions/operations/{operationId}:
    get:
      description: This path will be obtained from a call to POST /conversions.  While in progress, an http200 will be returned with no extra headers -  followed by an http200 with Resource-Location header once successfully completed.
      operationId: microsoftAzureConversionGetoperation
      x-ms-examples:
        Get the status of an operation which is still running:
          $ref: ./examples/GetOperationStillRunning.json
        Get the status of an operation which has finished successfully, with non-fatal warnings:
          $ref: ./examples/GetOperation.json
      parameters:
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ConversionOperationId'
      responses:
        '200':
          $ref: '#/responses/200Async'
        '400':
          $ref: '#/responses/400'
      summary: Microsoft Azure Get Conversions Operations Operationid
      tags:
      - Conversions
definitions:
  ODataErrorResponse:
    type: object
    description: This response object is returned when an error occurs in the Azure Maps API.
    properties:
      error:
        $ref: '#/definitions/ODataError'
  ConversionListDetailInfo:
    description: Detail information for the conversion requests.
    type: object
    properties:
      conversionId:
        description: A unique id that represents the artifact of a _successfully_ completed conversion process.
        type: string
        readOnly: true
      ontology:
        description: The ontology version of this dataset.
        type: string
        readOnly: true
      udid:
        description: The unique id of the content provided to create this conversion.
        type: string
        readOnly: true
      created:
        description: The date and time of this conversion.
        type: string
        readOnly: true
      description:
        description: User provided description of the content being converted.
        type: string
        readOnly: true
      featureCounts:
        description: A summary of feature counts in this conversion.
        type: object
        readOnly: true
  ConversionListResponse:
    description: The response model for the Conversion List API.
    type: object
    properties:
      conversions:
        description: A list of all the previously submitted conversion requests.
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/ConversionListDetailInfo'
      nextLink:
        description: If present, the location of the next page of data.
        type: string
        readOnly: true
  LongRunningOperationResult:
    description: The response model for a Long-Running Operations API.
    type: object
    properties:
      operationId:
        description: The Id for this long-running operation.
        type: string
      status:
        description: The status state of the request.
        type: string
        enum:
        - NotStarted
        - Running
        - Failed
        - Succeeded
        x-ms-enum:
          name: type
          modelAsString: true
          values:
          - value: NotStarted
            description: The request has not started processing yet.
          - value: Running
            description: The request has started processing.
          - value: Failed
            description: The request has one or more failures.
          - value: Succeeded
            description: The request has successfully completed.
        readOnly: true
      created:
        description: The created timestamp.
        type: string
        readOnly: true
      error:
        $ref: '#/definitions/ODataError'
      warning:
        $ref: '#/definitions/ODataError'
  ODataError:
    type: object
    description: This object is returned when an error occurs in the Azure Maps API.
    properties:
      code:
        type: string
        readOnly: true
        description: The ODataError code.
      message:
        type: string
        readOnly: true
        description: If available, a human-readable description of the error.
      details:
        type: array
        items:
          $ref: '#/definitions/ODataError'
      target:
        type: string
        readOnly: true
        description: If available, the target causing the error.
parameters:
  ConversionOperationId:
    name: operationId
    type: string
    in: path
    description: The ID to query the status for the Conversion create/import request.
    required: true
    x-ms-parameter-location: method
  DescriptionDwgConversion:
    name: description
    description: User provided description of the content being converted.
    type: string
    in: query
    required: false
    x-ms-parameter-location: method
  SubscriptionKey:
    name: subscription-key
    description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.
    type: string
    in: query
    required: false
    x-ms-parameter-location: client
  ApiVersion:
    name: api-version
    description: Version number of Azure Maps API. Current version is 2.0
    type: string
    in: query
    required: true
    default: '2.0'
    x-ms-parameter-location: client
  ClientId:
    name: x-ms-client-id
    description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model.  It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management  plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
    type: string
    in: header
    required: false
    x-ms-parameter-location: client
  OutputOntology:
    name: outputOntology
    description: Output ontology version. "facility-2.0" is the only supported value at this time. Please refer to this [article](https://docs.microsoft.com/en-us/azure/azure-maps/creator-facility-ontology) for more information about Azure Maps Creator ontologies.
    type: string
    in: query
    required: true
    x-ms-parameter-location: method
  UdidQuery:
    name: udid
    description: The unique data id for the content. The `udid` must have been obtained from a successful [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview) call.
    type: string
    in: query
    required: true
    x-ms-parameter-location: method
  ConversionId:
    name: conversionId
    description: The conversion id for the content. The `conversionId` must have been obtained from a successful [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert) call.
    type: string
    in: path
    required: true
    x-ms-parameter-location: method
responses:
  '500':
    description: An error occurred while processing the request. Please try again later.
    schema:
      $ref: '#/definitions/ODataErrorResponse'
  200Async:
    description: The operation is running or complete.  If the operation was successful, use the Resource-Location header to obtain the path to the result.
    schema:
      $ref: '#/definitions/LongRunningOperationResult'
    headers:
      Resource-Location:
        type: string
        description: If successful, a URI where details on the newly created resource can be found.
  202Accepted:
    description: 'Request Accepted: The request has been accepted for processing. Please use the URL in the Operation-Location Header to obtain status.'
    headers:
      Operation-Location:
        type: string
        description: New URL to check for the results of the [long-running operation](https://aka.ms/am-creator-lrt-v2).
  '404':
    description: 'Not Found: the requested resource could not be found, but it may be available again in the future.'
    schema:
      $ref: '#/definitions/ODataErrorResponse'
  '401':
    description: Access denied due to invalid subscription key or invalid Microsoft Entra ID bearer token.  Make sure to provide a valid key for an active Azure subscription and Maps resource.  Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Microsoft Entra ID bearer token.
    schema:
      $ref: '#/definitions/ODataErrorResponse'
    headers:
      WWW-Authenticate:
        type: string
        description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired"
  '400':
    description: 'Bad request: one or more parameters were incorrectly specified or are mutually exclusive.'
    schema:
      $ref: '#/definitions/ODataErrorResponse'
  '403':
    description: Permission, capacity, or authentication issues.
    schema:
      $ref: '#/definitions/ODataErrorResponse'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'