educationOneRosterApiDataProvider-Ressource

Namespace: microsoft.graph

Wichtig

APIs unter der /beta Version in Microsoft Graph können geändert werden. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in Version 1.0 verfügbar ist, verwenden Sie die Versionsauswahl .

Wird zum Einrichten des Schuldatensynchronisierungsprofils verwendet, wenn die OneRoster-API als Eingabequelle verwendet wird.

Abgeleitet von educationSynchronizationDataProvider.

Eigenschaften

Eigenschaft	Typ	Beschreibung
connectionUrl	Zeichenfolge	Die Verbindungs-URL zur OneRoster-Instanz.
Providername	Zeichenfolge	Der Name des OneRoster-Dienstanbieters gemäß der Definition in der OneRoster-Spezifikation.
schoolsIds	String collection	Die Liste der zu synchronisierenden Schule/OrganisationsourcedId.
termIds	String collection	Die Liste der zu synchronisierenden akademischen Sitzungen .
connectionSettings	educationSynchronizationConnectionSettings	Die OAuth 1.0- oder OAuth 2.0-Einstellungen für die OneRoster-Instanz.
Anpassungen	educationSynchronizationCustomizations	Optionale Anpassung, die auf das Synchronisierungsprofil angewendet werden soll.

Wichtig

OneRoster verwendet akademische Sitzungen anstelle eines einzelnen Schuljahrs, um ihre Daten zu segmentieren. Diese Segmentierung wird innerhalb School Data Sync Benutzeroberfläche, aber nicht dieser API abstrahiert. Sie müssen den OneRoster-Endpunkt /terms aufrufen, um die Sammlung der akademischen Sitzungs-IDs abzurufen, um die termIds Sammlung aufzufüllen.

JSON-Darstellung

{
  "@odata.type": "microsoft.graph.educationoneRosterApiDataProvider",
  "connectionUrl": "String",
  "providerName": "String",
  "schoolsIds": ["String"],
  "termIds": ["String"],
  "connectionSettings": {
    "clientId": "String",
    "clientSecret": "String"
  }
}