Typen web-API's en bewerkingen met web-API's
Gepubliceerd: januari 2017
Is van toepassing op: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Als u gebruik wilt maken van de web-API, hebt u informatie nodig over wat beschikbaar is voor gebruik. De service wordt beschreven in de service- en metagegevensdocumenten, die u kunt openen. Dit onderwerp geeft een inleiding op belangrijke concepten. Ook wordt beschreven hoe u de benodigde informatie kunt vinden in documentatie die is gegenereerd op basis van de service- en metagegevensdocumenten, evenals de documentatie van de typen, functies en acties van systeementiteiten.
In dit onderwerp
Woordenlijst
Servicedocumenten
Entiteitstypen
Eigenschappen
Navigatie-eigenschappen
Acties
Functies
Complexe typen
Opsommingstypen
Woordenlijst
De web-API wordt geïmplementeerd volgens de standaard van OData v4, die specifieke terminologie gebruikt waar u bekend mee moet zijn.Entity Data Model (EDM) is het abstracte gegevensmodel waarmee de gegevens worden beschreven die een OData-service beschikbaar stelt. In de onderstaande tabel vindt u een lijst met geselecteerde termen die zijn gedefinieerd in OData Version 4.0 Part 1: Protocol Plus Errata 02. Voor een goed begrip van de materie dient u deze termen te kennen.
Term |
Definitie |
|---|---|
Entiteitstypen |
Benoemde gestructureerde typen met een sleutel. Zij definiëren de benoemde relaties en eigenschappen van een entiteit. Entiteitstypen kunnen door een enkele overname worden overgenomen uit andere entiteitstypen. |
Entiteiten |
Exemplaren van entiteitstypen (bijv. account, opportunity). |
Entiteitsets |
Benoemde verzamelingen van entiteiten (bijv. accounts is een entiteitset die account-entiteiten bevat). De sleutel van een entiteit vormt een unieke ID van de entiteit binnen de entiteitset. |
Complexe typen |
Benoemde gestructureerde typen zonder sleutel, die bestaan uit een reeks eigenschappen. Complexe typen worden vaak gebruikt als eigenschapswaarden in modelentiteiten, of als parameters of retourwaarden voor bewerkingen. |
Opsommingstypen of enum-typen |
Benoemde primitieve typen waarvan de waarden benoemde constanten zijn met onderliggende geheel-getalwaarden. |
Functies |
Bewerkingen die geen neveneffecten hebben en verdere samenstellingen kunnen ondersteunen, bijvoorbeeld door aanvullende filterbewerkingen, functies of een actie. |
Acties |
Bewerkingen waarbij neveneffecten mogelijk zijn, zoals aanpassing van gegevens, en die niet verder kunnen worden samengesteld (zodat niet-deterministisch gedrag wordt voorkomen). |
Servicedocumenten
Er zijn twee servicedocumenten die u kunt raadplegen voor meer informatie over de web-API.
Servicedocument
Als u de volgende query invoert in de adresbalk van uw browser, wordt het servicedocument geretourneerd, een volledige lijst van alle entiteitsets die beschikbaar zijn voor uw organisatie. Let erop dat [URI organisatie] staat voor de URL van uw organisatie.
[Organization URI]/api/data/v8.2
De entiteitsets worden geretourneerd in de vorm van een JSON-matrix. Elk item in de matrix heeft drie eigenschappen, zoals vermeld in de onderstaande tabel.
Eigenschap |
Beschrijving |
|---|---|
name |
Dit is de naam van de entiteitset. Deze gegevens zijn afkomstig van de eigenschap EntityMetadata EntityTypeEntitySetName van de entiteit. |
kind |
Voor de web-API worden alleen entiteitsets genoemd. |
url |
Deze waarde is hetzelfde als de eigenschap 'name' en staat voor het deel van het resourcepad waarmee gegevens voor de entiteit worden opgehaald. |
Deze informatie kan worden opgehaald door middel van een GET-aanvraag. Het kan nuttig zijn om een lijst van alle beschikbare entiteitsets op te halen die gebruik maken van de service.
CSDL-metagegevensdocument
Een GET-aanvraag naar de volgende URL retourneert een vrij groot document (ruim 3,5 MB) in de Common Schema Definition Language (CSDL). In dit zogeheten metagegevensdocument worden de gegevens en bewerkingen beschreven, die toegankelijk zijn via de service.
[Organization URI]/api/data/v8.2/$metadata
Dit document kunt u gebruiken als gegevensbron voor het genereren van klassen die sterk getypeerde objecten aan de service leveren. Als u geen gebruik maakt van gegenereerde klassen, kunt u in plaats daarvan ook documentatie raadplegen die op basis van deze informatie is gegenereerd. Het document Web API Reference gebruikt voornamelijk informatie uit dit document, die afkomstig is uit een niet-aangepast systeem.
Meer informatie over dit document vindt u in OData Version 4.0 Part 3: Common Schema Definition Language (CSDL) Plus Errata 02.
Tip
Voordat uw de rest van dit onderwerp doorleest, wordt het aangeraden om de CSDL voor uw organisatie te downloaden en alvast te bekijken hoe de beschreven typen, functies en acties zijn opgenomen in de CSDL en de ondersteunende documentatie.
Entiteitstypen
De Web API EntityType Reference noemt alle systeementiteittypen die toegankelijk zijn via de web-API en waarin zakelijke gegevens worden opgeslagen. Een entiteitstype is een benoemd gestructureerd type met een sleutel. Hiermee worden de benoemde relaties en eigenschappen van een entiteit gedefinieerd. Entiteitstypen kunnen door een enkele overname worden overgenomen uit andere entiteitstypen. In het document Web API Metadata EntityType Reference worden alle entiteitstypen vermeld die worden gebruikt om systeemmetagegevens te beheren. Beide zijn entiteittypen, maar ze verschillen in de manier waarop u ermee werkt. Meer informatie over het gebruik van modelentiteiten vindt u in De web-API gebruiken met Dynamics 365-metagegevens. Elk entiteitstype is opgenomen in een EntityType-element in de CSDL. Hieronder volgt de definitie van het account EntityType in de CSDL, waarbij de eigenschappen en navigatie-eigenschappen zijn verwijderd.
<EntityType Name="account" BaseType="mscrm.crmbaseentity">
<Key>
<PropertyRef Name="accountid" />
</Key>
<!--Properties and navigation properties removed for brevity-->
<Annotation Term="Org.OData.Core.V1.Description" String="Business that represents a customer or potential customer. The company that is billed in business transactions." />
</EntityType>
Elke EntityType-referentiepagina in de SDK-documentatie gebruikt informatie uit de CSDL of de metagegevens en geeft de volgende informatie weer als deze beschikbaar is.
Informatie |
Beschrijving |
|---|---|
Beschrijving |
Een beschrijving van de entiteit. De informatie voor de eigenschap EntityMetadata EntityTypeDescription is opgenomen in het element EntityType, door middel van het element Annotation met de waarde Org.OData.Core.V1.Description voor het kenmerk Term. |
Verzamelings-URL |
De URL voor toegang tot de verzameling van elk type. De informatie van de eigenschap EntityMetadata EntityTypeEntitySetName is opgenomen door middel van het CSDL-element EntityContainer. Het kenmerk Name van elk EntitySet-element bepaalt hoe de toegang tot de gegevens via de URL plaatsvindt. |
Basistype |
Dit is het entiteitstype waar het entiteitstype van is overgenomen. Het kenmerk BaseType van het EntityType-element bevat de naam van het entiteitstype. Deze naam heeft als voorvoegsel de vooraf gedefinieerde alias van de Microsoft.Dynamics.CRM-naamruimte: mscrm.Meer informatie:Typeovername |
weergavenaam |
Deze informatie is niet opgenomen de CSDL, maar wordt opgehaald uit de eigenschap EntityMetadata EntityType DisplayName. |
Primaire sleutel |
De eigenschapswaarde die de unieke ID bevat, waarmee wordt verwezen naar een exemplaar van een entiteit. De waarde van de eigenschap EntityMetadata EntityTypePrimaryIdAttribute is opgenomen in het element EntityTypeKey. Elke entiteit kan slechts één primaire sleutel hebben. Alternatieve sleutels worden niet hier genoemd.Meer informatie:Alternatieve sleutels |
Primair kenmerk |
Bij veel entiteiten is het vereist dat een primaire kenmerkwaarde is ingesteld. Deze wordt om praktische redenen opgenomen. Deze informatie is niet opgenomen de CSDL, maar wordt opgehaald uit de metagegevenseigenschap EntityMetadata EntityType PrimaryNameAttribute. |
Eigenschappen |
Zie Eigenschappen. |
Single-valued navigatie-eigenschappen |
Zie Single-valued navigatie-eigenschappen. |
Collection-valued navigatie-eigenschappen |
Zie Collection-valued navigatie-eigenschappen. |
Bewerkingen die zijn gebonden aan het entiteitstype |
Wanneer een bewerking is gebonden aan een specifiek entiteitstype, wordt het om praktische redenen vermeld. |
Bewerkingen die het entiteitstype gebruiken |
Deze lijst bevat alle bewerkingen die gebruik kunnen maken van het entiteitstype. Deze lijst wordt verkregen door verwijzingen naar alle bewerkingen te verzamelen, die verwijzen naar het huidige type in de parameters of als retourwaarde. |
Entiteitstypen die overnemen uit het huidige entiteitstype |
Deze lijst bevat alle entiteitstypen die rechtstreeks van het entiteitstype overnemen. Zie Typeovername voor meer informatie. |
De naam van een entiteitset wijzigen
Standaard komt de naam van de entiteitset overeen met de waarde van eigenschap EntityMetadata EntityType LogicalCollectionName (EntityMetadataLogicalCollectionName). Als u een aangepaste entiteit hebt die u wilt aanroepen met een andere entiteitsetnaam, kunt u de waarde van eigenschap EntityMetadata EntityTypeEntitySetName (EntityMetadata.EntitySetName) bijwerken om deze andere naam te gebruiken.
Alternatieve sleutels
Hoewel Microsoft Dynamics 365 het mogelijk maakt om alternatieve sleutels aan te maken, vindt u in de Microsoft Dynamics 365 SDK-documentatie uitsluitend de primaire sleutel.
Voor geen enkele systeementiteit is een alternatieve sleutel gedefinieerd. Als u alternatieve sleutels definieert voor een entiteit, worden deze in het CSDL-element EntityType opgenomen als een Annotation, zoals hieronder beschreven:
<Annotation Term="OData.Community.Keys.V1.AlternateKeys">
<Collection>
<Record Type="OData.Community.Keys.V1.AlternateKey">
<PropertyValue Property="Key">
<Collection>
<Record Type="OData.Community.Keys.V1.PropertyRef">
<PropertyValue Property="Alias" String="key name" />
<PropertyValue Property="Name" PropertyPath="key name" />
</Record>
</Collection>
</PropertyValue>
</Record>
</Collection>
</Annotation>
Informatie over alternatieve sleutels kan ook worden opgehaald uit de metagegevens door middel van de collection-valued navigatie-eigenschap EntityMetadata EntityTypeKeys met de web-API of door middel van de eigenschap EntityMetadata.Keys met de organisatieservice.
Typeovername
Overname maakt het mogelijk om gemeenschappelijke eigenschappen te delen en entiteitstypen in groepen te categoriseren. Alle entiteitstypen in de web-API nemen over van twee van de volgende entiteittypen. Alle bedrijfsentiteittypen nemen over van de crmbaseentity EntityType en alle modelentiteiten nemen over van de crmmodelbaseentity EntityType.
Basisentiteit |
Beschrijving |
|---|---|
Alle bedrijfsentiteiten nemen over van deze entiteit. De entiteit heeft geen eigenschappen. Hij dient uitsluitend als een abstracte basisentiteit. |
|
Alle activiteitsentiteiten nemen over van deze entiteit. Deze definieert de gezamenlijke reeks eigenschappen en navigatie-eigenschappen voor activiteitsentiteiten. |
|
De systemuser EntityType en team EntityType nemen een gemeenschappelijke eigenschap ownerid over van deze entiteit. |
|
Alleen MetadataBase EntityType neemt rechtstreeks over van deze entiteit. De entiteit heeft geen eigenschappen. Hij dient uitsluitend als een abstracte basisentiteit. |
|
Alle modelentiteiten nemen over van deze entiteit. Deze levert de eigenschappen MetadataId en HasChanged voor alle modelentiteiten. |
|
Alle modelentiteiten die verschillende typen kenmerken vertegenwoordigen, nemen over van deze entiteit. |
|
De modelentiteiten die kenmerken vertegenwoordigen die een reeks opties omvatten, nemen over van deze entiteit. |
|
Dit modelentiteitstype levert een gedeelde reeks eigenschappen, die worden gebruikt door de modelentiteitstypen BooleanOptionSetMetadata EntityType en OptionSetMetadata EntityType die ervan overnemen. |
|
Dit entiteitstype levert een gedeelde reeks eigenschappen, die worden gebruikt door de modelentiteitstypen ManyToManyRelationshipMetadata EntityType en OneToManyRelationshipMetadata EntityType die ervan overnemen. |
Eigenschappen
Elk entiteitstype kan gedeclareerde eigenschappen hebben, die overeenkomen met kenmerken. In de documenten Web API EntityType Reference en Web API Metadata EntityType Reference worden eigenschappen die zijn overgenomen van een basisentiteitstype gecombineerd in de lijst met gedeclareerde eigenschappen voor elk entiteitstype. De overname wordt genoemd in de beschrijving van elke eigenschap.
In de CSDL-elementen EntityType wordt elke eigenschap opgenomen in een Property-element met een waarde voor het kenmerk Name die overeenkomt met de eigenschappen die u in de code laat instellen. De waarde van het kenmerk Type geeft het gegevenstype van de eigenschap op. Eigenschappen voor bedrijfsentiteittypen gebruiken doorgaans primitieve typen uit OData.
Hieronder volgt een voorbeeld van de eigenschap account EntityTypename zoals die is gedefinieerd in de CSDL.
<Property Name="name" Type="Edm.String" Unicode="false">
<Annotation Term="Org.OData.Core.V1.Description" String="Type the company or business name." />
</Property>
De beschrijving van de eigenschap is beschikbaar in een Annotation-element met de eigenschap Org.OData.Core.V1.Description voor kenmerk Term. Deze beschrijving is overgenomen uit de waarde van eigenschap AttributeMetadata EntityTypeDescription. Niet alle eigenschappen beschikken over een beschrijving.
Elke eigenschap kan worden berekend. Dit betekent dat de waarde door het systeem kan worden ingesteld. Dit wordt opgegeven in een Annotation-element met de waarde Org.OData.Core.V1.Computed voor kenmerk Term.
Elke eigenschap kan ook beperkingen hebben ten aanzien van de mogelijkheid om hem bij te werken. Dit wordt opgegeven in een Annotation-element met de waarde Org.OData.Core.V1.Permissions voor kenmerk Term. De enige optie die hiervoor is ingesteld, is Org.OData.Core.V1.PermissionType/Read, wat aangeeft dat de eigenschap alleen-lezen is.
Primitieve typen
OData ondersteunt omvangrijk assortiment gegevenstypen, maar Microsoft Dynamics 365 maakt niet van alle typen gebruik. In de onderstaande tabel wordt beschreven hoe organisatieservicetypen in Dynamics 365 zijn toegewezen aan primitieve typen in OData.
Type in organisatieservice |
Type in web-API |
Beschrijving |
|---|---|---|
BigInt |
Edm.Int64 |
64-bits ondertekend geheel getal |
Boolean |
Edm.Boolean |
Logica met binaire waarde |
CalendarRules |
Single-valued navigatie-eigenschappen |
Specifieke single-valued navigatie-eigenschappen van het calendarrule EntityType. |
Klant |
Single-valued navigatie-eigenschappen |
De klant van een entiteit met dit type eigenschap kan een single-valued navigatie-eigenschap zijn, die is ingesteld op het entiteitstype account of contact door middel van de betreffende single-valued navigatie-eigenschappen. Als een van de betreffende single-valued verzamelingseigenschappen is ingesteld, wordt de andere gewist. |
DateTime |
Edm.DateTimeOffset |
Datum en tijd met een tijdzone-offset, geen schrikkelseconden. |
Decimaal |
Edm.Decimal |
Numerieke waarden met vaste precisie en schaal |
Double |
Edm.Double |
IEEE 754 binary64 getal met drijvende komma (15-17 decimale cijfers) |
EntityName |
Edm.String |
Reeks van UTF-8-tekens |
Afbeelding |
Edm.Binary |
Binaire gegevens |
Geheel getal |
Edm.Int32 |
32-bits ondertekend geheel getal |
Opzoekveld |
Single-valued navigatie-eigenschap |
Een verwijzing naar een specifieke entiteit |
ManagedProperty |
Niet van toepassing |
Alleen voor intern gebruik. |
Memo |
Edm.String |
Reeks van UTF-8-tekens |
Geld |
Edm.Decimal |
Numerieke waarden met vaste precisie en schaal |
Eigenaar |
Single-valued navigatie-eigenschap |
Een verwijzing naar het principal EntityType. De twee entiteitstypen systemuser en team nemen hun eigenschap ownerid over van het entiteitstype prinicipal. |
PartyList |
Collection-valued navigatie-eigenschap van het entiteitstype activityparty. |
De eigenschap activitypartyparticipationtypemask bevat een waarde die de rol van de deelnemer weergeeft. Zie Typen betrokkenen bij activiteit voor meer informatie. |
Selectielijst |
Edm.Int32 |
32-bits ondertekend geheel getal |
Status |
Edm.Int32 |
32-bits ondertekend geheel getal |
Status |
Edm.Int32 |
32-bits ondertekend geheel getal |
Tekenreeks |
Edm.String |
Reeks van UTF-8-tekens |
Uniqueidentifier |
Edm.Guid |
16-byte (128-bits) unieke ID |
Opzoekeigenschappen
Voor de meeste single-valued navigatie-eigenschappen is er een berekende, alleen-lezen eigenschap die de volgende naamconventie gebruikt: _<name>_value, waarin <name> overeenkomt met de naam van de single-valued navigatie-eigenschap. De uitzondering op dit patroon is als een opzoekkenmerk van de entiteit meerdere typen entiteitenreferenties kan accepteren. Een veelvoorkomend voorbeeld is de manier waarop het kenmerk customerid van entiteit incident kan worden ingesteld op een verwijzing die ofwel een entiteit contact ofwel een entiteit account is. In de incident EntityTypeSingle-valued navigation properties vindt u customerid_account en customerid_contact als afzonderlijke single-valued navigatie-eigenschappen, die de klant weergeven die is gekoppeld aan een verkoopkans. Als u één van deze single-valued navigatie-eigenschappen instelt, wordt de ander ingesteld op null, omdat ze beiden aan het kenmerk customerid zijn gekoppeld. In de incident EntityTypeProperties vindt u een opzoekeigenschap _customerid_value, die dezelfde waarde bevat die is ingesteld voor de single-valued navigatie-eigenschap die een waarde bevat.
Over het algemeen wordt het aangeraden om het gebruik van opzoekeigenschappen te vermijden en de bijbehorende single-valued navigatie-eigenschap te gebruiken. Deze eigenschappen zijn toegevoegd omdat ze nuttig kunnen zijn in bepaalde integratiescenario's. Deze eigenschappen zijn alleen-lezen en berekend, omdat zij alleen de toegepaste wijzigingen weergeven door middel van de bijbehorende single-valued navigatie-eigenschap.
Als u opzoekeigenschappen in een query opneemt, kunt u verzoeken om aantekeningen op te nemen die aanvullende informatie geven over de gegevens die zijn ingesteld voor onderliggende kenmerken die niet worden vertegenwoordigd door een single-valued navigatie-eigenschap.Meer informatie:Gegevens over opzoekeigenschappen ophalen
Navigatie-eigenschappen
In OData kunt u door middel van navigatie-eigenschappen toegang krijgen tot gegevens die gerelateerd zijn aan de huidige entiteit. Als u een entiteit ophaalt, kunt u ervoor kiezen om navigatie-eigenschappen uit te vouwen zodat de gerelateerde gegevens worden opgenomen. Er zijn twee typen navigatie-eigenschappen: single-valued en collection-valued.
Single-valued navigatie-eigenschappen
Deze eigenschappen corresponderen met opzoekkenmerken die veel-op-een-relaties ondersteunen en waarmee verwijzingen naar andere entiteiten kunnen worden ingesteld. In het CSDL-element EntityType worden deze gedefinieerd als een NavigationProperty-element met het kenmerk Type ingesteld op één enkel type. Hieronder volgt een voorbeeld van de single-valued navigatie-eigenschap account EntityTypecreatedby, zoals die is gedefinieerd in de CSDL:
<NavigationProperty Name="createdby" Type="mscrm.systemuser" Nullable="false" Partner="lk_accountbase_createdby">
<ReferentialConstraint Property="_createdby_value" ReferencedProperty="systemuserid" />
</NavigationProperty>
Elke navigatie-eigenschap die een single-valued navigatie-eigenschap vertegenwoordigt, heeft een bijbehorende collection-valued navigatie-eigenschap die wordt aangegeven met de waarde van het kenmerk Partner. Elke single-valued navigatie-eigenschap heeft ook een element ReferentialConstraint met de kenmerkwaarde Property, die de berekende alleen-lezen opzoekeigenschap vertegenwoordigt waarmee de bijbehorende GUID-waarde van de gerelateerde entiteit kan worden opgehaald.Meer informatie:Opzoekeigenschappen
Collection-valued navigatie-eigenschappen
Deze eigenschappen corresponderen met een-op-veel-relaties of veel-op-veel-relaties. In het CSDL-element EntityType worden deze gedefinieerd als een NavigationProperty-element met het kenmerk Type ingesteld op een verzameling van een type. Het volgende geeft de collection-valued navigatie-eigenschap account EntityTypeAccount_Tasks weer, die een een-op-veel-relatie vertegenwoordigt:
<NavigationProperty Name="Account_Tasks" Type="Collection(mscrm.task)" Partner="regardingobjectid_account_task" />
Als de collection-valued navigatie-eigenschap een veel-op-veel-relatie vertegenwoordigt, zijn de naam van de navigatie-eigenschap en de naam van de partner identiek. Het volgende geeft de collection-valued navigatie-eigenschap account EntityTypeaccountleads_association weer, die een veel-op-veel-relatie vertegenwoordigt:
<NavigationProperty Name="accountleads_association" Type="Collection(mscrm.lead)" Partner="accountleads_association" />
Het verschil tussen een-op-veel-relaties en veel-op-veel-relaties is niet van belang wanneer u de web-API gebruikt. De manier waarop entiteiten worden gekoppeld, is hetzelfde ongeacht het type relatie. Hoewel veel-op-veel-relaties op de achtergrond nog steeds gebruik maken van doorsnede-entiteiten, zijn alleen enkele speciale systeemdoorsnede-entiteiten opgenomen in de Web API EntityType Reference.campaignactivityitem EntityType is bijvoorbeeld technisch gesproken een doorsnede-entiteit, maar is opgenomen omdat hij meer eigenschappen heeft dan een gewone doorsnede-entiteit.
Een gewone doorsnede-entiteit heeft alleen de vier basiseigenschappen die vereist zijn om de veel-op-veel-relatie in stand te houden. Wanneer u een aangepaste veel-op-veelrelatie tussen entiteiten maakt, wordt een gewone doorsnede-entiteit gemaakt om de relatie te ondersteunen. Omdat u navigatie-eigenschappen dient te gebruiken om bewerkingen uit te voeren waarbij veel-op-veel-relaties zijn betrokken, worden gewone doorsnede-entiteiten niet gedocumenteerd. Ze zijn echter nog wel beschikbaar via de web-API. Deze doorsnede-entiteitstypen zijn toegankelijk via een entiteitsetnaam die de onderstaande naamconventie gebruikt: <logische naam doorsnede-entiteit>+ 'collection'. U kunt bijvoorbeeld informatie ophalen uit het doorsnede-entiteitstype contactleads door middel van [Organization URI]/api/data/v8.2/contactleadscollection. U dient alleen deze gewone doorsnede-entiteiten te gebruiken in situaties waar u wilt werken met het bijhouden van wijzigingen.
Acties
Acties zijn bewerkingen waarbij neveneffecten mogelijk zijn, zoals aanpassing van gegevens, en die niet verder kunnen worden samengesteld (zodat niet-deterministisch gedrag wordt voorkomen).
Het onderwerp Web API Action Reference geeft een overzicht van de beschikbare systeemacties.Meer informatie:Web-API-acties gebruiken.
Functies
Functies zijn bewerkingen die geen neveneffecten hebben en verdere samenstellingen kunnen ondersteunen, bijvoorbeeld door aanvullende filterbewerkingen, functies of een actie.
Er zijn twee typen functies gedefinieerd in de web-API:
Het onderwerp Web API Function Reference geeft een overzicht van de beschikbare systeemfuncties.
Het onderwerp Web API Query Function Reference geeft een overzicht van functies die zijn bedoeld om te worden gebruikt als criteria in een query.
Meer informatie:Web-API-functies gebruiken
Complexe typen
Complexe typen zijn benoemde gestructureerde typen zonder sleutel, die bestaan uit een reeks eigenschappen. Complexe typen worden vaak gebruikt als eigenschapswaarden in modelentiteiten, of als parameters of retourwaarden voor bewerkingen.
In Web API ComplexType Reference vindt u een overzicht van alle complexe systeemtypen.Complexe typen zijn benoemde gestructureerde typen zonder sleutel, die bestaan uit een reeks eigenschappen. Deze worden vaak gebruikt als eigenschapswaarden in modelentiteiten, of als parameters of retourwaarden voor bewerkingen. Hieronder volgt het WhoAmIResponse ComplexType uit de CSDL.
<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>
Opsommingstypen
Opsommingstypen (ook wel enum-typen genoemd) zijn benoemde primitieve typen waarvan de waarden benoemde constanten zijn met onderliggende geheel-getalwaarden.
In Web API EnumType Reference vindt u een overzicht van alle systeemopsommingstypen.Opsommingstypen zijn benoemde primitieve typen waarvan de waarden benoemde constanten zijn met onderliggende geheel-getalwaarden. Hieronder volgt het AccessRights EnumType uit de CSDL.
<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>
Zie ook
De web-API van Microsoft Dynamics 365 gebruiken
Verifiëren voor Microsoft Dynamics 365 met de web-API
Bewerkingen uitvoeren met de web-API
Microsoft Dynamics 365
© 2017 Microsoft. Alle rechten voorbehouden. Auteursrecht