Propiedades de API web

En el documento $metadata de CSDL, cada tipo de entidad que no sea abstracta tiene elementos Property. Cada elemento de Property tiene los siguientes atributos:

Attribute	Descripción
Name	El nombre de la propiedad; normalmente el LogicalName de la columna y siempre en minúsculas. Una excepción a esta regla son las propiedades de búsqueda.
Type	El tipo primitivo de la propiedad. Vea Tipos primitivos utilizados por Dataverse

Cuando recupere el documento $metadata con Anotaciones de metadatos puede ver algunos elementos Annotation que pueden resultar útiles. Por ejemplo, las siguientes propiedades name y openrevenue:

<Property Name="name" Type="Edm.String" Unicode="false">
    <Annotation Term="Org.OData.Core.V1.Description" String="Type the company or business name." />
</Property>
<Property Name="openrevenue" Type="Edm.Decimal" Scale="Variable">
    <Annotation Term="Org.OData.Core.V1.Description" String="Sum of open revenue against an account and its child accounts." />
    <Annotation Term="Org.OData.Core.V1.Computed" Bool="true" />
    <Annotation Term="Org.OData.Core.V1.Permissions">
        <EnumMember>Org.OData.Core.V1.PermissionType/Read</EnumMember>
    </Annotation>
</Property>

Con las anotaciones en este ejemplo, puede saber que el campo openrevenue es de solo lectura.

La siguiente tabla describe las anotaciones que se devuelven con anotaciones de metadatos aplicadas.

Vigencia de la anotación	Descripción
Org.OData.Core.V1.Description	Una descripción de la propiedad
Org.OData.Core.V1.Computed	Si se computa la propiedad; solo lectura porque lo calcula Dataverse.
Org.OData.Core.V1.Permissions	Incluye los tipos de permisos disponibles para la propiedad. Solo se incluye cuando los permisos son limitados y siempre contiene el valor <EnumMember>Org.OData.Core.V1.PermissionType/Read</EnumMember> lo que significa que es de solo lectura.

Nota

Las anotaciones Org.OData.Core.V1.Computed y Org.OData.Core.V1.Permissions se encuentran frecuentemente juntas, pero no siempre. Cualquiera de ellas significa que la propiedad es de solo lectura.

Tipos primitivos que usa Dataverse

Las propiedades de los tipos de entidad que se usan para los datos profesionales solo incluirán solo tipos primitivos. La siguiente tabla describe los tipos primitivos que usa Dataverse.

Type	Descripción
Edm.Binary	Datos binarios. Se utiliza para los datos de archivos e imágenes.
Edm.Boolean	Lógica de valor binario.
Edm.Date	Fecha sin desplazamiento de zona horaria.
Edm.DateTimeOffset	Fecha y hora con un desplazamiento de zona horaria, no hay segundos bisiestos
Edm.Decimal	Valores numéricos con precisión y escala fijas
Edm.Double	Número de coma flotante binaryIEEE 754 binary64 (15-17 dígitos decimales)
Edm.Guid	Identificador único de 16 bytes (128 bits)
Edm.Int16	Entero de 16 bits firmado Se usa solo para ciertas propiedades de EntityType de esquema
Edm.Int32	Entero de 32 bits firmado
Edm.Int64	Entero de 64 bits firmado
Edm.String	Secuencia de caracteres UTF-8 Este tipo puede incluir la faceta Unicode="false". Cuando existe esta faceta, la propiedad de cadena solo contiene y acepta valores de cadena con caracteres limitados para el juego de caracteres ASCII. Si no se especifica ningún valor, el valor predeterminado de la faceta Unicode es verdadero.

Propiedades de búsqueda

Algunas propiedades utilizan la siguiente convención de nomenclatura: _<name>_value. Estas se denominan propiedades de búsqueda. Las propiedades de búsqueda son propiedades calculadas de solo lectura que tienen un valor Edm.Guid. Puede utilizar estas propiedades de búsqueda en un filtro de consulta para hacer coincidir todos los registros asociados con el único registro en la relación de varios a uno.

OData representa las columnas de búsqueda como Propiedades de navegación de valor único en lugar de propiedades. Dataverse proporciona propiedades de búsqueda para simplificar escenarios para recuperar datos utilizando la clave principal de un registro relacionado. Para cambiar el valor de una propiedad de búsqueda, debe cambiar la propiedad de navegación de u solo valor que representa. Más información: Propiedades de búsqueda

Al incluir propiedades de búsqueda en una consulta, puede solicitar la inclusión de anotaciones que proporcionen más información sobre los datos que se establecen para estos atributos subyacentes que no están representados por una propiedad de navegación de un solo valor. Más información: Datos de propiedades de búsqueda

Pasos siguientes

Obtenga más información sobre las propiedades de navegación.

Propiedades de navegación

Consulte también

Usar la API web de Dataverse
Tipos y operaciones de API web
Documentos de servicio de la API web
EntityTypes de la API web

Nota

¿Puede indicarnos sus preferencias de idioma de documentación? Realice una breve encuesta. (tenga en cuenta que esta encuesta está en inglés)

La encuesta durará unos siete minutos. No se recopilan datos personales (declaración de privacidad).