educationSynchronizationProfileStatus resource type (deprecated)

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Caution

The Education Synchronization Profile API is deprecated and will stop returning data on December 31, 2024. For information about how to migrate to the new Industry Data API, see Transition from School Data Sync (Classic).

Represents the synchronization status of a school data synchronization profile.

Note: Updates to the educationSynchronizationProfileStatus might be delayed due to the asynchronous nature of background sync processing.

Methods

Method Return Type Description
Get educationSynchronizationProfileStatus Return the status of a specific synchronization profile.

Properties

Property Type Description
errorCount Int64 Number of errors during synchronization.
id String The unique identifier for the resource. Read-only.
lastActivityDateTime DateTimeOffset Date and time when most recent changes were observed in the profile.
lastSynchronizationDateTime DateTimeOffset Date and time of the most recent successful synchronization.
status educationSynchronizationStatus The status of a sync. The possible values are: paused, inProgress, success, error, validationError, quarantined, unknownFutureValue, extracting, validating. Note that you must use the Prefer: include-unknown-enum-members request header to get the following values in this evolvable enum: extracting, validating.
statusMessage String Status message for the synchronization stage of the current profile.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#education/synchronizationProfiles/{id}/profileStatus/$entity",
  "errorCount": "Int64",
  "id": "String",
  "lastActivityDateTime": "DateTimeOffset",
  "lastSynchronizationDateTime": "DateTimeOffset",
  "status": "String",
  "statusMessage": "String"
}