Dataset - Create

Reference

Service:: Maps Creator

API Version:: 2023-03-01-preview

Use to create a dataset.

The Create API is an HTTP POST request that allows the caller to create a dataset from data that was uploaded to the Azure Maps Data Registry and converted using the Azure Maps Conversion Service. You can also create a dataset directly using data uploaded to the Azure Maps Data Registry, provided that the uploaded data is a zip of GeoJSON files conforming to the facility ontology format. For more information on the data registry service, see How to create data registry.

For more information, see Create a dataset using a GeoJson package

Submit Create Request

To create your dataset, issue a POST request with the required parameters. The Create API is a long-running operation.

POST https://{geography}.atlas.microsoft.com/datasets?api-version=2023-03-01-preview

With optional parameters:

POST https://{geography}.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&conversionId={conversionId}&udid={udid}&outputOntology=facility-2.0&datasetId={datasetId}&description={description}

URI Parameters

Name	In	Required	Type	Description
geography	path	True	string	This parameter specifies where the Azure Maps Creator resource is located. Valid values are us and eu.
api-version	query	True	string	Version number of Azure Maps API.
conversionId	query		string	ID to create the dataset. The `conversionId` must be obtained from a successful call to the Conversion Service Convert API. Only one conversionId can be provided per API call. conversionId and udid are mutually exclusive parameters.
datasetId	query		string	The ID of the dataset to append with.
description	query		string	The description to be given to the dataset.
outputOntology	query		outputOntology	The ontology for the uploaded zip package containing GeoJSON files. *outputOntology is required if udid is provided, however, is mutually exclusive with conversionId. Currently, only the value facility-2.0* is supported.**
udid	query		string	The unique data ID (`udid`) to create the dataset. Must be the same `udid` used when creating the Data registry. Only one udid can be provided per API call. outputOntology parameter must be provided with the udid. conversionId and udid are mutually exclusive parameters.

Request Header

Name	Required	Type	Description
x-ms-client-id		string	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 for guidance.

Responses

Name	Type	Description
202 Accepted		Request Accepted: The request has been accepted for processing. Please use the URL in the Operation-Location Header to obtain status. Headers Operation-Location: string
Other Status Codes	ErrorResponse	An unexpected error occurred.

Name

Type

Description

202 Accepted

Request Accepted: The request has been accepted for processing. Please use the URL in the Operation-Location Header to obtain status.

Headers

Operation-Location: string

Other Status Codes

ErrorResponse

An unexpected error occurred.

Security

AADToken

These are the Azure Active Directory OAuth2 Flows. When paired with Azure role-based access 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.

To implement scenarios, we recommend viewing authentication concepts. In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.

Notes

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.

The Authorization URL is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. * The Azure role-based access control is configured from the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs. * Usage of the Azure Maps Web SDK allows for configuration based setup of an application for multiple use cases.

Currently, Azure Active Directory v1.0 or v2.0 supports Work, School, and Guests but does not support Personal accounts.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

This is a shared key that is provisioned when you Create an Azure Maps account in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.

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.

For publicly exposed applications, our recommendation is to use the confidential client applications approach to access Azure Maps REST APIs so your key can be securely stored.

Type: apiKey
In: query

SAS Token

This is a shared access signature token is created from the List SAS operation on the Azure Maps resource through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.

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.

For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the Map account resource to limit rendering abuse and regularly renew the SAS Token.

Type: apiKey
In: header

Examples

Create dataset from a converted CAD file provided by conversionId

Create dataset from a zip of GeoJSON files provided by udid

Create dataset with Udid and append to it a dataset created with conversionId

Create dataset with Udid and append to it a dataset created with udid

Create dataset from a converted CAD file provided by conversionId

Sample request

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&conversionId={conversionId}&outputOntology=facility-2.0

Sample response

Status code:: 202

Operation-Location: https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2023-03-01-preview
Access-Control-Expose-Headers: Operation-Location

Create dataset from a zip of GeoJSON files provided by udid

Sample request

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&udid={udid}&outputOntology=facility-2.0

Sample response

Status code:: 202

Operation-Location: https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2023-03-01-preview
Access-Control-Expose-Headers: Operation-Location

Create dataset with Udid and append to it a dataset created with conversionId

Sample request

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&conversionId={conversionId}&udid={udid}&outputOntology=facility-2.0&datasetId={conversionId}

Sample response

Status code:: 202

Operation-Location: https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2023-03-01-preview
Access-Control-Expose-Headers: Operation-Location

Create dataset with Udid and append to it a dataset created with udid

Sample request

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&udid={udid}&outputOntology=facility-2.0&datasetId={udid}

Sample response

Status code:: 202

Operation-Location: https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2023-03-01-preview
Access-Control-Expose-Headers: Operation-Location

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
outputOntology	The ontology for the uploaded zip package containing GeoJSON files. *outputOntology is required if udid is provided, however, is mutually exclusive with conversionId. Currently, only the value facility-2.0* is supported.**

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

outputOntology

The ontology for the uploaded zip package containing GeoJSON files. outputOntology is required if udid is provided, however, is mutually exclusive with conversionId. Currently, only the value facility-2.0 is supported.

Name	Type	Description
facility-2.0	string

مشاركة عبر

Dataset - Create

Submit Create Request

URI Parameters

Request Header

Responses

Security

AADToken

Notes

Scopes

subscription-key

SAS Token

Examples

Create dataset from a converted CAD file provided by conversionId

Sample request

Sample response

Create dataset from a zip of GeoJSON files provided by udid

Sample request

Sample response

Create dataset with Udid and append to it a dataset created with conversionId

Sample request

Sample response

Create dataset with Udid and append to it a dataset created with udid

Sample request

Sample response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

outputOntology

الموارد الإضافية