Microsoft Azure Conversions API

openapi: 3.2.0
info:
  title: Microsoft Azure Azure Maps Conversion Service Conversions…
  version: '2.0'
  description: APIs for converting DWG Packages in Azure Maps.
security:
- AADToken:
  - https://atlas.microsoft.com/.default
- SharedKey: []
- SasToken: []
tags:
- name: Conversions
paths:
  /conversions:
    post:
      x-publish: true
      description: '**Applies to:** see pricing tiers.


        Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. This article introduces concepts and tools that apply to Azure Maps Creator.


        The Conversion API lets the caller import a set of DWG design files as a zipped Drawing Package into Azure Maps. The Drawing Package should first be uploaded using the Azure Maps Data Service. Once uploaded, use the `udid` returned by the Data Upload API to call this Conversion API.


        ## Convert DWG package


        The Conversion API performs a long-running operation.


        ## Debug DWG package issues


        During the Conversion process, if there are any issues with the DWG package errors and warnings 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 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:


        ```json

        {

        "properties": {

        "diagnosticPackageLocation": "https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0"

        }

        }

        ```


        The *diagnostic package* can be downloaded by executing a `HTTP GET` request on the `diagnosticPackageLocation`.

        For more details on how to use the tool to visualize and diagnose all the errors and warnings see Drawing Error Visualizer.


        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: '#/components/parameters/ClientId'
      - $ref: '#/components/parameters/SubscriptionKey'
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/UdidQuery'
      - $ref: '#/components/parameters/OutputOntology'
      - $ref: '#/components/parameters/DescriptionDwgConversion'
      responses:
        '202':
          $ref: '#/components/responses/202Accepted'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      summary: Microsoft Azure Post Conversions
      tags:
      - Conversions
    get:
      x-publish: true
      description: '**Applies to:** see pricing tiers.


        Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. This article introduces concepts and tools that apply to Azure Maps Creator.


        This API allows the caller to fetch a list of all successful data conversions submitted previously using the Conversion API.


        ### Submit List Request


        To list all successful conversions you will issue a `GET` request with no additional parameters.


        ### List Data Response


        The Conversion List API returns the complete list of all conversion details in `json` format.


        Here is a sample response returning the details of two successful conversion requests:


        ```json

        {

        "conversions":

        [

        {

        "conversionId": "54398242-ea6c-1f31-4fa6-79b1ae0fc24d",

        "udid": "31838736-8b84-11ea-bc55-0242ac130003",

        "created": "5/19/2020 9:00:00 AM +00:00",

        "description": "User provided description.",

        "featureCounts": {

        "DIR": 1,

        "LVL": 3,

        "FCL": 1,

        "UNIT": 150,

        "CTG": 8,

        "AEL": 0,

        "OPN": 10

        }

        },

        {

        "conversionId": "2acf7d32-8b84-11ea-bc55-0242ac130003",

        "udid": "1214bc58-8b84-11ea-bc55-0242ac1300039",

        "created": "5/19/2020 9:00:00 AM +00:00",

        "description": "User provided description.",

        "featureCounts": {

        "DIR": 1,

        "LVL": 3,

        "FCL": 1,

        "UNIT": 150,

        "CTG": 8,

        "AEL": 0,

        "OPN": 10

        }

        }

        ]

        }

        ```'
      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: '#/components/parameters/ClientId'
      - $ref: '#/components/parameters/SubscriptionKey'
      - $ref: '#/components/parameters/ApiVersion'
      responses:
        '200':
          description: List request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConversionListResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      summary: Microsoft Azure Get Conversions
      tags:
      - Conversions
  /conversions/{conversionId}:
    get:
      x-publish: true
      description: '**Applies to:** see pricing tiers.


        Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. This article introduces concepts and tools that apply to Azure Maps Creator.


        This API allows the caller to fetch a successful data conversion submitted previously using the Conversion API.'
      operationId: microsoftAzureConversionGet
      x-ms-examples:
        Get the details for one conversion operation:
          $ref: ./examples/Get.json
      parameters:
      - $ref: '#/components/parameters/ClientId'
      - $ref: '#/components/parameters/SubscriptionKey'
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/ConversionId'
      responses:
        '200':
          description: Returns details of the specified conversion.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConversionListDetailInfo'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      summary: Microsoft Azure Get Conversions Conversionid
      tags:
      - Conversions
    delete:
      x-publish: true
      description: '**Applies to:** see pricing tiers.


        Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. This article introduces concepts and tools that apply to Azure Maps Creator.


        This API allows the caller to delete any data conversions created previously using the Conversion API.


        ### Submit Delete Request


        To delete your conversion data you will issue a `DELETE` request where the path will contain the `conversionId` of the data to delete.


        ### Conversion Delete Response


        The Conversion Delete API returns a HTTP `204 No Content` response with an empty body, if the converted data resources were deleted successfully.

        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: '#/components/parameters/ClientId'
      - $ref: '#/components/parameters/SubscriptionKey'
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/ConversionId'
      responses:
        '204':
          description: Conversion delete request completed successfully. The content for `conversionId` was deleted on the server.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/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: '#/components/parameters/SubscriptionKey'
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/ConversionOperationId'
      responses:
        '200':
          $ref: '#/components/responses/200Async'
        '400':
          $ref: '#/components/responses/400'
      summary: Microsoft Azure Get Conversions Operations Operationid
      tags:
      - Conversions
