Propriétés de l’API web

  • Article

Au sein du document de $métadonnées CSDL, chaque type d’entité qui n’est pas abstrait aura des éléments Property. Chaque élément Property a les attributs suivants :

Attribute Description
Name Le nom de la propriété ; c’est généralement le LogicalName de la colonne et il est toujours en minuscules. Une exception à cette règle est Propriétés de recherche.
Type Type primitif de la propriété. Voir Types primitifs utilisés par Dataverse

Lorsque vous récupérez le document $métadonnées avec Annotations des métadonnées, vous pouvez voir certains éléments Annotation qui peuvent être utiles. Par exemple, les propriétés name et openrevenue suivantes :

<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>

Avec les annotations de cet exemple, vous pouvez savoir que le champ openrevenue est en lecture seule.

La table suivante décrit les annotations renvoyées avec les annotations de métadonnées appliquées.

Terme d’annotation Description
Org.OData.Core.V1.Description Description de la propriété
Org.OData.Core.V1.Computed Si la propriété est calculée ; en lecture seule, car il est calculé par Dataverse.
Org.OData.Core.V1.Permissions Inclut les types d’autorisations disponibles pour la propriété. Ceci n’est inclus que lorsque les autorisations sont limitées et contient toujours la valeur <EnumMember>Org.OData.Core.V1.PermissionType/Read</EnumMember> ce qui signifie que vous ne pouvez lire que cette valeur.

Notes

Les annotations Org.OData.Core.V1.Computed et Org.OData.Core.V1.Permissions se retrouvent fréquemment ensemble, mais pas toujours. L’une ou l’autre signifie que la propriété est en lecture seule.

Types primitifs utilisés par Dataverse

Les propriétés des types d’entité utilisées pour les données commerciales n’incluent que les types primitifs. Le tableau suivant décrit les types primitifs que Dataverse utilise.

Type Description
Edm.Binary Données binaires. Utilisées pour les fichiers et les données d’image.
Edm.Boolean Logique à valeur binaire.
Edm.Date Date sans décalage horaire.
Edm.DateTimeOffset Date et heure avec un décalage de fuseau horaire, pas de seconde intercalaire
Edm.Decimal Valeurs numériques avec précision et échelle fixes
Edm.Double Nombre à virgule flottante binary64 IEEE 754 (15 à 17 nombres décimaux)
Edm.Guid Identificateur unique 16 octets (128 bits)
Edm.Int16 Entier 16 bits signé. Utilisé uniquement pour certaines propriétés EntityType du schéma
Edm.Int32 Entier 32 bits signé
Edm.Int64 Entier 64 bits signé
Edm.String Séquence de caractères UTF-8
Ce type peut inclure la facette Unicode="false".

Lorsque cette facette existe, la propriété de chaîne ne contiendra et n’acceptera que des valeurs de chaîne avec des caractères limités au jeu de caractères ASCII.

Si aucune valeur n’est spécifiée, la facette Unicode prend par défaut la valeur True.

Propriétés de recherche

Vous pouvez trouver des propriétés qui utilisent la convention de dénomination suivante : _<name>_value. On parle de propriétés de recherche. Les propriétés de recherche sont des propriétés calculées en lecture seule qui ont une valeur Edm.Guid. Vous pouvez utiliser ces propriétés de recherche dans un filtre de requête pour faire correspondre tous les enregistrements associés à l’enregistrement unique dans la relation plusieurs-à-un.

OData représente les colonnes de recherche comme Propriétés de navigation à valeur unique plutôt que des propriétés. Dataverse fournit des propriétés de recherche pour simplifier les scénarios afin de récupérer des données à l’aide de la clé primaire d’un enregistrement associé. Pour modifier la valeur d’une propriété de recherche, vous devez modifier la propriété de navigation à valeur unique qu’elle représente. Informations complémentaires : Propriétés de recherche

Lorsque vous incluez des propriétés de recherche dans une requête, vous pouvez demander d’inclure des annotations qui fournissent des informations supplémentaires sur les données définies pour les attributs sous-jacents qui ne sont pas représentés par une propriété de navigation à valeur unique. Plus d’informations : Rechercher les données de propriété

Étapes suivantes

En savoir plus sur les propriétés de navigation.

Propriétés de navigation

Voir aussi

Utiliser l’API Web Dataverse
Types d’API web et opérations
Documents de service de l’API web
EntityTypes de l’API web

Notes

Pouvez-vous nous indiquer vos préférences de langue pour la documentation ? Répondez à un court questionnaire. (veuillez noter que ce questionnaire est en anglais)

Le questionnaire vous prendra environ sept minutes. Aucune donnée personnelle n’est collectée (déclaration de confidentialité).