Verwenden von Postman, um Operationen mit der Web-API durchzuführen

Artikel
02/23/2023

Verwenden Sie Postman, um Web-API-Anfragen zu erstellen und zu senden und Antworten anzuzeigen. Dieses Thema beschreibt, wie Sie Postman verwenden, um Web-API-Anfragen zu erstellen, abzurufen, zu aktualisieren und zu löschen (CRUD) und Funktionen und Aktionen mit Postman verwenden.

Wichtig

Sie müssen eine Umgebung haben, die mit den unter Einrichten einer Postman-Umgebung beschriebenen Schritten erstellt wurde.

Die mit den Anweisungen in Einrichten einer Postman-Umgebung erstellte Umgebung erzeugt eine {{webapiurl}}-Postman-Variable, die die Basis-URL für Anfragen liefert. Fügen Sie an diese Variable an, um die URL für Ihre Anfragen zu definieren.

Die verwendeten HTTP-Methoden und -Werte hängen von der Art der Operation, die Sie durchführen möchten, ab. In den folgenden Abschnitten werden die allgemeinen Funktionen erläutert.

Mehrere Datensätze abrufen

Verwenden Sie eine GET-Abfrage, um einen Satz von Datensätzen abzurufen. Im folgenden Beispiel werden die ersten drei Kontodatensätze abgerufen.

Hinweis

Web-API-Anfragen sollten bestimmte HTTP-Header enthalten. Jede Anfrage sollte den Accept-Kopfzeilenwert von application/json beinhalten, auch wenn keine Antwort erwartet wird. Die aktuelle OData-Version ist 4.0, fügen Sie also Header OData-Version: 4.0 ein. Fügen Sie den OData-MaxVersion-Header ein, damit keine Unklarheiten über die Version mit neuen Versionen von OData entstehen. Weitere Informationen: HTTP-Header

Beispiel

GET {{webapiurl}}accounts?$select=name,accountnumber&$top=3

Mehrere Datensätze mit Postman abrufen.

Der Body der Antwort wird so aussehen:

{
    "@odata.context": "https://yourorg.crm.dynamics.com/api/data/v9.0/$metadata#accounts(name,accountnumber)",
    "value": [
        {
            "@odata.etag": "W/\"2291741\"",
            "name": "Contoso Ltd",
            "accountnumber": null,
            "accountid": "9c706dc8-d2f5-e711-a956-000d3a328903"
        },
        {
            "@odata.etag": "W/\"2291742\"",
            "name": "Fourth Coffee",
            "accountnumber": null,
            "accountid": "a2706dc8-d2f5-e711-a956-000d3a328903"
        },
        {
            "@odata.etag": "W/\"2291743\"",
            "name": "Contoso Ltd",
            "accountnumber": null,
            "accountid": "9c3216b8-3efb-e711-a957-000d3a328903"
        }
    ]
}

Mehr Informationen: Datenabfrage über die Web API.

Einen bestimmten Datensatz abrufen

Verwenden Sie eine GET-Abfrage, um einen Datensatz abzurufen. Das folgende Beispiel ruft zwei Eigenschaften von einem bestimmten Konto ab und erweitert die Informationen über den zugehörigen primären Kontakt um den vollständigen Namen.

GET {{webapiurl}}accounts(<accountid>)?$select=name,accountnumber&$expand=primarycontactid($select=fullname)

Datensatz mit Postman abrufen.

Der Body der Antwort wird so aussehen:

{
    "@odata.context": "https://yourorg.crm.dynamics.com/api/data/v9.0/$metadata#accounts(name,accountnumber,primarycontactid(fullname))/$entity",
    "@odata.etag": "W/\"2291742\"",
    "name": "Fourth Coffee",
    "accountnumber": null,
    "accountid": "a2706dc8-d2f5-e711-a956-000d3a328903",
    "primarycontactid": {
        "@odata.etag": "W/\"1697263\"",
        "fullname": "Susie Curtis",
        "contactid": "a3706dc8-d2f5-e711-a956-000d3a328903"
    }
}

Mehr Informationen: Abrufen einer Tabellenzeile mithilfe der Web-API.

Datensatz erstellen

