Features - Update

Ссылка

Service:: Maps Creator

API Version:: 2023-03-01-preview

Используйте для изменения отдельных атрибутов компонента.

API Update соответствует черновику api Open Geospatial Consortium — Features — Part 4: Create, Replace, Update and Delete спецификации.

API функций является частью Creator, которая позволяет разрабатывать приложения на основе данных карты частных помещений с помощью API Azure Maps и пакета SDK. Api-интерфейсы GET функций соответствуют api Open Geospatial Consortium — Features — Part 1: Core corrigendum standard для запроса наборов данных. Наборы данных состоят из нескольких коллекций признаков, которые представляют собой группу признаков , определяемых общей схемой.

Отправка запроса на обновление

Update API — это HTTP-запросPATCH, который используется для изменения отдельных атрибутов компонента, как указано в featureId. Единственными атрибутами, которые будут обновлены, являются атрибуты, явно включенные в текст запроса.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
collectionId	path	True	string	Идентификатор (имя) определенной коллекции.
datasetId	path	True	string	Идентификатор набора данных для запроса.
featureId	path	True	string	Идентификатор определенного компонента с учетом регистра.
geography	path	True	string	Этот параметр указывает, где находится ресурс Azure Maps Creator. Допустимые значения: us и eu.
api-version	query	True	string	Номер версии API Azure Maps

Текст запроса

Media Types: "application/merge-patch+json"

Имя	Тип	Описание
geometry	GeoJsonGeometry: GeoJsonPoint GeoJsonMultiPoint GeoJsonLineString GeoJsonMultiLineString GeoJsonPolygon GeoJsonMultiPolygon GeoJsonGeometryCollection	Допустимый `GeoJSON` геометрический объект. Тип должен быть одним из семи допустимых геометрических типов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon и GeometryCollection. Дополнительные сведения см. в документе RFC 7946 .
properties	object	Свойства могут содержать любые дополнительные метаданные о `Feature` и определяются API определения коллекции GET. Значением может быть любой объект JSON или значение NULL JSON, но обратите внимание, что свойства компонентов, не определенные в определении коллекции, будут игнорироваться.

Ответы

Имя	Тип	Описание
204 No Content		Функция обновлена.
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка.

Безопасность

AADToken

Это потоки OAuth2 Azure Active Directory . В сочетании с управлением доступом на основе ролей Azure его можно использовать для управления доступом к Azure Maps REST API. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким учетным записям Azure Maps ресурсов или вложенным ресурсам. Любому пользователю, группе или субъекту-службе может быть предоставлен доступ через встроенную или пользовательскую роль, состоящую из одного или нескольких разрешений для Azure Maps REST API.

Для реализации сценариев рекомендуется ознакомиться с основными понятиями проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, которые могут управлять доступом к определенным API и областям.

Примечания

Это определение безопасности требует использования заголовкаx-ms-client-id, чтобы указать, к какому Azure Maps ресурсу приложение запрашивает доступ. Его можно получить из API управления Картами.

объект Authorization URL предназначен для экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Azure Active Directory. * Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API. * Использование веб-пакета SDK для Azure Maps позволяет настраивать приложение на основе конфигурации для нескольких вариантов использования.

В настоящее время Azure Active Directory версии 1.0 или 2.0 поддерживает рабочие, учебные и гостевые, но не поддерживает личные учетные записи.

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

Scopes

Имя	Описание
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Это общий ключ, который подготавливается при создании ресурса Azure Maps с помощью плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов AZURE SDK или REST API.

С помощью этого ключа любое приложение авторизовано для доступа ко всем REST API. Другими словами, в настоящее время они могут рассматриваться как master ключи к учетной записи, для которой они выдаются.

Для общедоступных приложений мы рекомендуем использовать межсерверный доступ Azure Maps REST API, где этот ключ можно безопасно хранить.

Type: apiKey
In: query

SAS Token

Этот маркер подписанного URL-адреса создается из операции List SAS в ресурсе Azure Maps через плоскость управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.

С помощью этого маркера любое приложение авторизовано для доступа с помощью элементов управления доступом на основе ролей Azure и точного контроля срока действия, скорости и регионов использования конкретного маркера. Иными словами, маркер SAS можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи сопоставления , чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.

Type: apiKey
In: header

Примеры

PatchFeature

Sample Request

HTTP

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

{
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          -122.12658487074886,
          47.640834702079935
        ],
        [
          -122.12658773103239,
          47.640771775842055
        ],
        [
          -122.12654387335145,
          47.64077940326483
        ],
        [
          -122.12654768706284,
          47.64082707465716
        ],
        [
          -122.12658487074886,
          47.640834702079935
        ]
      ]
    ]
  },
  "properties": {
    "categoryId": "CTG6"
  }
}

Sample Response

