Features - Create

Referencia

Service:: Maps Creator

API Version:: 2023-03-01-preview

La API de características forma parte de Creator, lo que permite desarrollar aplicaciones basadas en los datos privados del mapa interior mediante Azure Maps API y SDK. Características GET API siguen open Geospatial Consortium API - Features - Part 1: Core corrigendum standard to query Datasets. Los conjuntos de datos constan de varias colecciones de características, que son una agrupación de características definidas por un esquema común.

Enviar solicitud de creación

La Feature API es una solicitud HTTP POST que permite al autor de la llamada crear una nueva característica que cumpla con la especificación open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete. Esta API crea una característica con los atributos proporcionados en la colección especificada.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
collectionId	path	True	string	Identificador (nombre) de una colección específica.
datasetId	path	True	string	Identificador del conjunto de datos desde el que se va a consultar.
geography	path	True	string	Este parámetro especifica dónde se encuentra el recurso Azure Maps Creator. Los valores válidos son nosotros y eu.
api-version	query	True	string	Número de versión de la API de Azure Maps.

Respuestas

Nombre	Tipo	Description
201 Created	CreateFeatureResult	Creado
Other Status Codes	ErrorResponse	Se ha producido un error inesperado.

Seguridad

AADToken

Estos son los flujos de OAuth2 de Azure Active Directory . Cuando se empareja con el control de acceso basado en rol de Azure, se puede usar para controlar el acceso a Azure Maps API REST. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias Azure Maps cuenta de recursos o subrecursos. A cualquier usuario, grupo o entidad de servicio se le puede conceder acceso a través de un rol integrado o un rol personalizado compuesto por uno o varios permisos para Azure Maps API REST.

Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para el modelado de aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Notas

Esta definición de seguridad requiere el uso del x-ms-client-id encabezado para indicar a qué recurso Azure Maps la aplicación solicita acceso. Esto se puede adquirir desde la API de administración de Maps.

Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de Azure Active Directory. * El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST. * El uso del SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.

Actualmente, Azure Active Directory v1.0 o v2.0 admite Cuentas profesionales, educativas e invitados, pero no admite cuentas personales.

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

Scopes

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

subscription-key

Se trata de una clave compartida que se aprovisiona al crear un recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.

Con esta clave, cualquier aplicación está autorizada para acceder a todas las API REST. En otras palabras, estos se pueden tratar actualmente como claves maestras para la cuenta para la que se emiten.

Para las aplicaciones expuestas públicamente, nuestra recomendación es usar el acceso de servidor a servidor de Azure Maps API REST donde esta clave se puede almacenar de forma segura.

Type: apiKey
In: query

SAS Token

Se trata de un token de firma de acceso compartido que se crea a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.

Con este token, cualquier aplicación está autorizada para acceder a los controles de acceso basado en roles de Azure y al control específico de la expiración, la tasa y las regiones de uso para el token determinado. Es decir, el token de SAS se puede usar para permitir que las aplicaciones controlen el acceso de forma más segura que la clave compartida.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de la cuenta de mapa para limitar la representación de abusos y renovar periódicamente el token de SAS.

Type: apiKey
In: header

Ejemplos

PostFeature

Sample Request

HTTP

POST https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2023-03-01-preview

{
  "type": "Feature",
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          -122.12662205443488,
          47.64043044867296
        ],
        [
          -122.1266268215741,
          47.640372289574316
        ],
        [
          -122.1265572213413,
          47.64037419643001
        ],
        [
          -122.12656389533623,
          47.64043140210081
        ],
        [
          -122.12662205443488,
          47.64043044867296
        ]
      ]
    ]
  },
  "properties": {
    "categoryId": "CTG12",
    "levelId": "LVL22",
    "isOpenArea": false
  }
}

Sample Response

Status code:: 201

{
  "id": "UNIT39",
  "ontology": "facility-2.0",
  "links": [
    {
      "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items/UNIT39",
      "rel": "self",
      "title": "UNIT39"
    },
    {
      "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit",
      "rel": "collection",
      "title": "Information for unit collection"
    }
  ]
}

Definiciones

