Types complexes et énumération de l’API web

Dans le document CSDL $metadata, il existe ComplexType et EnumType des éléments.

Types complexes

Les types complexes sont des types structurés nommés sans clé constitués d’un ensemble de propriétés. Les types complexes sont couramment utilisés comme valeurs de propriété dans les définitions de table, ou comme paramètres ou valeurs de retour pour les opérations.

Par exemple, la fonction WhoAmI retourne ce type complexe WhoAmIResponse :

<ComplexType Name="WhoAmIResponse">  
  <Property Name="BusinessUnitId" Type="Edm.Guid" Nullable="false" />  
  <Property Name="UserId" Type="Edm.Guid" Nullable="false" />  
  <Property Name="OrganizationId" Type="Edm.Guid" Nullable="false" />  
</ComplexType>

Types d'énumération

Les types d’énumération sont des types primitifs nommés dont les valeurs sont nommées constantes avec des valeurs entières sous-jacentes.

Par exemple, le nœud XML suivant est la définition du type d’énumération AccessRights

<EnumType Name="AccessRights">  
  <Member Name="None" Value="0" />  
  <Member Name="ReadAccess" Value="1" />  
  <Member Name="WriteAccess" Value="2" />  
  <Member Name="AppendAccess" Value="4" />  
  <Member Name="AppendToAccess" Value="16" />  
  <Member Name="CreateAccess" Value="32" />  
  <Member Name="DeleteAccess" Value="65536" />  
  <Member Name="ShareAccess" Value="262144" />  
  <Member Name="AssignAccess" Value="524288" />  
</EnumType>

Le AccessRights type d’énumération est utilisé pour la AccessMask propriété du type complexe PrincipalAccess, qui est utilisé pour définir le PrincipalAccess paramètre pour l’action ModifyAccess. Utilisez cette action pour modifier l’accès lors du partage d’un enregistrement.

L’exemple ci-dessous accorde ReadAccess, WriteAccess, DeleteAccess, AppendAccess et AssignAccess des droits d’accès à l’enregistrement account spécifié par le paramètre Target à l’élément systemuser désigné par la propriété Principal du type de données complexe PrincipalAccess.

Requête :

POST [Organization URI]/api/data/v9.2/ModifyAccess
OData-Version: 4.0
OData-MaxVersion: 4.0
Content-Type: application/json; charset=UTF-8
Accept: application/json

{
    "Target": {
        "accountid": "cbcf8bbc-aa41-ec11-8c62-000d3a53893c",
        "@odata.type": "Microsoft.Dynamics.CRM.account"
    },
    "PrincipalAccess": {
        "Principal": {
            "systemuserid": "8061643d-ebf7-e811-a974-000d3a1e1c9a",
            "@odata.type": "Microsoft.Dynamics.CRM.systemuser"
        },
        "AccessMask": "ReadAccess,WriteAccess,DeleteAccess,AppendAccess,AssignAccess"
    }
}

Réponse:

HTTP/1.1 204 No Content

Étapes suivantes

Effectuez des opérations à l’aide de l’API web.

Effectuer des opérations à l’aide de l’API Web

Voir aussi

Types d’API Web et opérations
Documents de service d’API web
EntityTypes de l’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
Utiliser l’API web Dataverse
OData version 4.0. Type complexe
Type d’énumération OData version 4.0