Documents de service d’API web

Les points de terminaison OData fournissent des documents de service qui décrivent les fonctionnalités du service. La compréhension de ces documents de service vous aide à utiliser les ressources disponibles dans l’environnement avec lequel vous travaillez.

Document de service

Effectuez une GET demande sur le point de terminaison de l’API web pour afficher le document de service de votre environnement.

Votre point de terminaison d’API web ressemble à ceci : https://yourorg.api.crm.dynamics.com/api/data/v9.2/. Cette partie : yourorg.api.crm, dépend de votre environnement. Consultez Afficher les ressources du développeur pour découvrir comment le trouver.

Vous voyez des résultats comme suit :

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

Le document de service fournit la liste de tous les EntitySets disponibles dans votre environnement. EntitySet est le nom d’une ressource qui fait référence à une table dans Dataverse. Utilisez le nom du jeu d’entités dans l’URL pour effectuer des opérations sur les données d’une table spécifique.

Nom de l'ensemble d’entités

Utilisez toujours la valeur de la propriété EntityMetadata.EntitySetName plutôt que la valeur du nom de la collection logique. Par défaut, le nom du jeu d’entités correspond à la valeur de propriété EntityMetadata.LogicalCollectionName de table, mais ne dépend pas de cette valeur.

Modification du nom du jeu d’entités

Si vous avez une table personnalisée que vous souhaitez adresser à l’aide d’un autre nom d’ensemble d’entités, mettez à jour la valeur de propriété EntityMetadata.EntitySetName pour utiliser un autre nom. Découvrez les propriétés de table que vous pouvez modifier.

Document $metadata CSDL

Pour récupérer le document CSDL (Common Schema Definition Language) $metadata, ajoutez $metadata au point de terminaison de l'API web.

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

Ce document XML décrit toutes les tables et opérations que vous pouvez utiliser dans votre environnement.

Annotations de métadonnées

Pour obtenir plus d’informations à partir du $metadata, ajoutez ?annotations=true à l’URL.

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

Définissez ce paramètre pour inclure de nombreux types d’annotations différents qui peuvent être utiles. La plupart des annotations ne sont pas incluses par défaut, car elles augmentent la taille totale du document.

Vous pouvez également obtenir ces annotations en ajoutant l’en-tête Prefer: odata.include-annotations="*" de requête. Cet en-tête de requête fonctionne pour d’autres types de requêtes. Le annotations=true paramètre de requête fonctionne uniquement pour le document $metadata.

Espace de noms de service

En haut de la $metadata, vous trouverez cet élément XML :

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

Cet élément vous informe que tous les éléments du service se trouvent dans l’espace Microsoft.Dynamics.CRM de noms et que mscrm est l’alias de l’espace de noms. Dans certaines situations, vous devez utiliser le nom entièrement qualifié d’un objet, ce qui implique d’utiliser la valeur de l’espace de noms.

Étapes suivantes

Découvrez les types d’entités.

Voir aussi

Types d’API Web et opérations
Types d’entités d’API web
Propriétés de l’API web
Propriétés de navigation de l’API web
Actions de l’API web
Fonctions d’API web
Types complexes et énumération d’API web
Utiliser l’API web Dataverse