Features - Get Api Definition
Permet d’obtenir une description des fonctionnalités du service Fonctionnalités.
Remarque
la mise hors service du créateur Azure Maps
Le service de mappage intérieur Du créateur Azure Maps est désormais déconseillé et sera mis hors service le 25/9/30/25. Pour plus d’informations, consultez annonce de fin de vie d’Azure Maps Creator.
L’API Get API Definition est une requête HTTP GET qui retourne les détails des fonctionnalités de chaque API dans le service Fonctionnalités, y compris le type de requête (GET ou POST) un description, operationId, parameterset responses. Il peut être utilisé par les développeurs pour comprendre l’API ou par des outils de développement pour prendre en charge l’implémentation de serveurs et de clients.
L’API Fonctionnalités fait partie de Creator, ce qui permet de développer des applications basées sur vos données de carte intérieure privées à l’aide de l’API et du SDK Azure Maps. Les FONCTIONNALITÉS GET API suivent l’API Open Geospatial Consortium - Features - Features - Part 1 : Core corrigendum standard pour interroger les jeux de données . Les jeux de données se composent de plusieurs collections de fonctionnalités, qui sont un regroupement de fonctionnalités définies par un schéma commun.
GET https://{geography}.atlas.microsoft.com/features/datasets/{datasetId}/api?api-version=2023-03-01-previewParamètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
dataset
|
path | True |
string |
Identificateur du jeu de données à partir duquel effectuer une requête. |
|
geography
|
path | True |
string |
Ce paramètre spécifie l’emplacement de la ressource Créateur Azure Maps. Les valeurs valides sont nous et eu. |
|
api-version
|
query | True |
string |
Numéro de version de l’API Azure Maps. |
En-tête de la demande
| Nom | Obligatoire | Type | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Spécifie le compte destiné à l’utilisation conjointement avec le modèle de sécurité Microsoft Entra ID. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API compte de plan de gestion Azure Maps. Pour utiliser la sécurité microsoft Entra ID dans Azure Maps, consultez les articles suivants pour obtenir des conseils. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
D’accord |
|
| Other Status Codes |
Une erreur inattendue s’est produite. |
Sécurité
AADToken
Il s’agit des flux Azure Active Directory OAuth2. Lorsqu’il est associé à 'accès en fonction du rôle Azure contrôle, il peut être utilisé pour contrôler l’accès aux API REST Azure Maps. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes de ressources Azure Maps ou sous-ressources. Tout utilisateur, groupe ou principal de service peut avoir accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour les API REST Azure Maps.
Pour implémenter des scénarios, nous vous recommandons d’afficher concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour la modélisation des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.
Remarques
- Cette définition de sécurité nécessite l’utilisation de l’en-tête
x-ms-client-idpour indiquer la ressource Azure Maps à laquelle l’application demande l’accès. Cela peut être acquis à partir de l’API de gestion Maps.
La Authorization URL est spécifique à l’instance de cloud public Azure. Les clouds souverains ont des URL d’autorisation uniques et des configurations Azure Active Directory.
* Le contrôle d’accès en fonction du rôle Azure est configuré à partir de l'plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les API REST.
* L’utilisation du kit de développement logiciel (SDK) web Azure Maps permet la configuration basée sur la configuration d’une application pour plusieurs cas d’usage.
- Actuellement, Azure Active Directory v1.0 ou v2.0 prend en charge les comptes professionnels, scolaires et invités, mais ne prend pas en charge les comptes personnels.
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
| Nom | Description |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Il s’agit d’une clé partagée provisionnée lors de la création d’une ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, CLI, kits SDK Azure ou API REST.
Avec cette clé, toute application est autorisée à accéder à toutes les API REST. En d’autres termes, ces clés peuvent être traitées comme des clés principales pour le compte pour lequel elles sont émises.
Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’accès serveur à serveur des API REST Azure Maps où cette clé peut être stockée en toute sécurité.
Type:
apiKey
Dans:
query
SAS Token
Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération List SAS sur la ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, CLI, azure SDK ou LES API REST.
Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et un contrôle précis à l’expiration, au taux et aux régions d’utilisation pour le jeton particulier. En d’autres termes, le jeton SAP peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.
Pour les applications exposées publiquement, nous vous recommandons de configurer une liste spécifique d’origines autorisées sur la ressource de compte mapper pour limiter l’abus de rendu et renouveler régulièrement le jeton SAP.
Type:
apiKey
Dans:
header
Exemples
GetApiDefinition
Exemple de requête
GET https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/api?api-version=2023-03-01-preview
Exemple de réponse
{
"openapi": "3.0.1",
"info": {
"title": "Azure Maps Web Feature Service",
"version": "2023-03-01-preview",
"description": "Azure Maps Web Feature REST APIs"
},
"paths": {
"/features/datasets/{datasetId}/": {
"get": {
"summary": "landing page of this API",
"description": "The landing page provides links to the API definition, the Conformance statements and the information about the feature data in this dataset.",
"operationId": "getLandingPage",
"tags": [
"Capabilities"
],
"parameters": [
{
"$ref": "#/responses/200/body/components/parameters/datasetId"
}
],
"responses": {
"200": {
"description": "links to the API capabilities",
"content": {
"application/json": {
"schema": {
"$ref": "#/responses/200/body/components/schemas/root"
}
}
}
}
}
}
},
"/features/datasets/{datasetId}/api": {
"get": {
"summary": "the API definition for this service",
"operationId": "getApiDefinition",
"tags": [
"Capabilities"
],
"parameters": [
{
"$ref": "#/responses/200/body/components/parameters/datasetId"
}
],
"responses": {
"200": {
"description": "the API definition"
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/responses/200/body/components/schemas/exception"
}
}
}
}
}
}
},
"/features/datasets/{datasetId}/conformance": {
"get": {
"summary": "information about standards that this API conforms to",
"description": "list all requirements classes specified in a standard (e.g., Features Part 1: Core) that the server conforms to",
"operationId": "getRequirementsClasses",
"tags": [
"Capabilities"
],
"parameters": [
{
"$ref": "#/responses/200/body/components/parameters/datasetId"
}
],
"responses": {
"200": {
"description": "the URIs of all requirements classes supported by the server",
"content": {
"application/json": {
"schema": {
"$ref": "#/responses/200/body/components/schemas/req-classes"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/responses/200/body/components/schemas/exception"
}
}
}
}
}
}
},
"/features/datasets/{datasetId}/collections": {
"get": {
"summary": "describe the feature collections in the dataset",
"operationId": "describeCollections",
"tags": [
"Capabilities"
],
"parameters": [
{
"$ref": "#/responses/200/body/components/parameters/datasetId"
}
],
"responses": {
"200": {
"description": "Information about the feature collections shared by this API.",
"content": {
"application/json": {
"schema": {
"$ref": "#/responses/200/body/components/schemas/content"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/responses/200/body/components/schemas/exception"
}
}
}
}
}
}
},
"/features/datasets/{datasetId}/collections/{collectionId}": {
"get": {
"summary": "describe the {collectionId} feature collection",
"operationId": "describeCollection",
"tags": [
"Capabilities"
],
"parameters": [
{
"$ref": "#/responses/200/body/components/parameters/datasetId"
},
{
"$ref": "#/responses/200/body/components/parameters/collectionId"
}
],
"responses": {
"200": {
"description": "Information about the {collectionId} collection shared by this API.",
"content": {
"application/json": {
"schema": {
"$ref": "#/responses/200/body/components/schemas/collectionInfo"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/responses/200/body/components/schemas/exception"
}
}
}
}
}
}
},
"/features/datasets/{datasetId}/collections/{collectionId}/definition": {
"get": {
"summary": "describe the {collectionId} feature collection",
"operationId": "definitionCollection",
"tags": [
"Capabilities"
],
"parameters": [
{
"$ref": "#/responses/200/body/components/parameters/datasetId"
},
{
"$ref": "#/responses/200/body/components/parameters/collectionId"
}
],
"responses": {
"200": {
"description": "Metadata about the {collectionId} collection shared by this API.",
"content": {
"application/json": {
"schema": {
"$ref": "#/responses/200/body/components/schemas/collectionDefinition"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/responses/200/body/components/schemas/exception"
}
}
}
}
}
}
},
"/features/datasets/{datasetId}/collections/{collectionId}/items": {
"get": {
"summary": "retrieve features of feature collection {collectionId}",
"description": "Every feature in a dataset belongs to a collection. A dataset may consist of multiple feature collections. A feature collection is often a collection of features of a similar type, based on a common schema.",
"operationId": "getFeatures",
"tags": [
"Features"
],
"parameters": [
{
"$ref": "#/responses/200/body/components/parameters/datasetId"
},
{
"$ref": "#/responses/200/body/components/parameters/collectionId"
},
{
"$ref": "#/responses/200/body/components/parameters/limit"
},
{
"$ref": "#/responses/200/body/components/parameters/bbox"
},
{
"$ref": "#/responses/200/body/components/parameters/time"
}
],
"responses": {
"200": {
"description": "Information about the feature collection plus the first features matching the selection parameters.",
"content": {
"application/geo+json": {
"schema": {
"$ref": "#/responses/200/body/components/schemas/featureCollectionGeoJSON"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/responses/200/body/components/schemas/exception"
}
}
}
}
}
},
"post": {
"summary": "create feature for feature collection {collectionId}",
"description": "Create a single feature of unique id in the given collection.",
"operationId": "postFeatures",
"tags": [
"Features"
],
"parameters": [
{
"$ref": "#/responses/200/body/components/parameters/datasetId"
},
{
"$ref": "#/responses/200/body/components/parameters/collectionId"
}
],
"responses": {
"201": {
"description": "Id of the created feature and its reference links.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"$ref": "#/responses/200/body/components/schemas/link"
}
}
}
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/responses/200/body/components/schemas/exception"
}
}
}
}
}
}
},
"/features/datasets/{datasetId}/collections/{collectionId}/items/{featureId}": {
"get": {
"summary": "retrieve a feature",
"operationId": "getFeature",
"tags": [
"Features"
],
"parameters": [
{
"$ref": "#/responses/200/body/components/parameters/datasetId"
},
{
"$ref": "#/responses/200/body/components/parameters/collectionId"
},
{
"$ref": "#/responses/200/body/components/parameters/featureId"
}
],
"responses": {
"200": {
"description": "A feature.",
"content": {
"application/geo+json": {
"schema": {
"$ref": "#/responses/200/body/components/schemas/featureGeoJSON"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/responses/200/body/components/schemas/exception"
}
}
}
}
}
},
"delete": {
"summary": "delete a feature",
"operationId": "deleteFeature",
"tags": [
"Features"
],
"parameters": [
{
"$ref": "#/responses/200/body/components/parameters/datasetId"
},
{
"$ref": "#/responses/200/body/components/parameters/collectionId"
},
{
"$ref": "#/responses/200/body/components/parameters/featureId"
}
],
"responses": {
"204": {
"description": "Feature deleted."
}
}
},
"put": {
"summary": "replace feature metadata",
"operationId": "putFeature",
"tags": [
"Features"
],
"parameters": [
{
"$ref": "#/responses/200/body/components/parameters/datasetId"
},
{
"$ref": "#/responses/200/body/components/parameters/collectionId"
},
{
"$ref": "#/responses/200/body/components/parameters/featureId"
}
],
"responses": {
"204": {
"description": "Feature metadata replaced."
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/responses/200/body/components/schemas/exception"
}
}
}
}
}
},
"patch": {
"summary": "update feature metadata",
"operationId": "patchFeature",
"tags": [
"Features"
],
"parameters": [
{
"$ref": "#/responses/200/body/components/parameters/datasetId"
},
{
"$ref": "#/responses/200/body/components/parameters/collectionId"
},
{
"$ref": "#/responses/200/body/components/parameters/featureId"
}
],
"responses": {
"200": {
"description": "Feature metadata updated."
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/responses/200/body/components/schemas/exception"
}
}
}
}
}
}
}
},
"components": {
"parameters": {
"datasetId": {
"name": "datasetId",
"in": "path",
"description": "The identifier for the database to query from",
"required": true,
"schema": {
"type": "string"
}
},
"limit": {
"name": "limit",
"in": "query",
"description": "The optional limit parameter limits the number of items that are\npresented in the response document.\n\nOnly items are counted that are on the first level of the collection in\nthe response document. Nested objects contained within the explicitly\nrequested items shall not be counted.\n\n* Minimum = 1\n* Maximum = 500\n* Default = 10\n",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 500,
"default": 10
},
"style": "form",
"explode": false
},
"bbox": {
"name": "bbox",
"in": "query",
"description": "Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (elevation or depth):\n* Lower left corner, coordinate axis 1 * Lower left corner, coordinate axis 2 * Lower left corner, coordinate axis 3 (optional) * Upper right corner, coordinate axis 1 * Upper right corner, coordinate axis 2 * Upper right corner, coordinate axis 3 (optional)\nThe coordinate reference system of the values is WGS84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate reference system is specified in the parameter `bbox-crs`.\nFor WGS84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge).\n",
"required": false,
"schema": {
"type": "array",
"minItems": 4,
"maxItems": 6,
"items": {
"type": "number"
}
},
"style": "form",
"explode": false
},
"time": {
"name": "time",
"in": "query",
"description": "Either a date-time or a period string that adheres to RFC 3339. Examples:\n* A date-time: \"2018-02-12T23:20:50Z\" * A period: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\" or \"2018-02-12T00:00:00Z/P1M6DT12H31M12S\"\nOnly features that have a temporal property that intersects the value of `time` are selected.",
"required": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false
},
"collectionId": {
"name": "collectionId",
"in": "path",
"required": true,
"description": "Identifier (name) of a specific collection",
"schema": {
"type": "string"
}
},
"featureId": {
"name": "featureId",
"in": "path",
"description": "Identifier of a specific feature",
"required": true,
"schema": {
"type": "string"
}
}
},
"schemas": {
"exception": {
"type": "object",
"required": [
"code"
],
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
},
"root": {
"type": "object",
"required": [
"links"
],
"properties": {
"links": {
"type": "array",
"items": {
"$ref": "#/responses/200/body/components/schemas/link"
},
"example": [
{
"href": "http://data.example.org/",
"rel": "self",
"type": "application/json",
"title": "Azure Maps Features"
},
{
"href": "http://data.example.org/api",
"rel": "service-desc",
"type": "application/openapi+json;version=3.0",
"title": "The API definition"
},
{
"href": "http://data.example.org/conformance",
"rel": "conformance",
"type": "application/json",
"title": "Conformance classes implemented by Features"
},
{
"href": "http://data.example.org/collections",
"rel": "data",
"type": "application/json",
"title": "information about the feature collections"
}
]
}
}
},
"req-classes": {
"type": "object",
"required": [
"conformsTo"
],
"properties": {
"conformsTo": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/core",
"http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/oas3",
"http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/geojson"
]
}
}
},
"link": {
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string",
"example": "prev"
},
"type": {
"type": "string",
"example": "application/geo+json"
},
"hreflang": {
"type": "string",
"example": "en"
}
}
},
"content": {
"type": "object",
"required": [
"links",
"collections"
],
"properties": {
"links": {
"type": "array",
"items": {
"$ref": "#/responses/200/body/components/schemas/link"
},
"example": [
{
"href": "http://data.example.org/collections.json",
"rel": "self",
"type": "application/json",
"title": "this document"
},
{
"href": "http://schemas.example.org/1.0/foobar.xsd",
"rel": "describedBy",
"type": "application/xml",
"title": "XML schema for Acme Corporation data"
}
]
},
"collections": {
"type": "array",
"items": {
"$ref": "#/responses/200/body/components/schemas/collectionInfo"
}
}
}
},
"versionInfo": {
"type": "object",
"required": [
"version",
"revisionTimestamp"
],
"properties": {
"version": {
"description": "version number of the dataset",
"type": "string",
"example": "1.0.0"
},
"revisionTimestamp": {
"description": "timestamp of the revision",
"type": "string",
"example": "2020-01-02T03:04:05.6789012Z"
}
}
},
"collectionInfo": {
"type": "object",
"required": [
"name",
"links"
],
"properties": {
"id": {
"description": "identifier of the collection used, for example, in URIs",
"type": "string",
"example": "buildings"
},
"title": {
"description": "human readable title of the collection",
"type": "string",
"example": "Buildings"
},
"itemType": {
"description": "indicator about the type of the items in the collection",
"type": "string",
"example": "feature"
},
"description": {
"description": "a description of the features in the collection",
"type": "string",
"example": "Buildings in the city of Bonn."
},
"links": {
"type": "array",
"items": {
"$ref": "#/responses/200/body/components/schemas/link"
},
"example": [
{
"href": "http://data.example.org/collections/buildings/items",
"rel": "item",
"type": "application/geo+json",
"title": "Buildings"
}
]
}
}
},
"collectionDefinition": {
"type": "object",
"required": [
"id",
"itemType",
"geometryType"
],
"properties": {
"id": {
"description": "identifier of the collection used, for example, in URIs",
"type": "string",
"example": "buildings"
},
"title": {
"description": "title of the collection used",
"type": "string",
"example": "buildings"
},
"itemType": {
"description": "indicator about the type of the items in the collection",
"type": "string",
"example": "feature"
},
"description": {
"description": "title of collection",
"type": "string",
"example": "Feature Class buildings"
},
"geometryType": {
"description": "type of geometry returned",
"type": "string",
"enum": [
"Point",
"MultiPoint",
"LineString",
"MultiLineString",
"Polygon",
"MultiPolygon",
"GeometryCollection"
]
},
"properties": {
"description": "attributes of the collection used",
"type": "array",
"items": {
"$ref": "#/responses/200/body/components/schemas/definitionProperties"
}
}
}
},
"definitionProperties": {
"type": "object",
"required": [
"name",
"required",
"type"
],
"properties": {
"name": {
"description": "name of attribute",
"type": "string",
"example": "external_id"
},
"required": {
"description": "is attribute required",
"type": "boolean"
},
"type": {
"description": "type of attribute",
"type": "object"
}
}
},
"featureCollectionGeoJSON": {
"type": "object",
"required": [
"type",
"features"
],
"properties": {
"type": {
"type": "string",
"enum": [
"FeatureCollection"
]
},
"features": {
"type": "array",
"items": {
"$ref": "#/responses/200/body/components/schemas/featureGeoJSON"
}
},
"links": {
"type": "array",
"items": {
"$ref": "#/responses/200/body/components/schemas/link"
}
},
"timeStamp": {
"type": "string",
"format": "dateTime"
},
"numberMatched": {
"type": "integer",
"minimum": 0
},
"numberReturned": {
"type": "integer",
"minimum": 0
}
}
},
"featureGeoJSON": {
"type": "object",
"required": [
"type",
"geometry",
"properties"
],
"properties": {
"type": {
"type": "string",
"enum": [
"Feature"
]
},
"geometry": {
"$ref": "#/responses/200/body/components/schemas/geometryGeoJSON"
},
"properties": {
"type": "object",
"nullable": true
},
"id": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
}
},
"geometryGeoJSON": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"MultiPoint",
"LineString",
"MultiLineString",
"Polygon",
"MultiPolygon",
"GeometryCollection"
]
}
}
}
}
},
"tags": [
{
"name": "Capabilities",
"description": "Essential characteristics of this API including information about the data."
},
{
"name": "Features",
"description": "Access to data (features)."
}
]
}Définitions
| Nom | Description |
|---|---|
|
Api |
Réponse après une requête réussie pour obtenir la définition de l’API. |
| Components |
Objet composants OpenAPI. |
|
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
|
Error |
Détail de l’erreur. |
|
Error |
Réponse d’erreur |
| Info |
Objet d’informations OpenAPI. |
| Tags |
Objet balises OpenAPI. |
ApiDefinitionResult
Réponse après une requête réussie pour obtenir la définition de l’API.
| Nom | Type | Description |
|---|---|---|
| components |
Objet composants OpenAPI. |
|
| info |
Objet d’informations OpenAPI. |
|
| openapi |
string |
Version d’OpenAPI. |
| paths |
object |
Objet chemins OpenAPI. |
| tags |
Tags[] |
Objet balises OpenAPI. |
Components
Objet composants OpenAPI.
| Nom | Type | Description |
|---|---|---|
| parameters |
object |
Objet de paramètres OpenAPI. |
| schemas |
object |
Objet schémas OpenAPI. |
ErrorAdditionalInfo
Informations supplémentaires sur l’erreur de gestion des ressources.
| Nom | Type | Description |
|---|---|---|
| info |
object |
Informations supplémentaires. |
| type |
string |
Type d’informations supplémentaire. |
ErrorDetail
Détail de l’erreur.
| Nom | Type | Description |
|---|---|---|
| additionalInfo |
Informations supplémentaires sur l’erreur. |
|
| code |
string |
Code d’erreur. |
| details |
Détails de l’erreur. |
|
| message |
string |
Message d’erreur. |
| target |
string |
Cible d’erreur. |
ErrorResponse
Réponse d’erreur
| Nom | Type | Description |
|---|---|---|
| error |
Objet d’erreur. |
Info
Objet d’informations OpenAPI.
| Nom | Type | Description |
|---|---|---|
| description |
string |
Description de l’API. |
| title |
string |
Titre de l’API. |
| version |
string |
Version de l’API. |
Tags
Objet balises OpenAPI.
| Nom | Type | Description |
|---|---|---|
| description |
string |
Description de la balise. |
| name |
string |
Nom de la balise. |