Delen via


Dataset - Get

Gebruik om de details van een gegevensset op te halen.

Aanvraag voor het ophalen van details indienen

Als u de details voor een eerder gemaakte gegevensset wilt ophalen, verzendt u een GET aanvraag met de datasetId in het pad.

Antwoord details ophalen

De API Details ophalen retourneert de details voor een gegevensset in json indeling. Het antwoord bevat de volgende velden (als deze niet null of leeg zijn):

gemaakt: de tijdstempel van de gegevensset die is gemaakt. datasetId : de id voor de gegevensset. description: de beschrijving voor de gegevensset. datasetSources: de brongegevens die zijn gebruikt toen de aanvraag voor maken werd uitgegeven. ontologie: de brononologie die is gebruikt in de conversieservice voor de invoergegevens.

De datasetSources beschrijft de brongegevens die zijn gebruikt toen de aanvraag voor maken werd uitgegeven en bevat de volgende elementen (als deze niet null of leeg zijn):

conversionIds: de lijst met conversionId (null als er geen is opgegeven). appendDatasetId - De datasetId die is gebruikt voor een toevoegbewerking (null als er geen is gebruikt). featureCounts: de aantallen voor elk functietype in de gegevensset.

Hier volgt een voorbeeldantwoord dat de timestamp, datasetId, description, datasetSourcesen ontology van een gegevenssetresource retourneert:

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

URI-parameters

Name In Vereist Type Description
datasetId
path True

string

De id voor de gegevensset waaruit een query moet worden uitgevoerd.

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.

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

Dataset

De aanvraag voor gegevensset ophalen is voltooid.

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.

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

Get details for a previously created dataset

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
Dataset

Gedetailleerde informatie voor de gegevensset.

DatasetSources

Informatie over de details van de aanvraag voor het maken van de gegevensset.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

ErrorResponse

Foutreactie

Dataset

Gedetailleerde informatie voor de gegevensset.

Name Type Description
created

string

De gemaakte tijdstempel voor de gegevensset.

datasetId

string

De id voor de gegevensset.

datasetSources

DatasetSources

Informatie over de details van de aanvraag voor het maken van de gegevensset.

description

string

De beschrijving voor de gegevensset.

featureCounts

object

De functie telt voor de gegevensset.

ontology

string

De ontologieversie van deze gegevensset.

DatasetSources

Informatie over de details van de aanvraag voor het maken van de gegevensset.

Name Type Description
appendDatasetId

string

De gegevensset die is toegevoegd aan om de huidige gegevensset te maken.

conversionIds

string[]

De lijst met conversionId die is gebruikt om de gegevensset te maken.

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.