Dataset - Get

Riferimento

Servizio:: Maps Creator

Versione API:: 2.0

Usare per ottenere i dettagli di un set di dati.

Invia richiesta di recupero dei dettagli

Per ottenere i dettagli per un set di dati creato in precedenza, verrà inviata una GET richiesta con datasetId nel percorso.

Ottenere la risposta ai dettagli

L'API Get Details restituisce i dettagli per un set di dati in json formato . La risposta contiene i campi seguenti (se non sono null o vuoti):

created: il timestamp del set di dati è stato creato. datasetId: ID per il set di dati. description: descrizione per il set di dati. datasetSources: dati di origine usati al momento dell'emissione della richiesta di creazione. ontologia: l'ontologia di origine utilizzata nel servizio di conversione per i dati di input.

datasetSources Descrive i dati di origine utilizzati durante l'emissione della richiesta di creazione e contiene gli elementi seguenti (se non sono null o vuoti):

conversionIds: elenco di conversionId (null se non è stato specificato nessuno). appendDatasetId: oggetto datasetId utilizzato per un'operazione di accodamento (null se non è stato usato nessuno). featureCounts: conteggi per ogni tipo di funzionalità nel set di dati.

Ecco una risposta di esempio che restituisce la timestamprisorsa , datasetId, description, datasetSourcese ontology di una risorsa del set di dati:

{
   "timestamp": "2020-01-01T22:50:48.123Z",
   "datasetId": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
   "description": "Some description or comment for the dataset.",
   "datasetSources": {
     "conversionIds": [
       "15d21452-c9bb-27b6-5e79-743ca5c3205d"
     ],
   },
   "ontology": "facility-2.0",
   "featureCounts": {
     "directoryInfo": 2,
     "category": 10,
     "facility": 1,
     "level": 3,
     "unit": 183,
     "zone": 3,
     "verticalPenetration": 6,
     "opening": 48,
     "areaElement": 108
   }
 }

GET https://{geography}.atlas.microsoft.com/datasets/{datasetId}?api-version=2.0

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
datasetId	path	True	string	Identificatore del set di dati da cui eseguire una query.
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.

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 account 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	Dataset	Richiesta di recupero del set di dati completata.
Other Status Codes	ErrorResponse	Si è verificato un errore imprevisto.

Sicurezza

AADToken

Si tratta dei flussi OAuth 2.0 Microsoft Entra. Se abbinato 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 in base al ruolo di Azure vengono usati per designare l'accesso a uno o più Mappe di Azure account di risorse o sottorisorse. A 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 sintesi, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso su API e ambiti specifici.

Note

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

è 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 di Mappe di Azure Web SDK consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.

Per altre informazioni su Microsoft Identity Platform, vedere panoramica di 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 effettuato il provisioning quando si crea un account Mappe di Azure nel 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 alle 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 List SAS nella risorsa Mappe di Azure tramite il piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, Azure SDK o API REST.

Con questo token, qualsiasi applicazione è autorizzata ad accedere con i controlli di accesso in base al 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 dell'account map per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.

Tipo: apiKey
In: header

Esempio

Get details for a previously created dataset

Esempio di richiesta

HTTP

GET https://us.atlas.microsoft.com/datasets/[datasetId]?api-version=2.0

Risposta di esempio

Codice di stato:: 200

Location: https://us.atlas.microsoft.com/dataset/{datasetId}?api-version=1.0
Access-Control-Expose-Headers: Resource-Location

{
  "created": "2021-05-21T01:02:03.456Z",
  "datasetId": "[datasetId]",
  "description": "Some description or comment about the dataset",
  "datasetSources": {
    "conversionIds": [
      "15d21452-c9bb-27b6-5e79-743ca5c3205d",
      "c39de51c-b4f5-4733-aeeb-d8cb6f8b2f1d"
    ],
    "appendDatasetId": "6a49a490-1d9c-4f05-bf1e-51998fbc4733"
  },
  "featureCounts": {
    "directoryInfo": 2,
    "category": 10,
    "facility": 1,
    "level": 3,
    "unit": 183,
    "zone": 3,
    "verticalPenetration": 6,
    "opening": 48,
    "areaElement": 108
  },
  "ontology": "facility-2.0"
}

Definizioni

Nome	Descrizione
Dataset	Informazioni dettagliate per il set di dati.
DatasetSources	Informazioni sui dettagli della richiesta di creazione per il set di dati.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore

Dataset

Informazioni dettagliate per il set di dati.

Nome	Tipo	Descrizione
created	string	Timestamp creato per il set di dati.
datasetId	string	ID del set di dati.
datasetSources	DatasetSources	Informazioni sui dettagli della richiesta di creazione per il set di dati.
description	string	Descrizione del set di dati.
featureCounts	object	Conteggio delle funzionalità per il set di dati.
ontology	string	Versione ontologia di questo set di dati.

DatasetSources

Informazioni sui dettagli della richiesta di creazione per il set di dati.

Nome	Tipo	Descrizione
appendDatasetId	string	Set di dati aggiunto a per creare il set di dati corrente.
conversionIds	string[]	Elenco di utilizzato per creare il set di `conversionId` dati.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di 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.

Condividi tramite