Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Der Ermittlungsdienst für die Dynamics 365 for Customer Engagement-Web-API ermöglicht es Ihren Anwendungen, zur Laufzeit die Organisationen zu bestimmen, die auch als Instanzen bezeichnet werden, zu denen der angemeldete Benutzer gehört. Sie können detaillierte Informationen zu diesen Instanzen abrufen, z. B. die URL des Instanzdiensts, die Customer Engagement-Releaseversion, die Instanz-ID und vieles mehr. Sie können Standard $filter - und $select Parameter für eine Web-API-Dienstanforderung verwenden, um die zurückgegebene Liste der Instanzdaten anzupassen.
Hinweis
Die Dokumentation, die für Onlinebenutzer gilt, ist jetzt in der Power Apps-Dokumentation verfügbar unter: Ermitteln der URL für Ihre Organisation mithilfe der Web-API.
Clientanwendungen benötigen möglicherweise Zugriff auf eine Customer Engagement-Instanz, bei der sich die Instanz-URL im Laufe der Zeit ändern kann. Dies ist beispielsweise der Fall, wenn eine Customer Engagement-Instanz von einem lokalen Rechenzentrum in ein anderes verschoben wird. Der Discovery-Dienst ermöglicht es der Client-Instanz, die Instanz-ID oder den eindeutigen Namen der Instanz beizubehalten und dann den Discovery-Dienst zu verwenden, um die aktuelle Instanzzugriffs-URL zu suchen.
Vom Discovery-Dienst bereitgestellte Informationen
Organisationsinformationen werden in der Instance Entität des Suchdiensts gespeichert. Um die Art der Informationen anzuzeigen, die in dieser Entität enthalten sind, senden Sie eine HTTP GET-Anforderung an den Service für eine Ihrer Instanzen.
GET https://dev.{servername}/api/discovery/v9.1/Instances(UniqueName='myorg')
Im obigen Beispiel wird der Ermittlungsdienst verwendet, um die Organisationsinformationen der Instanz mit dem eindeutigen Namen "myorg" abzurufen. Weitere Details zu dieser Anforderung werden weiter unten in diesem Thema erläutert.
Umfang der zurückgegebenen Informationen
Für den regionalen Ermittlungsdienst gibt die Instances Entitätsmenge die Gruppe von Instanzen zurück, auf die der Benutzer in einer bestimmten Geografie Zugriff hat, wenn keine Filter angewendet werden. Die zurückgegebenen Daten haben einen Bereich wie unten beschrieben.
Enthält keine Fälle, in denen das Konto des Benutzers deaktiviert ist
Enthält keine Instanzen, bei denen Benutzer basierend auf einer Instanzsicherheitsgruppe herausgefiltert wurden
Enthält keine Instanzen, in denen der Benutzer Zugriff hat, weil er ein delegierter Administrator ist
Wenn der aufrufende Benutzer Zugriff auf keine Instanzen hat, gibt die Antwort einfach eine leere Liste zurück
So greifen Sie auf die Discovery-Dienste zu
Im Allgemeinen hat die Web-API-Adresse des Suchdiensts das folgende Format: <service base address>/api/discovery/. Die Adressen für die einzelnen Bereitstellungstypen sind unten aufgeführt. Sie können die Web-API-Adressen und die Versionsnummer für Ihre Bereitstellung in der Customer Engagement-Webanwendung leicht finden, indem Sie zu Entwicklerressourcen für die Anpassung > von Einstellungen >navigieren.
Die Dienstbasisadresse des Ermittlungsdiensts für eine lokale oder IFD-Bereitstellung lautet : http[s]://{servername}/ oder http[s]://dev.{servername}/. Daraus ergibt sich die Serviceadresse von http[s]://{servername}/api/discovery/ oder http[s]://dev.{servername}/api/discovery/.
Verwenden des Suchdiensts
Eine Entitätsmenge mit dem Namen Instances wird verwendet, um Instanzinformationen abzurufen. Sie können $select und $filter mit dem Entitätssatz Instances verwenden, um die zurückgegebenen Daten zu filtern. Sie können auch verwenden $metadata , um das Metadatendokument des Service abzurufen.
Authentifizierung
On-Premise- oder IFD-Instanzen der Discovery OData V4 RESTful API übernehmen das Authentifizierungsmodell ihrer Bereitstellung und unterstützen entweder die integrierte Windows-Authentifizierung (Integrated Windows Authentication, IWA) oder OAuth-Token von einem vertrauenswürdigen Tokenanbieter. Die Authentifizierung von Webanwendungssitzungen wird nicht unterstützt.
Web-API-Versionierung
Die Versionierung des Discovery-Dienstes für ein Rechenzentrum oder eine On-Premises/IFD-Instanz wird unterstützt und stimmt mit der Versionsnummerierung überein, wie sie vom Organisationsdienst verwendet wird. Beispiel:
GET https://dev.{servername}/api/discovery/v9.1/Instances(UniqueName='myorg')
CORS-Support
Die RESTful-API des Discovery-Diensts unterstützt den CORS-Standard für den ursprungsübergreifenden Zugriff, ebenso wie die Web-API. Weitere Informationen zur CORS-Unterstützung finden Sie unter Verwenden von OAuth mit Cross-Origin Resource Sharing zum Verbinden einer Single Page Application.
Beispiele
Rufen Sie die Details einer bestimmten Instanz ab. Wenn Sie die GUID weglassen, 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 der verfügbaren Instanzen ab, gefiltert nach Produktionstyp.
GET https://dev.{servername}/api/discovery/v9.1/Instances?$select=DisplayName,Description&$filter=Type+eq+0Rufen Sie den Eigenschaftswert der ID einer bestimmten Instanz ab.
GET https://dev.{servername}/api/discovery/v9.1/Instances(UniqueName='myorg')/Id/$value