Data - Upload Preview

Data Upload API

Applies to: S1 pricing tier.

The Data Upload API allows the caller to upload data content to the Azure Maps service. You can use this API in a scenario like uploading a collection of Geofences in GeoJSON format, for use in our Azure Maps Geofencing Service.

Submit Upload Request

To upload your content you will use a POST request. The request body will contain the data to upload. The dataFormat query parameter will contain the format for the data, the dataSharingLevel query parameter can contain the sharing level for the data. The Content-Type header will be set to the content type of the data.

For example, to upload a collection of geofences in GeoJSON format, set the request body to the geofence content. Set the dataFormat query parameter to geojson, and set the Content-Type header to either one of the following media types:

  • application/json
  • application/vnd.geo+json
  • application/octet-stream

Here's a sample request body for uploading a simple Geofence represented as a circle geometry using a center point and a radius. The sample below is in GeoJSON:

{
    "type": "FeatureCollection",
    "features": [{
        "type": "Feature",
        "geometry": {
            "type": "Point",
            "coordinates": [-122.126986, 47.639754]
        },
        "properties": {
            "geometryId": "001",
            "radius": 500
        }
    }]
}

The Data Upload API performs a long-running request.

Data Upload Limits

Please, be aware that currently every Azure Maps account has a data storage limit. Once the storage limit is reached, all the new upload API calls will return a 409 Conflict http error response. You can always use the Data Delete API to delete old/unused content and create space for new uploads.

POST https://atlas.microsoft.com/mapData/upload?api-version=1.0&dataFormat={dataFormat}
POST https://atlas.microsoft.com/mapData/upload?subscription-key={subscription-key}&api-version=1.0&dataFormat={dataFormat}

URI Parameters

Name In Required Type Description
api-version
query True
  • string

Version number of Azure Maps API. Current version is 1.0

dataFormat
query True

Data format of the content being uploaded.

subscription-key
query
  • string

One of the Azure Maps keys provided from an Azure Map Account. Please refer to this article for details on how to manage authentication.

Request Header

Name Required Type Description
x-ms-client-id
  • string

Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following articles for guidance.

Request Body

Name Type Description
UploadContent
  • object

The content to upload.

Responses

Name Type Description
200 OK

Data upload failed. The uploaded content did not satisfy all the validation checks. The response body contains all the errors that were encountered.

201 Created

The resource has been created successfully.

Headers

  • Location: string
  • Access-Control-Expose-Headers: string
202 Accepted

Supported only for async request. Request Accepted: The request has been accepted for processing. Please use the URL in the Location Header to retry or access the results.

Headers

  • Location: string
  • Access-Control-Expose-Headers: string
400 Bad Request

Bad request: one or more parameters were incorrectly specified or are mutually exclusive.

401 Unauthorized

Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the WWW-Authenticate header for error code and description of the provided AAD bearer token.

Headers

  • WWW-Authenticate: string
403 Forbidden

Permission, capacity, or authentication issues.

404 Not Found

Not Found: the requested resource could not be found, but it may be available again in the future.

500 Internal Server Error

An error occurred while processing the request. Please try again later.

Security

azure_auth

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.

Note

  • 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 tokens are supported.

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

subscription-key

This is a shared key which is provisioned when creating an Azure Maps resource through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.

Type: apiKey
In: query

Examples

Upload GeoJSON data containing geometries that represent a collection of geofences

Sample Request

POST https://atlas.microsoft.com/mapData/upload?subscription-key=[subscription-key]&api-version=1.0&dataFormat=geojson
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.126986,
          47.639754
        ]
      },
      "properties": {
        "geometryId": "001",
        "radius": 500
      }
    }
  ]
}

Sample Response

Location: https://atlas.microsoft.com/mapData/metadata/{udid}?api-version=1.0
Access-Control-Expose-Headers: Location
{
  "operationId": "{operationId}",
  "status": "Succeeded",
  "created": "2020-01-02 1:02:03 AM +00:00",
  "resourceLocation": "https://atlas.microsoft.com/mapData/metadata/{resourceId}?api-version=1.0"
}
Location: https://atlas.microsoft.com/mapData/operations/{operationId}?api-version=1.0
Access-Control-Expose-Headers: Location
{
  "error": {
    "code": "400 Bad Request",
    "message": "Upload request failed. Your data has been removed as we encountered the following problems with it: Map data is not a valid GeoJSON geometry."
  }
}
{
  "error": {
    "code": "400 BadRequest",
    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
  }
}
{
  "error": {
    "code": "401 Unauthorized",
    "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
  }
}
{
  "error": {
    "code": "403 Forbidden",
    "message": "Permission, capacity, or authentication issues."
  }
}
{
  "error": {
    "code": "404 NotFound",
    "message": "Not Found: the requested resource could not be found, but it may be available again in the future."
  }
}
{
  "error": {
    "code": "500 InternalServerError",
    "message": "An error occurred while processing the request. Please try again later."
  }
}

Definitions

LongRunningOperationResult

The response model for a Long-Running Operations API.

ODataError

This object is returned when an error occurs in the Maps API.

ODataErrorResponse

This response object is returned when an error occurs in the Maps API.

type

The status state of the request.

UploadDataFormat

Data format of the content being uploaded.

LongRunningOperationResult

The response model for a Long-Running Operations API.

Name Type Description
created
  • string

The created timestamp.

error

This object is returned when an error occurs in the Maps API.

operationId
  • string

The Id for this long-running operation.

resourceLocation
  • string

The location URI for details about the created resource. This is only provided when the request was successfully completed.

status

The status state of the request.

warning

This object is returned when an error occurs in the Maps API.

ODataError

This object is returned when an error occurs in the Maps API.

Name Type Description
code
  • string

The ODataError code.

details

This object is returned when an error occurs in the Maps API.

message
  • string

If available, a human readable description of the error.

target
  • string

If available, the target causing the error.

ODataErrorResponse

This response object is returned when an error occurs in the Maps API.

Name Type Description
error

This object is returned when an error occurs in the Maps API.

type

The status state of the request.

Name Type Description
Failed
  • string

The request has one or more failures.

NotStarted
  • string

The request has not started processing yet.

Running
  • string

The request has started processing.

Succeeded
  • string

The request has successfully completed.

UploadDataFormat

Data format of the content being uploaded.

Name Type Description
geojson
  • string

GeoJSON is a JSON based geospatial data interchange format.

zip
  • string

Compressed data format.