Conversion - Convert

Service:

Maps Creator

API-versie:

2.0

Gebruik om een eerder geïmporteerd tekenpakket te converteren naar kaartgegevens.

De Conversion API is een HTTP-aanvraag POST waarmee de aanroeper een set DWG-ontwerpbestanden als een gezipt tekenpakket in Azure Maps kan importeren. Naar het tekenpakket wordt verwezen door de udid die is gebruikt toen het werd geüpload naar het gegevensregister. Zie Gegevensregister maken voor meer informatie over de gegevensregisterservice.

DWG-pakket converteren

De conversie-API voert een langdurige bewerking uit.

Problemen met DWG-pakketten opsporen

Als er tijdens het conversieproces problemen zijn met het DWG-pakket, worden er in het antwoord waarschuwingen gegeven , samen met een diagnostisch pakket om deze problemen te visualiseren en te diagnosticeren. Als er problemen zijn met uw DWG-pakket, retourneert het statusproces van de conversiebewerking, zoals hier beschreven, de locatie van het diagnostische pakket dat kan worden gedownload door de aanroeper om deze problemen te visualiseren en te diagnosticeren. De locatie van het diagnostische pakket vindt u in de sectie Eigenschappen van het antwoord op de status van de conversiebewerking en ziet er als volgt uit:

{
    "properties": {
        "diagnosticPackageLocation": "https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0"                
    }            
}

Het diagnostische pakket kan worden gedownload door een HTTP GET aanvraag uit te voeren op de diagnosticPackageLocation. Zie Tekeningfout visualiseren voor meer informatie over het gebruik van het hulpprogramma voor het visualiseren en diagnosticeren van alle fouten en waarschuwingen.

Een conversiebewerking wordt gemarkeerd als geslaagd als er geen of meer waarschuwingen zijn, maar wordt gemarkeerd als mislukt als er fouten worden aangetroffen.

POST https://{geography}.atlas.microsoft.com/conversions?api-version=2.0&udid={udid}&outputOntology=facility-2.0

Met optionele parameters:

POST https://{geography}.atlas.microsoft.com/conversions?api-version=2.0&udid={udid}&outputOntology=facility-2.0&description={description}

URI-parameters

Name	In	Vereist	Type	Description
geography	path	True	string	Deze parameter geeft aan waar de resource Azure Maps Creator zich bevindt. Geldige waarden zijn wij en eu.
api-version	query	True	string	Versienummer van Azure Maps API.
outputOntology	query	True	OutputOntology	Uitvoer ontologieversie. 'facility-2.0' is de enige ondersteunde waarde op dit moment. Raadpleeg dit artikel voor meer informatie over ontologieën van Azure Maps Creator.
udid	query	True	string	De unieke gegevens-id (udid) voor de inhoud. Moet hetzelfde udid zijn als bij het maken van het gegevensregister.
description	query		string	De gebruiker heeft een beschrijving opgegeven van de inhoud die wordt geconverteerd.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-id		string	Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps beheervlak Account-API. Als u Microsoft Entra ID-beveiliging in Azure Maps raadpleegt u de volgende artikelen voor hulp.

Antwoorden

Name	Type	Description
200 OK	LongRunningOperationResult	De bewerking wordt uitgevoerd of voltooid. Als de bewerking is geslaagd, gebruikt u de Resource-Location-header om het pad naar het resultaat op te halen. Kopteksten Resource-Location: string
202 Accepted		Aanvraag geaccepteerd: de aanvraag is geaccepteerd voor verwerking. Gebruik de URL in de Operation-Location-header om de status te verkrijgen. Kopteksten Operation-Location: string
Other Status Codes	ErrorResponse	Er is een onverwachte fout opgetreden.

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0-stromen. In combinatie met op rollen gebaseerd toegangsbeheer van Azure kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Als u scenario's wilt implementeren, raden we u aan om verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

• Deze beveiligingsdefinitie vereist het gebruik van de x-ms-client-id header om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Beheer-API van Maps.

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID configuraties. * Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksscenario's.

• Zie Microsoft identity platform overzicht voor meer informatie over Microsoft identity platform.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

subscription-key

Dit is een gedeelde sleutel die wordt ingericht wanneer u een Azure Maps-account maakt in de Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.

Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze zijn uitgegeven.

Voor openbaar beschikbare toepassingen wordt aanbevolen om de vertrouwelijke clienttoepassingen te gebruiken voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: query

SAS Token

Dit is een shared access signature-token dat wordt gemaakt op basis van de SAS-bewerking List op de Azure Maps resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle over het verloop, de snelheid en de gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane oorsprongen te configureren op de resource Van het account toewijzen om misbruik van het genereren te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

Convert previously uploaded DWG Package

Voorbeeldaanvraag

HTTP

POST https://us.atlas.microsoft.com/conversions?api-version=2.0&udid=25084fb7-307a-4720-8f91-7952a0b91012&outputOntology=facility-2.0

Voorbeeldrespons

Statuscode:

200

Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0

{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-20T22:43:14.9401559+00:00",
  "status": "Succeeded"
}

Statuscode:

202

Operation-Location: https://us.atlas.microsoft.com/conversions/operations/{operationId}?api-version=2.0
Access-Control-Expose-Headers: Operation-Location

Definities

Name	Description
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
LongRunningOperationResult	Het antwoordmodel voor een Long-Running Operations-API.
LroStatus	De status van de aanvraag.
OutputOntology	Uitvoer ontologieversie. 'facility-2.0' is de enige ondersteunde waarde op dit moment. Raadpleeg dit artikel voor meer informatie over ontologieën van Azure Maps Creator.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

LongRunningOperationResult

Het antwoordmodel voor een Long-Running Operations-API.

Name	Type	Description
created	string	De gemaakte tijdstempel.
error	ErrorDetail	De foutdetails.
operationId	string	De id voor deze langdurige bewerking.
status	LroStatus	De status van de aanvraag.
warning	ErrorDetail	De foutdetails.

LroStatus

De status van de aanvraag.

Name	Type	Description
Failed	string	De aanvraag heeft een of meer fouten.
NotStarted	string	De verwerking van de aanvraag is nog niet gestart.
Running	string	De verwerking van de aanvraag is gestart.
Succeeded	string	De aanvraag is voltooid.

OutputOntology

Uitvoer ontologieversie. 'facility-2.0' is de enige ondersteunde waarde op dit moment. Raadpleeg dit artikel voor meer informatie over ontologieën van Azure Maps Creator.

Name	Type	Description
facility-2.0	string	Faciliteitonologie definieert hoe Azure Maps Creator faciliteitsgegevens intern opslaat in een Creator-gegevensset.