components:
  parameters:
    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.
      in: path
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    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.
      in: header
      required: false
      x-ms-parameter-location: client
      schema:
        type: string
    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.
      in: query
      required: false
      x-ms-parameter-location: client
      schema:
        type: string
    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.
      in: query
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    DescriptionDwgConversion:
      name: description
      description: User provided description of the content being converted.
      in: query
      required: false
      x-ms-parameter-location: method
      schema:
        type: string
    ApiVersion:
      name: api-version
      description: Version number of Azure Maps API. Current version is 2.0
      in: query
      required: true
      x-ms-parameter-location: client
      schema:
        type: string
        default: '2.0'
    ConversionOperationId:
      name: operationId
      in: path
      description: The ID to query the status for the Conversion create/import request.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    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.
      in: query
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
  schemas:
    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: '#/components/schemas/ConversionListDetailInfo'
        nextLink:
          description: If present, the location of the next page of data.
          type: string
          readOnly: true
    ODataErrorResponse:
      type: object
      description: This response object is returned when an error occurs in the Azure Maps API.
      properties:
        error:
          $ref: '#/components/schemas/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: '#/components/schemas/ODataError'
        target:
          type: string
          readOnly: true
          description: If available, the target causing the error.
    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
    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: '#/components/schemas/ODataError'
        warning:
          $ref: '#/components/schemas/ODataError'
  responses:
    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.
      headers:
        Resource-Location:
          description: If successful, a URI where details on the newly created resource can be found.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LongRunningOperationResult'
    '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.
      headers:
        WWW-Authenticate:
          description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired"
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ODataErrorResponse'
    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:
          description: New URL to check for the results of the [long-running operation](https://aka.ms/am-creator-lrt-v2).
          schema:
            type: string
    '500':
      description: An error occurred while processing the request. Please try again later.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ODataErrorResponse'
    '404':
      description: 'Not Found: the requested resource could not be found, but it may be available again in the future.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ODataErrorResponse'
    '400':
      description: 'Bad request: one or more parameters were incorrectly specified or are mutually exclusive.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ODataErrorResponse'
    '403':
      description: Permission, capacity, or authentication issues.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ODataErrorResponse'
  securitySchemes:
    AADToken:
      type: oauth2
      flows:
        implicit:
          scopes:
            https://atlas.microsoft.com/.default: https://atlas.microsoft.com/.default
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: "These are the [Microsoft Entra OAuth 2.0](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a  built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview)."
    SharedKey:
      type: apiKey
      description: "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored."
      name: subscription-key
      in: query
    SasToken:
      type: apiKey
      description: "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token."
      name: SAS Token
      in: header
x-ms-parameterized-host:
  hostTemplate: '{geography}.atlas.microsoft.com'
  parameters:
  - $ref: '#/components/parameters/GeographicResourceLocation'