Checking the Synchronization Status

To check the synchronization status, use the sync_status custom operation of the Tenant APS resource whose APS ID you prepared, as explained below.

Important: Checking the status of synchronization is a custom operation. The user whose key and secret you use to access the APS REST API must have http://www.parallels.com/Office365/Tenant and GET in its list of allowed operations.

HTTP Request

Copy

GET https://BRAND_DOMAIN/aps/2/resources/APS_ID_OF_TENANT_RESOURCE/sync_status

HTTP Response

Copy

{
  "inProgress": SYNCHRONIZATION_STATE,
  "lastSync": SYNCHRONIZATION_RESULTS
}

This response contains the following data:

SYNCHRONIZATION_STATE: This indicates whether the synchronization of the specified Microsoft account is in progress (true or false).
SYNCHRONIZATION_RESULTS: This contains the results of the last synchronization (0 means that it was performed successfully).

Example

HTTP Request

Copy

GET https://example.com/aps/2/resources/d8812853-3a26-4058-8881-6e1e9bd31cab/sync_status

HTTP Response

Copy

{
  "inProgress": false,
  "lastSync": 0
}