Ändern Sie Ihren Code, um den globalen Suchdienst zu verwenden

Die Discovery Service-APIs können von Ihrer Anwendung verwendet werden, um Geschäftsorganisationsinstanzen (Umgebungen) zu ermitteln, auf die der Anwendungsbenutzer Zugriff hat. Wenn Ihre Anwendung derzeit die Organisationsdienst-API auf dem SOAP-Endpunkt 2011 verwendet, um Organisationsinstanzen zu ermitteln, können Sie die Schritte in dieser Thema ausführen und Ihre Anwendung mithilfe der OData V4 RESTful-API mit der globalen Suchdienst URL in Den Zugriff auf Organisationsdetails konvertieren. Wenn Ihre Anwendung mithilfe der regionalen Suchdienst-URL auf den Suchdienst zugreift, müssen Sie den Anwendungscode von der Verwendung der regionalen URL in die globale Suchdienst-URL ändern.

Eine detaillierte Beschreibung der Verwendung des Suchdienstes mit der RESTful-API finden Sie auf der Seite URL für Ihre Organisation suchen.

Wichtig

Beim Zugriff auf den Suchdienst wird dringend empfohlen, dass Ihre Anwendung den globalen Suchdienst-Endpunkt verwendet (https://globaldisco.crm.dynamics.com) und nicht den regionalen Suchdienst-Endpunkt, der am 2. März 2020 veraltet sein wird. Der globale Suchdienst ist nur verfügbar, wenn die RESTful-API verwendet wird.

Der Rest dieses Dokuments beschreibt die Änderungen, die möglicherweise erforderlich sind, um den Discovery Dienst mithilfe der RESTful-API aufzurufen.

Authentifizierung

Für den Zugriff auf den Suchdienst mithilfe der RESTful-API ist eine Authentifizierung mit einer OAuth 2.0-Zugriffstoken erforderlich. Wenn Ihr Anwendungscode WS-Trust SAML-Token für die Authentifizierung verwendet, müssen Sie den Anwendungscode ändern, um ein OAuth 2.0-Token von Azure Active Directory (AD) abzurufen, und dieses Token dann im Autorisierungsheader der Discovery Service-API-Aufrufe hinzufügen. Weitere Informationen: Verwendung von OAuth mit Microsoft Dataverse.

OData-API-Aufrufe

Die unten gezeigten HTTP-Beispielanforderungen werden von der RESTful-API des Suchdienstes unterstützt. In diesen Beispielen werden die Instanzen-API verwendet, um dieselben Organisationsdaten wie die RetrieveOrganizationsRequest und RetrieveOrganizationRequest Nachrichtenanforderungen der Organisationsdienst-API zurückzugeben.

  • Abrufen aller Instanzen für den Benutzer in allen Regionen.
GET https://globaldisco.crm.dynamics.com/api/discovery/v2.0/Instances
  • Abrufen aller Instanzen für den Benutzer in einer spezifischen Region.
GET  https://globaldisco.crm.dynamics.com/api/discovery/v2.0/Instances(Region={region})

Antwort

{
  "value":[
    {
      "Id":"<GUID>",
      "UniqueName":"myorg",
      "UrlName":"orgurlname",
      "FriendlyName":"My Org",
      "State":0,
      "Version":"<Version>",
      "Url":"https://orgurlname.crm.dynamics.com",
      "ApiUrl":"https://orgurlname.api.crm.dynamics.com"
    }
  ]
}
  • Einzelne Instanz nach ID abrufen
GET https://globaldisco.crm.dynamics.com/api/discovery/v2.0/Instances(<guid>)
  • Einzelne Instanz nach eindeutigem Namen abrufen
GET https://globaldisco.crm.dynamics.com/api/discovery/v2.0/Instances(UniqueName='myorg')  

Response

{
  "Id":"<GUID>",
  "UniqueName":"myorg",
  "UrlName":"orgurlname",
  "FriendlyName":"My Org",
  "State":0,
  "Version":"<Version>",
  "Url":"https://orgurlname.crm.dynamics.com",
  "ApiUrl":"https://orgurlname.api.crm.dynamics.com"
}

Spaltenzuordnung

Die folgende Tabelle zeigt die Spaltenzuordnung in den Antworten, die vom Discovery Service bei Verwendung der beiden APIs zurückgegeben wurden. Diese gelten für alle oben genannten Beispielaufrufe.

Antwortfeld (SOAP Endpunkt) Antwortfeld (OData V4 RESTful Endpunkt)
Endpunkte[WebApplication] Url
Endpunkt[OrganizationService] {ApiUrl}/XRMServices/2011/Organization.svc
Endpunkt[OrganizationDataService] {ApiUrl}//XRMServices/2011/OrganizationData.svc
FriendlyName FriendlyName
OrganizationId Kennung
OrganizationVersion Version
Status Status
  • 0 : Aktiviert
  • 1 : Deaktiviert
    UniqueName UniqueName
    UrlName UrlName

    Veralteter API-Aufruf

    Die Organisationsdienst-API-Nachricht GetUserIdByExternalId wird in der RESTful-API nicht unterstützt.

    Siehe auch

    Suchdienste
    Verwenden der Dataverse-Web-API