Ermitteln Sie die URL für Ihre Organisation mithilfe der Web-API.
Der Discovery Service für die Dynamics 365 for Customer Engagement Web-API ermöglicht es Ihren Anwendungen, zur Laufzeit die Organisationen, auch Instanzen genannt, zu bestimmen, zu denen der angemeldete Benutzer gehört. Sie können detaillierte Informationen über diese Instanzen abrufen, z.B. die Instanz-Service-URL, die Customer Engagement Release-Version, die Instanz-ID und mehr. Sie können standardmäßige $filter- und $select-Parameter zu einer Web-API-Serviceanfrage verwenden, um die zurückgegebene Liste von Instanzdaten anzupassen.
Notiz
Die Dokumentation, die für Onlinebenutzer gilt, ist jetzt in der Power Apps-Dokumentation verfügbar unter: Die URL für Ihre Organisation entdecken mithilfe der Web-API.
Client-Anwendungen benötigen möglicherweise Zugriff auf eine Customer Engagement-Instanz, bei der sich die Instanz-URL im Laufe der Zeit ändern kann. Zum Beispiel, wenn eine Customer Engagement-Instanz von einem lokalen Rechenzentrum in ein anderes verlegt wird. Der Ermittlungsdienst ermöglicht es der Clients-Instanz, die Instanzkennung oder den eindeutigen Instanznamen beizubehalten und dann den Ermittlungsdienst zu verwenden, um die aktuelle Instanzzugriffs-URL zu suchen.
Informationen, die vom Ermittlungsdienst bereitgestellt werden
Organisationsinformationen werden in der Instance Entität des Ermittlungsdiensts gespeichert. Um die Art der Informationen anzuzeigen, die in dieser Entität enthalten sind, senden Sie eine HTTP GET-Anforderung zum Service für eine Ihrer Instanzen.
GET https://dev.{servername}/api/discovery/v9.1/Instances(UniqueName='myorg')
Im oben genannten Beispiel wird der Ermittlungsdienst verwendet, um die Organisationsinformationen der Instanz mit einem eindeutigen Namen "myorg" abzurufen. Weitere Details zu dieser Anforderung werden später in diesem Thema ausführlicher behandelt.
Umfang der zurückgegebenen Informationen
Für den regionalen Ermittlungsdienst gibt der Instances Entitätssatz de Satz an Instanzen zurück, auf die der Benutzer an allen geografischen Orten Zugriff hat, wenn keine Filter angewendet werden. Die zurückgegebenen Daten haben einen Umfang, wie unten beschrieben.
Enthält nicht Instanzen, bei denen das Konto des Benutzers deaktiviert ist
Enthält keine Instanzen, bei denen Benutzer auf Basis einer Instanzsicherheitsgruppe gefiltert wurden
Umfasst nicht Instanzen, auf die der Benutzer Zugriff hat, da er ein stellvertretender Administrator ist
Wenn der aufrufende Benutzer Zugriff auf keine Instanzen hat, gibt die Antwort einfach eine leere Liste zurück
Wie erfolgt der Zugriff auf die Ermittlungsdienste
Im Allgemeinen hat die Web-API-Adresse des Ermittlungsdiensts das folgende Format: <service base address>/api/discovery/. Die Adressen für jeden Bereitstellungstyp werden unten identifiziert. Die Web-API-Adressen und die Versionsnummer für Ihre Bereitstellung in der Webanwendung Customer Engagement finden Sie ganz einfach, indem Sie zu Einstellungen > Anpassung > Entwickler-Ressourcen navigieren.
Die Dienstbasisadresse des Ermittlungsdiensts für eine lokale oder eine IFD-Bereitstellung ist : http[s]://{servername}/ oder http[s]://dev.{servername}/. Dies führt als Ergebnis zur Dienstadresse von http[s]://{servername}/api/discovery/ oder http[s]://dev.{servername}/api/discovery/.
Verwenden des Suchdiensts
Ein Entitätssatz mit der Bezeichnung Instances wird zum Abrufen von Instanzinformationen verwendet. Sie können $select und $filter mit der Instanzentität verwenden, die für das Filtern der zurückgegebenen Daten festgelegt wurde. Sie können auch mithilfe $metadata das Metadatendokument des Services abrufen.
Authentifizierung
Lokale oder IFD-Instanzen der Ermittlungs-OData-V4 RESTful API übernehmen das Authentifizierungsmodell ihrer Bereitstellung. Dabei unterstützen sie entweder die Integrierte Windows-Authentifizierung (IWA) oder OAuth-Tokens von einem vertrauenswürdigen Tokenanbieter. Webanwendungssitzungs-Authentifizierung wird nicht unterstützt.
Web-API-Versionsverwaltung
Versionsverwaltung des Ermittlungsdiensts für ein Datencenter oder lokal/IFD wird unterstützt und ist konsistent mit Versionsnummerierung, wie sie vom Organisationsdienst verwendet wird . Beispiel:
GET https://dev.{servername}/api/discovery/v9.1/Instances(UniqueName='myorg')
CORS-Support
Die Ermittlungsdienst RESTful-API unterstützt den CORS-Standard für den ursprungsübergreifenden Zugriff, wie das für die Web-API zutrifft. Für weitere Informationen zu CORS-Support siehe Verwenden von OAuth mit Cross-Origin Resource Sharing, um eine Single Page-Anwendung zu verbinden
Beispiele
Rufen Sie die Details einer bestimmten Instanz ab. Wenn Sie die GUID auslassen, werden alle Instanzen zurückgegeben, auf die der authentifizierte Benutzer Zugriff hat.
GET https://dev.{servername}/api/discovery/v9.1/Instances(<guid>)Sie können das UniqueName-Attribut als Alternativschlüssel verwenden.
GET https://dev.{servername}/api/discovery/v9.1/Instances(UniqueName='myorg')Rufen Sie eine Liste verfügbarer Instanzen ab, die nach Produktionstyp gefiltert sind.
GET https://dev.{servername}/api/discovery/v9.1/Instances?$select=DisplayName,Description&$filter=Type+eq+0Rufen Sie den Kennungseigenschaftswert einer bestimmten Instanz ab.
GET https://dev.{servername}/api/discovery/v9.1/Instances(UniqueName='myorg')/Id/$value