Nombre	Description
CreateFeatureResult	Respuesta después de crear correctamente una característica.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
FeaturesEndpointLink	Vínculos a otros puntos de conexión de características. Para obtener más información sobre las relaciones de vínculo, visite el estándar OGC API - Features - Part 1 .
GeoJsonGeometry	Objeto geometry válido `GeoJSON` . El tipo debe ser uno de los siete tipos de geometría GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon y GeometryCollection. Consulte RFC 7946 para obtener más información.
GeoJsonGeometryCollection	Tipo de objeto válido `GeoJSON GeometryCollection` . Consulte RFC 7946 para obtener más información.
GeoJsonLineString	Un tipo de geometría válido `GeoJSON LineString` . Consulte RFC 7946 para obtener más información.
GeoJsonMultiLineString	Un tipo de geometría válido `GeoJSON MultiLineString` . Consulte RFC 7946 para obtener más información.
GeoJsonMultiPoint	Un tipo de geometría válido `GeoJSON MultiPoint` . Consulte RFC 7946 para obtener más información.
GeoJsonMultiPolygon	Tipo de objeto válido `GeoJSON MultiPolygon` . Consulte RFC 7946 para obtener más información.
GeoJsonObjectType	Especifica el `GeoJSON` tipo: FeatureCollection.
GeoJsonPoint	Un tipo de geometría válido `GeoJSON Point` . Consulte RFC 7946 para obtener más información.
GeoJsonPolygon	Un tipo de geometría válido `GeoJSON Polygon` . Consulte RFC 7946 para obtener más información.

CreateFeatureResult

Respuesta después de crear correctamente una característica.

Nombre	Tipo	Description
id	string	Identificador de la característica.
links	FeaturesEndpointLink[]	Vínculos a otros puntos de conexión de características.
ontology	string	La versión de ontología de este conjunto de datos.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

FeaturesEndpointLink

Vínculos a otros puntos de conexión de características. Para obtener más información sobre las relaciones de vínculo, visite el estándar OGC API - Features - Part 1 .

Nombre	Tipo	Description
href	string	Destino del vínculo.
rel	string	Tipo de relación.
title	string	Se usa para etiquetar el destino de un vínculo de modo que se pueda usar como identificador legible (por ejemplo, una entrada de menú) en el idioma indicado por el campo encabezado Content-Language (si está presente).

GeoJsonGeometry

Objeto geometry válido GeoJSON . El tipo debe ser uno de los siete tipos de geometría GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon y GeometryCollection. Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
type	GeoJsonObjectType	Especifica el tipo `GeoJSON`. Debe ser uno de los nueve tipos de objetos GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonGeometryCollection

Tipo de objeto válido GeoJSON GeometryCollection . Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Contiene una lista de objetos geometry válidos `GeoJSON` . Tenga en cuenta que las coordenadas de GeoJSON están en orden x, y (longitud, latitud).
type	string: GeometryCollection	Especifica el tipo `GeoJSON`. Debe ser uno de los nueve tipos de objetos GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonLineString

Un tipo de geometría válido GeoJSON LineString . Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
coordinates	number[]	Coordenadas de la `GeoJson LineString` geometría.
type	string: LineString	Especifica el tipo `GeoJSON`. Debe ser uno de los nueve tipos de objetos GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonMultiLineString

Un tipo de geometría válido GeoJSON MultiLineString . Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
coordinates	number[]	Coordenadas de la `GeoJson MultiLineString` geometría.
type	string: MultiLineString	Especifica el tipo `GeoJSON`. Debe ser uno de los nueve tipos de objetos GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonMultiPoint

Un tipo de geometría válido GeoJSON MultiPoint . Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
coordinates	number[]	Coordenadas de la `GeoJson MultiPoint` geometría.
type	string: MultiPoint	Especifica el tipo `GeoJSON`. Debe ser uno de los nueve tipos de objetos GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonMultiPolygon

Tipo de objeto válido GeoJSON MultiPolygon . Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
coordinates	number[]	Contiene una lista de objetos válidos `GeoJSON Polygon` . Tenga en cuenta que las coordenadas de GeoJSON están en orden x, y (longitud, latitud).
type	string: MultiPolygon	Especifica el tipo `GeoJSON`. Debe ser uno de los nueve tipos de objetos GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonObjectType

Especifica el GeoJSON tipo: FeatureCollection.

Nombre	Tipo	Description
FeatureCollection	string	Objeto `GeoJSON FeatureCollection`.

GeoJsonPoint

Un tipo de geometría válido GeoJSON Point . Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
coordinates	number[]	A `Position` es una matriz de números con dos o más elementos. Los dos primeros elementos son longitud y latitud, precisamente en ese orden. Altitud/Elevación es un tercer elemento opcional. Consulte RFC 7946 para obtener más información.
type	string: Point	Especifica el tipo `GeoJSON`. Debe ser uno de los nueve tipos de objetos GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonPolygon

Un tipo de geometría válido GeoJSON Polygon . Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
coordinates	number[]	Coordenadas para el `GeoJson Polygon` tipo de geometría.
type	string: Polygon	Especifica el tipo `GeoJSON`. Debe ser uno de los nueve tipos de objetos GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

Compartir a través de