dataset.json

{
  "swagger": "2.0",
  "info": {
    "title": "Azure Maps Dataset Service",
    "version": "2.0",
    "description": "APIs for managing datasets from uploaded data in Azure Maps."
  },
  "x-ms-parameterized-host": {
    "hostTemplate": "{geography}.atlas.microsoft.com",
    "parameters": [
      {
        "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation"
      }
    ]
  },
  "schemes": [
    "https"
  ],
  "consumes": [],
  "produces": [
    "application/json"
  ],
  "securityDefinitions": {
    "AADToken": {
      "type": "oauth2",
      "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
      "flow": "implicit",
      "description": "These are the [Microsoft Entra OAuth 2.0](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/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 Microsoft Entra ID 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).",
      "scopes": {
        "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default"
      }
    },
    "SharedKey": {
      "type": "apiKey",
      "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](/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](/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"
    }
  },
  "security": [
    {
      "AADToken": [
        "https://atlas.microsoft.com/.default"
      ]
    },
    {
      "SharedKey": []
    },
    {
      "SasToken": []
    }
  ],
  "responses": {},
  "parameters": {
    "ApiVersion": {
      "name": "api-version",
      "description": "Version number of Azure Maps API.",
      "type": "string",
      "in": "query",
      "required": true,
      "default": "2.0",
      "x-ms-parameter-location": "client"
    },
    "ConversionIdQuery": {
      "name": "conversionId",
      "description": "The unique ID used to create the dataset. The `conversionId` must have been obtained from a successful call to the Conversion service [Convert API](/rest/api/maps-creator/conversion/convert) and may be provided with multiple query parameters with same name (if more than one is provided).",
      "type": "string",
      "in": "query",
      "required": true,
      "x-ms-parameter-location": "method"
    },
    "DatasetDescription": {
      "name": "description",
      "description": "The description to be given to the dataset.",
      "type": "string",
      "in": "query",
      "x-ms-parameter-location": "method"
    },
    "DatasetId": {
      "name": "datasetId",
      "type": "string",
      "in": "path",
      "description": "The identifier for the dataset to query from.",
      "required": true,
      "x-ms-parameter-location": "method"
    },
    "AppendDatasetId": {
      "name": "datasetId",
      "type": "string",
      "in": "query",
      "description": "The ID for the dataset to append with. The dataset must originate from a previous dataset creation call that matches the datasetId",
      "x-ms-parameter-location": "method"
    },
    "DatasetOperationId": {
      "name": "operationId",
      "type": "string",
      "in": "path",
      "description": "The ID to query the status for the dataset create/import request.",
      "required": true,
      "x-ms-parameter-location": "method"
    }
  },
  "paths": {
    "/datasets": {
      "post": {
        "summary": "Use to create a dataset.",
        "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Create` API is an HTTP `POST` request that takes the `conversionId` value of the converted drawing package and returns the `datasetId` property of the newly created dataset. For more information, see [Create a dataset](/azure/azure-maps/tutorial-creator-indoor-maps#create-a-dataset).\n\nYou can use this request in a scenario like uploading a DWG zip package for a building, converting the zip package using the Azure Maps [Conversion](/rest/api/maps-creator/conversion) service, and creating a dataset from the converted zip package. The created dataset can be used to create tilesets using the Azure Maps [Tileset](/rest/api/maps-creator/tileset) service and can be queried via the Azure Maps [WFS](/rest/api/maps-creator/wfs) service.\n\n### Submit Create Request\n\nTo create your dataset, you will use a `POST` request where the `conversionId` query parameter is an ID that represents the converted DWG zip package, the `datasetId` parameter is the ID of a previously created dataset to append with the current dataset and, optionally, the `description` query parameter will contain a description (if description is not provided a default description will be given).\n\nThe Create API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).",
        "operationId": "Dataset_Create",
        "x-ms-long-running-operation": true,
        "x-ms-long-running-operation-options": {
          "final-state-via": "location"
        },
        "x-ms-examples": {
          "Create dataset from a converted CAD file provided by conversionId": {
            "$ref": "./examples/dataset/Dataset_Create.json"
          }
        },
        "parameters": [
          {
            "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
          },
          {
            "$ref": "#/parameters/ApiVersion"
          },
          {
            "$ref": "#/parameters/ConversionIdQuery"
          },
          {
            "$ref": "#/parameters/AppendDatasetId"
          },
          {
            "$ref": "#/parameters/DatasetDescription"
          }
        ],
        "responses": {
          "200": {
            "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2"
          },
          "202": {
            "$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2"
          },
          "default": {
            "$ref": "../../../Common/preview/1.0/common.json#/responses/default"
          }
        }
      },
      "get": {
        "summary": "Use to fetch a list of all existing datasets.",
        "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nTo list all your datasets, you will issue a `GET` request with no additional parameters.\n\n\n### List Data Response\n\nThe List API returns the complete list of all datasets in `json` format. The response contains the following fields (if they are not null or empty):\n> created - The timestamp the dataset was created.\n> datasetId - The id for the dataset.\n> description - The description for the dataset.\n> datasetSources - The source data that was used when the create request was issued.\n> ontology - The source [ontology](/azure/azure-maps/creator-facility-ontology) that was used in the conversion service for the input data.<br/>\n\nThe `datasetSources` describes the source data that was used when the create request was issued and contains the following elements (if they are not null or empty):\n\n> conversionIds - The list of `conversionId` (null if none were provided).\n> appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).\n>featureCounts - The counts for each feature type in the dataset.<br/>\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of 3 dataset resources:\n\n\n```json\n{\n  \"datasets\": [\n    {\n      \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n      \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n      \"description\": \"Some description or comment for the dataset.\",\n      \"datasetSources\": {\n        \"conversionIds\": [\n          \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n        ],      },\n      \"\": \"facility-2.0\",\n      \"featureCounts\": {\n        \"directoryInfo\": 2,\n        \"category\": 10,\n        \"facility\": 1,\n        \"level\": 3,\n        \"unit\": 183,\n        \"zone\": 3,\n        \"verticalPenetration\": 6,\n        \"opening\": 48,\n        \"areaElement\": 108\n      }\n    },\n    {\n      \"timestamp\": \"2020-01-01T22:57:53.123Z\",\n      \"datasetId\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n      \"description\": \"Create from upload '0c1288fa-2058-4a1b-b68d-13a5f5af7d7c'.\",\n      \"datasetSources\": {\n        \"conversionIds\": [\n          \"0c1288fa-2058-4a1b-b68d-13a5f5af7d7c\"\n        ],\n        \"appendDatasetId\": \"46d1edb6-d29e-4786-9589-dbd4efd7a977\"\n      },\n      \"ontology\": \"facility-2.0\",\n      \"featureCounts\": {\n        \"directoryInfo\": 2,\n        \"category\": 10,\n        \"facility\": 1,\n        \"level\": 3,\n        \"unit\": 183,\n        \"zone\": 3,\n        \"verticalPenetration\": 6,\n        \"opening\": 48,\n        \"areaElement\": 108\n      }\n    }\n  ]\n}\n```",
        "operationId": "Dataset_List",
        "x-ms-examples": {
          "List all the previously created datasets": {
            "$ref": "./examples/dataset/Dataset_List.json"
          }
        },
        "parameters": [
          {
            "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
          },
          {
            "$ref": "#/parameters/ApiVersion"
          }
        ],
        "x-ms-pageable": {
          "itemName": "datasets",
          "nextLinkName": "nextLink"
        },
        "responses": {
          "200": {
            "description": "The dataset request completed successfully. The response body contains the previously created dataset.",
            "schema": {
              "$ref": "#/definitions/DatasetListResult"
            }
          },
          "default": {
            "$ref": "../../../Common/preview/1.0/common.json#/responses/default"
          }
        }
      }
    },
    "/datasets/{datasetId}": {
      "get": {
        "summary": "Use to get the details of a dataset.",
        "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Get Details Request\n\nTo get the details for a previously created dataset, you will issue a `GET` request with the `datasetId` in the path.\n\n### Get Details Response\n\nThe Get Details API returns the details for a dataset in `json` format. The response contains the following fields (if they are not null or empty):\n> created - The timestamp the dataset was created.\n> datasetId - The id for the dataset.\n> description - The description for the dataset.\n> datasetSources - The source data that was used when the create request was issued.\n> ontology - The source [ontology](/azure/azure-maps/creator-facility-ontology) that was used in the conversion service for the input data.<br/>\n\nThe `datasetSources` describes the source data that was used when the create request was issued and contains the following elements (if they are not null or empty):\n> conversionIds - The list of `conversionId` (null if none were provided).\n> appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).\n>featureCounts - The counts for each feature type in the dataset.<br/>\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of a dataset resource:\n\n```json\n{\n   \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n   \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n   \"description\": \"Some description or comment for the dataset.\",\n   \"datasetSources\": {\n     \"conversionIds\": [\n       \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n     ],\n   },\n   \"ontology\": \"facility-2.0\",\n   \"featureCounts\": {\n     \"directoryInfo\": 2,\n     \"category\": 10,\n     \"facility\": 1,\n     \"level\": 3,\n     \"unit\": 183,\n     \"zone\": 3,\n     \"verticalPenetration\": 6,\n     \"opening\": 48,\n     \"areaElement\": 108\n   }\n }\n```",
        "operationId": "Dataset_Get",
        "x-ms-examples": {
          "Get details for a previously created dataset": {
            "$ref": "./examples/dataset/Dataset_GetDetails.json"
          }
        },
        "parameters": [
          {
            "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
          },
          {
            "$ref": "#/parameters/DatasetId"
          },
          {
            "$ref": "#/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "The get dataset request completed successfully.",
            "schema": {
              "$ref": "#/definitions/Dataset"
            }
          },
          "default": {
            "$ref": "../../../Common/preview/1.0/common.json#/responses/default"
          }
        }
      },
      "delete": {
        "summary": "Use to delete the specified dataset.",
        "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `datasetId` of the dataset to delete.",
        "operationId": "Dataset_Delete",
        "x-ms-examples": {
          "Delete previously created dataset": {
            "$ref": "./examples/dataset/Dataset_Delete.json"
          }
        },
        "parameters": [
          {
            "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
          },
          {
            "$ref": "#/parameters/ApiVersion"
          },
          {
            "$ref": "#/parameters/DatasetId"
          }
        ],
        "responses": {
          "204": {
            "description": "The dataset delete request completed successfully. The resource referenced by the `datasetId` was deleted from the server."
          },
          "default": {
            "$ref": "../../../Common/preview/1.0/common.json#/responses/default"
          }
        }
      }
    },
    "/datasets/operations/{operationId}": {
      "get": {
        "summary": "Use to check the status of the dataset creation process.",
        "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Get Operation` API is an HTTP `GET` request used to check the status of the dataset creation process and retrieve the `datasetId` value.\n\n### Submit Operations Request\n\nTo view the current progress of a dataset operation, you will use a `GET` request where the `operationId` given the path is the ID that represents the operation.\n\n### Operation Response\n\nWhile in progress, a `200-OK` http status code is returned with no extra headers. If the operation succeeds, a `200-OK` http status code with Resource-Location header is returned.",
        "operationId": "Dataset_GetOperation",
        "x-ms-examples": {
          "Get the status of an operation which is still running": {
            "$ref": "./examples/dataset/Dataset_GetOperationStillRunning.json"
          },
          "Get the status of an operation which has finished successfully": {
            "$ref": "./examples/dataset/Dataset_GetOperation.json"
          }
        },
        "parameters": [
          {
            "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
          },
          {
            "$ref": "#/parameters/ApiVersion"
          },
          {
            "$ref": "#/parameters/DatasetOperationId"
          }
        ],
        "responses": {
          "200": {
            "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2"
          },
          "default": {
            "$ref": "../../../Common/preview/1.0/common.json#/responses/default"
          }
        }
      }
    }
  },
  "definitions": {
    "DatasetListResult": {
      "description": "The response model for the Dataset List API. The response body will contain a list of all the previously created datasets.",
      "type": "object",
      "properties": {
        "datasets": {
          "description": "A list of all the previously created datasets.",
          "type": "array",
          "readOnly": true,
          "items": {
            "$ref": "#/definitions/Dataset"
          }
        },
        "nextLink": {
          "description": "If present, the location of the next page of data.",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "Dataset": {
      "description": "Detail information for the dataset.",
      "type": "object",
      "properties": {
        "created": {
          "description": "The created timestamp for the dataset.",
          "type": "string",
          "format": "date-time",
          "readOnly": true
        },
        "datasetId": {
          "description": "The id for the dataset.",
          "type": "string",
          "readOnly": true
        },
        "ontology": {
          "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology"
        },
        "description": {
          "description": "The description for the dataset.",
          "type": "string",
          "readOnly": true
        },
        "datasetSources": {
          "$ref": "#/definitions/DatasetSources"
        },
        "featureCounts": {
          "description": "The feature counts for the dataset.",
          "type": "object",
          "readOnly": true
        }
      }
    },
    "DatasetSources": {
      "description": "Information about the details of the create request for the dataset.",
      "type": "object",
      "properties": {
        "conversionIds": {
          "description": "The list of `conversionId` that were used to create the dataset.",
          "type": "array",
          "readOnly": true,
          "items": {
            "type": "string"
          }
        },
        "appendDatasetId": {
          "description": "The dataset that was appended to to create the current dataset.",
          "type": "string",
          "readOnly": true
        }
      }
    }
  }
}