Compartir a través de

Documentos del servicio API web

Los puntos de conexión de OData proporcionan documentos de servicio que describen las funcionalidades del servicio. Comprender estos documentos de servicio le ayuda a usar los recursos disponibles en el entorno con el que está trabajando.

Documento de servicio

Realice una GET solicitud en el endpoint de la API Web para ver el documento de servicio de su entorno.

El punto de conexión de API web tiene un aspecto similar al siguiente: https://yourorg.api.crm.dynamics.com/api/data/v9.2/. Esta parte: yourorg.api.crm, depende de tu entorno. Consulte Ver recursos para desarrolladores para saber cómo encontrarlo.

Si usa Insomnio con la configuración de entorno recomendada, solo tiene que usar la _.webapiurl variable de entorno.

Consulte las instrucciones para ver el documento de $metadata CSDL. Con Insomnio, puede usar consultas XPath para filtrar los resultados del documento XML grande.

Verá resultados como este:

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

El documento de servicio proporciona una lista de todos los EntitySets disponibles en su entorno. EntitySet es el nombre de un recurso que hace referencia a una tabla de Dataverse. Use el nombre del conjunto de entidades en la dirección URL para realizar operaciones en los datos de una tabla específica.

Sugerencia

Use Ctrl+F en los resultados de este documento para buscar el nombre correcto del conjunto de entidades.

Nombre del conjunto de entidades

Use siempre el valor de la propiedad EntityMetadata.EntitySetName en lugar del valor de nombre de la colección lógica. De forma predeterminada, el nombre del conjunto de entidades coincide con el valor de la propiedad EntityMetadata.LogicalCollectionName de la tabla, pero no depende de este valor.

Cambio del nombre del conjunto de entidades

Si tiene una tabla personalizada a la que desea dirigirse mediante un nombre de conjunto de entidades diferente, actualice el valor de la propiedad EntityMetadata.EntitySetName de la tabla para usar un nombre diferente. Obtenga información sobre las propiedades de la tabla que puede cambiar.

Importante

Cambie el EntitySetName de una tabla solo cuando cree la tabla y antes de escribir cualquier código que use la tabla. Al cambiar el nombre, se interrumpe cualquier código que use el nombre anterior.

Documento de metadatos de CSDL

Para recuperar el documento Common Schema Definition Language (CSDL) $metadata, anexe $metadata al punto de conexión de la API web.

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

En este documento XML se describen todas las tablas y operaciones que puede usar en su entorno.

Importante

Este documento es el origen de la verdad para todo lo relacionado con la API web. Haga referencia a él con frecuencia. Use Ctrl+F en este documento para buscar el elemento específico EntityType, Action, Function, ComplexType, o EnumType que use. Los nombres son sensibles a mayúsculas y minúsculas.

Anotaciones de metadatos

Para obtener más información de la $metadata, agregue ?annotations=true a la dirección URL.

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

Establezca este parámetro para incluir muchos tipos diferentes de anotaciones que pueden ser útiles. La mayoría de las anotaciones no se incluyen de forma predeterminada porque aumentan el tamaño total del documento.

También puede obtener estas anotaciones agregando el encabezado de solicitud Prefer: odata.include-annotations="*". Este encabezado de solicitud funciona para otros tipos de solicitudes. El annotations=true parámetro de consulta solo funciona para el documento de $metadata.

Espacio de nombres de servicio

Cerca de la parte superior del $metadata, encontrará este elemento XML:

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

Este elemento le informa de que todos los elementos del servicio están dentro del Microsoft.Dynamics.CRM espacio de nombres y que mscrm es el alias del espacio de nombres. En algunas situaciones, debe usar el nombre completo de un objeto, por lo que se usa el valor del espacio de nombres.

Pasos siguientes

Obtenga información sobre los tipos de entidad.

Tipos de entidad

Consulte también

Operaciones y tipos de API web
Tipos de entidad de API web
Propiedades de api web
Propiedades de navegación de api web
Acciones de API web
Funciones de API web
Tipos complejos y de enumeración de API web
Usar la API web de Dataverse

  • Last updated on