educationSynchronizationProfileStatus resource type

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.

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 status of a sync educationSynchronizationProfileStatus Return the status of a specific synchronization profile.

Properties

Property Type Description
id String The unique identifier for the resource. (read-only)
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.
lastSynchronizationDateTime DateTimeOffset Represents the time of the most recent successful synchronization.
lastActivityDateTime DateTimeOffset Represents the time when most recent changes were observed in profile.
errorCount Int Number of errors during synchronization.
statusMessage String Status message for the current profile's synchronization stage.

JSON representation

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