Conversion - Convert

Servizio:

Maps Creator

Versione API:

2.0

Usare per convertire un pacchetto di disegno importato in precedenza in dati mappa.

L'API è una richiesta HTTP POST che consente all'utente Conversion di importare un set di file di progettazione DWG come pacchetto di disegno compresso in Mappe di Azure. Il pacchetto di disegno viene fatto riferimento all'oggetto udid usato quando è stato caricato nel Registro dati. Per altre informazioni sul servizio registro dati, vedere Come creare il Registro dati.

Convertire il pacchetto DWG

L'API conversione esegue un'operazione a esecuzione prolungata.

Eseguire il debug dei problemi del pacchetto DWG

Durante il processo di conversione, se si verificano problemi con gli errori del pacchetto DWG e gli avvisi vengono forniti nella risposta insieme a un pacchetto di diagnostica per visualizzare e diagnosticare questi problemi. In caso di problemi con il pacchetto DWG, il processo di stato dell'operazione di conversione, come descritto di seguito , restituisce il percorso del pacchetto di diagnostica che può essere scaricato dal chiamante per consentire loro di visualizzare e diagnosticare questi problemi. Il percorso del pacchetto di diagnostica è disponibile nella sezione proprietà della risposta dello stato dell'operazione di conversione e ha un aspetto simile al seguente:

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

Il pacchetto di diagnostica può essere scaricato eseguendo una HTTP GET richiesta in diagnosticPackageLocation. Per altre informazioni su come usare lo strumento per visualizzare e diagnosticare tutti gli errori e gli avvisi, vedere Visualizzatore errori di disegno.

Un'operazione di conversione verrà contrassegnata come riuscita se sono presenti zero o più avvisi, ma verrà contrassegnata come non riuscita se si verificano errori.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
geography	path	True	string	Questo parametro specifica dove si trova la risorsa Mappe di Azure Creator. I valori validi sono noi ed eu.
api-version	query	True	string	Numero di versione dell'API Mappe di Azure.
outputOntology	query	True	OutputOntology	Versione di output dell'ontologia. "facility-2.0" è l'unico valore supportato in questo momento. Per altre informazioni sulle onlogies Mappe di Azure Creator, vedere questo articolo.
udid	query	True	string	ID dati univoco (udid) per il contenuto. Deve essere lo stesso udid usato durante la creazione del Registro dati.
description	query		string	L'utente ha fornito una descrizione del contenuto convertito.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-id		string	Specifica l'account destinato all'utilizzo in combinazione con il modello di sicurezza Microsoft Entra ID. Rappresenta un ID univoco per l'account Mappe di Azure e può essere recuperato dall'API del piano di gestione Mappe di Azure. Per usare Microsoft Entra ID sicurezza in Mappe di Azure vedere gli articoli seguenti per indicazioni.

Risposte

Nome	Tipo	Descrizione
200 OK	LongRunningOperationResult	L'operazione è in esecuzione o completa. Se l'operazione ha esito positivo, usare l'intestazione Resource-Location per ottenere il percorso del risultato. Intestazioni Resource-Location: string
202 Accepted		Richiesta accettata: la richiesta è stata accettata per l'elaborazione. Usare l'URL nell'intestazione Operation-Location per ottenere lo stato. Intestazioni Operation-Location: string
Other Status Codes	ErrorResponse	Si è verificato un errore imprevisto.

Sicurezza

AADToken

Si tratta dei flussi OAuth 2.0 Microsoft Entra. Quando è associato al controllo degli accessi in base al ruolo di Azure, può essere usato per controllare l'accesso alle API REST Mappe di Azure. I controlli di accesso basati sul ruolo di Azure vengono usati per designare l'accesso a uno o più Mappe di Azure account delle risorse o alle sotto-risorse. Qualsiasi utente, gruppo o entità servizio può essere concesso l'accesso tramite un ruolo predefinito o un ruolo personalizzato composto da una o più autorizzazioni per Mappe di Azure API REST.

Per implementare scenari, è consigliabile visualizzare i concetti di autenticazione. In riepilogo, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso in API e ambiti specifici.

Note

• Questa definizione di sicurezza richiede l'uso dell'intestazione x-ms-client-id per indicare quale Mappe di Azure risorsa a cui l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione mappe.

L'oggetto Authorization URL è specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno URL di autorizzazione univoci e configurazioni Microsoft Entra ID. * Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, SDK di Azure o API REST. * L'utilizzo dell'SDK Web Mappe di Azure consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.

• Per altre informazioni su Microsoft Identity Platform, vedere panoramica Microsoft Identity Platform.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Si tratta di una chiave condivisa di cui viene eseguito il provisioning quando si crea un account Mappe di Azure nell'portale di Azure o usando PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o l'API REST.

Con questa chiave, qualsiasi applicazione può accedere a tutte le API REST. In altre parole, questa chiave può essere usata come chiave master nell'account in cui vengono rilasciati.

Per le applicazioni esposte pubblicamente, è consigliabile usare l'approccio delle applicazioni client riservate per accedere alle API REST Mappe di Azure in modo che la chiave possa essere archiviata in modo sicuro.

Tipo: apiKey
In: query

SAS Token

Si tratta di un token di firma di accesso condiviso creato dall'operazione Elenco firma di accesso condiviso nella risorsa Mappe di Azure tramite il piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, SDK di Azure o API REST.

Con questo token, qualsiasi applicazione è autorizzata ad accedere con i controlli di accesso basati sul ruolo di Azure e il controllo granulare alla scadenza, alla frequenza e alle aree d'uso per il token specifico. In altre parole, il token di firma di accesso condiviso può essere usato per consentire alle applicazioni di controllare l'accesso in modo più protetto rispetto alla chiave condivisa.

Per le applicazioni esposte pubblicamente, è consigliabile configurare un elenco specifico di origini consentite nella risorsa account mappa per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.

Tipo: apiKey
In: header

Esempio

Convert previously uploaded DWG Package

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:

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"
}

Codice di stato:

202

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

Definizioni

Nome	Descrizione
ErrorAdditionalInfo	Informazioni aggiuntive sulla gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
LongRunningOperationResult	Modello di risposta per un'API operations di Long-Running.
LroStatus	Stato della richiesta.
OutputOntology	Versione di output dell'ontologia. "facility-2.0" è l'unico valore supportato in questo momento. Per altre informazioni sulle onlogies Mappe di Azure Creator, vedere questo articolo.

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

LongRunningOperationResult

Modello di risposta per un'API operations di Long-Running.

Nome	Tipo	Descrizione
created	string	Timestamp creato.
error	ErrorDetail	Dettagli dell'errore.
operationId	string	ID per questa operazione a esecuzione prolungata.
status	LroStatus	Stato della richiesta.
warning	ErrorDetail	Dettagli dell'errore.

LroStatus

Stato della richiesta.

Nome	Tipo	Descrizione
Failed	string	La richiesta ha uno o più errori.
NotStarted	string	La richiesta non ha ancora avviato l'elaborazione.
Running	string	La richiesta ha avviato l'elaborazione.
Succeeded	string	La richiesta è stata completata correttamente.

OutputOntology

Versione di output dell'ontologia. "facility-2.0" è l'unico valore supportato in questo momento. Per altre informazioni sulle onlogies Mappe di Azure Creator, vedere questo articolo.

Nome	Tipo	Descrizione
facility-2.0	string	L'ontologia della struttura definisce come Mappe di Azure Creator archivia internamente i dati della struttura in un set di dati Creator.