Status code:: 204

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
FeatureAttributes	Геометрия и свойства компонента.
GeoJsonGeometry	Допустимый `GeoJSON` геометрический объект. Тип должен быть одним из семи допустимых геометрических типов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon и GeometryCollection. Дополнительные сведения см. в документе RFC 7946 .
GeoJsonGeometryCollection	Допустимый `GeoJSON GeometryCollection` тип объекта. Дополнительные сведения см. в документе RFC 7946 .
GeoJsonLineString	Допустимый `GeoJSON LineString` тип геометрии. Дополнительные сведения см. в документе RFC 7946 .
GeoJsonMultiLineString	Допустимый `GeoJSON MultiLineString` тип геометрии. Дополнительные сведения см. в документе RFC 7946 .
GeoJsonMultiPoint	Допустимый `GeoJSON MultiPoint` тип геометрии. Дополнительные сведения см. в документе RFC 7946 .
GeoJsonMultiPolygon	Допустимый `GeoJSON MultiPolygon` тип объекта. Дополнительные сведения см. в документе RFC 7946 .
GeoJsonObjectType	Указывает `GeoJSON` тип FeatureCollection.
GeoJsonPoint	Допустимый `GeoJSON Point` тип геометрии. Дополнительные сведения см. в документе RFC 7946 .
GeoJsonPolygon	Допустимый `GeoJSON Polygon` тип геометрии. Дополнительные сведения см. в документе RFC 7946 .

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя	Тип	Описание
error	ErrorDetail	Объект error.

FeatureAttributes

Геометрия и свойства компонента.

Имя	Тип	Описание
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Допустимый `GeoJSON` геометрический объект. Тип должен быть одним из семи допустимых геометрических типов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon и GeometryCollection. Дополнительные сведения см. в документе RFC 7946 .
properties	object	Свойства могут содержать любые дополнительные метаданные о `Feature` и определяются API определения коллекции GET. Значением может быть любой объект JSON или значение NULL JSON, но обратите внимание, что свойства компонентов, не определенные в определении коллекции, будут игнорироваться.

GeoJsonGeometry

Допустимый GeoJSON геометрический объект. Тип должен быть одним из семи допустимых геометрических типов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon и GeometryCollection. Дополнительные сведения см. в документе RFC 7946 .

Имя	Тип	Описание
type	GeoJsonObjectType	Указывает тип элемента `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonGeometryCollection

Допустимый GeoJSON GeometryCollection тип объекта. Дополнительные сведения см. в документе RFC 7946 .

Имя	Тип	Описание
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Содержит список допустимых `GeoJSON` геометрических объектов. Обратите внимание , что координаты в GeoJSON находятся в порядке x, y (долгота, широта).
type	string: GeometryCollection	Указывает тип элемента `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonLineString

Допустимый GeoJSON LineString тип геометрии. Дополнительные сведения см. в документе RFC 7946 .

Имя	Тип	Описание
coordinates	number[]	Координаты геометрии `GeoJson LineString` .
type	string: LineString	Указывает тип элемента `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonMultiLineString

Допустимый GeoJSON MultiLineString тип геометрии. Дополнительные сведения см. в документе RFC 7946 .

Имя	Тип	Описание
coordinates	number[]	Координаты геометрии `GeoJson MultiLineString` .
type	string: MultiLineString	Указывает тип элемента `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonMultiPoint

Допустимый GeoJSON MultiPoint тип геометрии. Дополнительные сведения см. в документе RFC 7946 .

Имя	Тип	Описание
coordinates	number[]	Координаты геометрии `GeoJson MultiPoint` .
type	string: MultiPoint	Указывает тип элемента `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonMultiPolygon

Допустимый GeoJSON MultiPolygon тип объекта. Дополнительные сведения см. в документе RFC 7946 .

Имя	Тип	Описание
coordinates	number[]	Содержит список допустимых `GeoJSON Polygon` объектов. Обратите внимание , что координаты в GeoJSON находятся в порядке x, y (долгота, широта).
type	string: MultiPolygon	Указывает тип элемента `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonObjectType

Указывает GeoJSON тип FeatureCollection.

Имя	Тип	Описание
FeatureCollection	string	Объект `GeoJSON FeatureCollection`.

GeoJsonPoint

Допустимый GeoJSON Point тип геометрии. Дополнительные сведения см. в документе RFC 7946 .

Имя	Тип	Описание
coordinates	number[]	— `Position` это массив чисел с двумя или более элементами. Первые два элемента — долгота и широта, именно в этом порядке. Высота или высота — необязательный третий элемент. Дополнительные сведения см. в документе RFC 7946 .
type	string: Point	Указывает тип элемента `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonPolygon

Допустимый GeoJSON Polygon тип геометрии. Дополнительные сведения см. в документе RFC 7946 .

Имя	Тип	Описание
coordinates	number[]	Координаты для `GeoJson Polygon` типа geometry.
type	string: Polygon	Указывает тип элемента `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

Share via