Verwenden Sie eine POST-Anfrage, um Daten zu senden, um einen Datensatz zu erstellen. Legen Sie die URL auf den Entitätssetnamen fest (in diesem Fall accounts) und legen Sie die Header wie hier fest.

POST {{webapiurl}}accounts

Erstellen eines neuen Datensatzes über Web-API.

Legen Sie den Body der Anfrage mit Informationen über das zu erstellende Konto fest.

Text der Anforderung zum Anlegen eines Datensatzes über Web-API.

Wenn Sie diese Anfrage senden, ist der Body leer, aber die ID des erstellten Kontos befindet sich im OData-EntityId Header-Wert.

Mehr Informationen: Erstellen einer Tabellenyeile mithilfe der Web-API.

Datensatz aktualisieren

Verwenden Sie die PATCH Methode zum Aktualisieren eines Tabellendatensatzes, wie hier gezeigt.

PATCH {{webapiurl}}accounts(<accountid>)

Aktualisieren eines Datensatzes über Web-API.

Wenn Sie diese Anfrage senden, ist der Body leer, aber die ID des aktualisierten Kontos befindet sich im OData-EntityId Header-Wert.

Weitere Informationen: Aktualisieren und Löschen von Tabellenzeilen über die Web-API.

Datensatz löschen

Verwenden Sie die DELETE-Methode, um einen vorhandenen Datensatz zu löschen.

DELETE {{webapiurl}}accounts(<accountid>)

Löschen eines Datensatzes über Web-API.

Wenn Sie diese Anfrage absenden, wird der Kontodatensatz mit der angegebenen accountid gelöscht.

Weitere Informationen: Aktualisieren und Löschen von Tabellenzeilen über die Web-API.

Verwenden einer Funktion

Verwenden Sie eine GET-Abfrage mit Funktionen, die unter Web API-Funktionsreferenz aufgeführt sind, um wiederverwendbare Operationen mit der Web API durchzuführen. Das folgende Beispiel zeigt, wie man eine Web-API-Anfrage sendet, die RetrieveDuplicates function verwendet, um Duplikate eines bestimmten Datensatzes zu erkennen und abzurufen.

HTTP-Methode	URL
`GET`	`{{webapiurl}}RetrieveDuplicates(BusinessEntity=@p1,MatchingEntityName=@p2,PagingInfo=@p3)?@p1={'@odata.type':'Microsoft.Dynamics.CRM.account','accountid':'`<accountid>`'}&@p2='account'&@p3={'PageNumber':1,'Count':50}`

Erstellen einer Web-API-Anfrage, die Funktionen verwendet.

Funktionen geben entweder eine Sammlung oder einen komplexen Typ zurück. Die Antwort der obigen RetrieveDuplicates function sollte wie folgt aussehen.

{
        {
    "@odata.context": "https://yourorgname.crm.dynamics.com/api/data/v9.0/$metadata#accounts",
    "value": [
        <Omitted for brevity: JSON data for any matching accounts including all properties>
    ]
}
}

Weitere Informationen finden Sie unter Verwenden von Web-API-Funktionen.

Verwenden einer Aktion

Verwenden Sie eine POST-Abfrage mit Aktionen, die unter Web API-Aktionsreferenz aufgeführt sind, um Operationen mit Nebenwirkungen durchzuführen.

Dieses Beispiel veranschaulicht die Verwendung des BulkDetectDuplicates action.

POST {{webapiurl}}BulkDetectDuplicates

Erstellen einer Web-API-Anfrage, die Aktionen verwendet.

Die Anforderung oben übermittelt einen asynchronen Duplikaterkennungsauftrag, der im Hintergrund ausgeführt wird. Die Duplikate werden entsprechend der veröffentlichten Duplikatregeln für den Tabellentyp erkannt. BulkDetectDuplicatesResponse ComplexType wird als Antwort von BulkDetectDuplicates action zurückgegeben. Die Antwort enthält die Eigenschaft JobId, die die GUID des asynchronen Duplikaterkennungsauftrags enthält, der doppelte Datensätze erkennt und protokolliert.

Weitere Informationen finden Sie unter Verwenden von Web-API-Aktionen.

Siehe auch

Verwenden von Postman mit Web-API
Vorgänge mithilfe der Web-API ausführen