Freigeben über

Web-API-Dienstdokumente

OData-Endpunkte stellen Dienstdokumente bereit, die die Funktionen des Diensts beschreiben. Wenn Sie diese Dienstdokumente verstehen, können Sie die Ressourcen verwenden, die in der Umgebung verfügbar sind, mit der Sie arbeiten.

Dienstdokument

Führen Sie eine GET Anforderung am Web-API-Endpunkt aus, um das Dienstdokument für Ihre Umgebung anzuzeigen.

Ihr Web-API-Endpunkt sieht ungefähr wie folgt aus: https://yourorg.api.crm.dynamics.com/api/data/v9.2/. Dieser Teil: yourorg.api.crm, hängt von Ihrer Umgebung ab. Unter Entwicklerressourcen anzeigen erfahren Sie, wie Sie ihn finden.

Wenn Sie Schlaflosigkeit mit den empfohlenen Umgebungseinstellungen verwenden, verwenden Sie einfach die _.webapiurl Umgebungsvariable.

Lesen Sie die Anweisungen zum Anzeigen des CSDL-$metadata Dokuments. Mit Schlaflosigkeit können Sie XPath-Abfragen verwenden, um die Ergebnisse des großen XML-Dokuments zu filtern.

Die Ergebnisse werden wie folgt angezeigt:

{
    "@odata.context": "https://yourorg.api.crm.dynamics.com/api/data/v9.2/$metadata",
    "value": [
        {
            "name": "accountleadscollection",
            "kind": "EntitySet",
            "url": "accountleadscollection"
        },
        {
            "name": "accounts",
            "kind": "EntitySet",
            "url": "accounts"
        },
    ...

Das Dienstdokument stellt eine Liste aller in Ihrer Umgebung verfügbaren EntitySets bereit. Ein EntitySet ist der Name einer Ressource, die auf eine Tabelle in Dataverse verweist. Verwenden Sie den Entitätssatznamen in der URL, um Vorgänge für die Daten in einer bestimmten Tabelle auszuführen.

Tipp

Verwenden Sie STRG+F für die Ergebnisse dieses Dokuments, um den richtigen Entitätssatznamen zu finden.

Entitätssatzname

Verwenden Sie immer den Wert der EntityMetadata.EntitySetName-Eigenschaft anstelle des logischen Auflistungsnamenswerts. Standardmäßig entspricht der Entitätssatzname dem Wert der Tabelle "EntityMetadata.LogicalCollectionName" , hängt jedoch nicht von diesem Wert ab.

Name des Entitätensatzes ändern

Wenn Sie über eine benutzerdefinierte Tabelle verfügen, die Sie adressieren möchten, indem Sie einen anderen Entitätssatznamen verwenden, aktualisieren Sie den Wert der EntitätMetadata.EntitySetName-Eigenschaft , um einen anderen Namen zu verwenden. Erfahren Sie mehr über tabelleneigenschaften, die Sie ändern können.

Von Bedeutung

Ändern Sie die EntitySetName Tabelle nur, wenn Sie die Tabelle erstellen und bevor Sie Code schreiben, der die Tabelle verwendet. Durch Ändern des Namens wird jeder Code, der den alten Namen verwendet, umgebrochen.

CSDL-$metadata-Dokument

Fügen Sie $metadata an den Web-API-Endpunkt an, um das Common Schema Definition Language (CSDL) $metadata-Dokument abzurufen.

Beispiel: https://yourorg.api.crm.dynamics.com/api/data/v9.2/$metadata

In diesem XML-Dokument werden alle Tabellen und Vorgänge beschrieben, die Sie in Ihrer Umgebung verwenden können.

Von Bedeutung

Dieses Dokument ist die Quelle der Wahrheit für alles im Zusammenhang mit der Web-API. Verweisen Sie häufig darauf. Verwenden Sie STRG+F in diesem Dokument, um die spezifischen EntityType, Action, Function, ComplexType oder EnumType zu finden, die Sie verwenden. Bei den Namen wird die Groß-/Kleinschreibung beachtet.

Metadatenanmerkungen

Um weitere Informationen aus dem $metadata zu erhalten, fügen Sie ?annotations=true der URL hinzu.

Beispiel: https://yourorg.api.crm.dynamics.com/api/data/v9.2/$metadata?annotations=true

Legen Sie diesen Parameter so fest, dass es viele verschiedene Arten von Anmerkungen enthält, die nützlich sein können. Die meisten Anmerkungen sind standardmäßig nicht enthalten, da sie die Gesamtgröße des Dokuments erhöhen.

Sie können diese Anmerkungen auch abrufen, indem Sie den Prefer: odata.include-annotations="*" Anforderungsheader hinzufügen. Dieser Anforderungsheader funktioniert für andere Arten von Anforderungen. Der annotations=true Abfrageparameter funktioniert nur für das $metadata Dokument.

Dienst-Namespace

Am oberen Rand des $metadata finden Sie dieses XML-Element:

    <edmx:DataServices>
        <Schema Namespace="Microsoft.Dynamics.CRM" Alias="mscrm" xmlns="http://docs.oasis-open.org/odata/ns/edm">

Dieses Element informiert Sie darüber, dass sich alle Elemente im Dienst im Microsoft.Dynamics.CRM Namespace befinden und dass mscrm es sich um den Alias für den Namespace handelt. In einigen Fällen müssen Sie den vollqualifizierten Namen eines Objekts verwenden, sodass Sie den Namespacewert verwenden.

Nächste Schritte

Erfahren Sie mehr über Entitätstypen.

Entitätstypen

Siehe auch

Web-API-Typen und -Vorgänge
Web-API-Entitätstypen
Web-API-Eigenschaften
Web-API-Navigationseigenschaften
Web-API-Aktionen
Web-API-Funktionen
Komplexe Web-API- und Enumerationstypen
Verwenden der Dataverse-Web-API

  • Last updated on