Utiliser Postman pour exécuter des opérations avec l’API web

Utilisez Postman pour composer et envoyer des requêtes de l’API Web et afficher les réponses. Cette rubrique décrit comment utiliser Postman pour créer des requêtes de l’API web qui exécutent des opérations de création, récupération, mise à jour et suppression (CRUD) et utiliser les fonctions et les actions.

L’environnement créé en suivant les instructions décrites dans Paramétrer un environnement Postman, crée une variable Postman {{webapiurl}} qui fournit l’URL de base pour les requêtes. Ajoutez-la à cette variable pour définir l’URL de vos requêtes.

Les méthodes et valeurs HTTP que vous utilisez dépendent du type d’opérations que vous souhaitez effectuer. Les sections suivantes décrivent des exemples d’opérations courantes.

Récupérer plusieurs enregistrements

Utilisez une requête GET pour récupérer un ensemble d’enregistrements. L’exemple suivant récupère les trois premiers enregistrements de compte.

Exemple

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

Le corps de la réponse se présente comme suit :

{
    "@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"
        }
    ]
}

Pour plus d’informations, consultez Interroger les données à l’aide de l’API Web.

Récupérer un enregistrement spécifique

Utilisez une requête GET pour récupérer un enregistrement. L’exemple suivant récupère deux propriétés d’un compte spécifique et développe les informations sur le contact principal associé pour inclure un nom complet.

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

Le corps de la réponse se présente comme suit :

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

Plus d’informations : consultez Récupérer une ligne de table à l’aide de l’API web.

Créer un enregistrement

Utilisez une requête POST pour envoyer des données pour créer un enregistrement. Définissez l’URL du nom d’entité défini, dans ce cas, accounts, et définissez les en-têtes indiqué ci-dessous.

POST {{webapiurl}}accounts

Définissez le corps de la requête avec des informations sur le compte à créer.

Lorsque vous envoyez cette requête, le corps est vide, mais l’ID du compte créé est inclus dans la valeur d’en-tête OData-EntityId.

Plus d’informations : Créer une ligne de table à l’aide de l’API web.

Mettre à jour un enregistrement

Utilisez la méthode PATCH pour mettre à jour un enregistrement de table, comme illustré ici.

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

Lorsque vous envoyez cette requête, le corps de la réponse est vide, mais l’ID du compte mis à jour est inclus dans la valeur d’en-tête OData-EntityId.

Plus d’informations : Mettre à jour et supprimer des lignes de table à l’aide de l’API web.

Supprimer un enregistrement

Utilisez la méthode DELETE pour supprimer un enregistrement existant.

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

Lorsque vous envoyez cette requête, l’enregistrement de compte avec le accountid donné est supprimé.

Plus d’informations : Mettre à jour et supprimer des lignes de table à l’aide de l’API web.

Utiliser une fonction

Utilisez une requête GET avec les fonctions répertoriées dans Référence de fonction de l’API Web pour exécuter des opérations réutilisables avec l’API Web. L’exemple suivant décrit comment envoyer une requête de l’API Web qui utilise la RetrieveDuplicates function pour détecter et récupérer les doublons d’un enregistrement spécifié.

Les fonctions renvoient une collection ou un type complexe. La réponse à la RetrieveDuplicates function précédente doit se présenter comme suit :

{
        {
    "@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>
    ]
}
}

Pour plus d’informations, consultez Utiliser les fonctions de l’API Web.

Utiliser une action

Utilisez une requête POST avec les actions répertoriées dans Référence d’action de l’API Web pour effectuer des opérations qui ont des effets secondaires.

Cet exemple montre comment utiliser BulkDetectDuplicates action.

POST {{webapiurl}}BulkDetectDuplicates

La demande dans l’exemple ci-dessus envoie une tâche asynchrone de détection des doublons qui s’exécute en arrière-plan. Les doublons sont détectés en fonction des règles de détection des doublons publiées pour le type de table. BulkDetectDuplicatesResponse ComplexType est renvoyé en tant que réponse de l’BulkDetectDuplicates action. La réponse comprend la propriété JobId qui contient le GUID de la tâche asynchrone de détection des doublons qui détecte et consigne les enregistrements en double.

Pour plus d’informations, consultez Utiliser les actions de l’API Web.

Voir aussi

Utiliser Postman avec l’API Web
Effectuer des opérations à l’aide de l’API web