Update eBookInstallSummary

Important: APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported.

Note: Using the Microsoft Graph APIs to configure Intune controls and policies still requires that the Intune service is correctly licensed by the customer.

Update the properties of a eBookInstallSummary object.

Prerequisites

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from most to least privileged)
Delegated (work or school account) DeviceManagementApps.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application Not supported.

HTTP Request

PATCH /deviceAppManagement/managedEBooks/{managedEBookId}/installSummary

Request headers

Header Value
Authorization Bearer <token> Required.
Accept application/json

Request body

In the request body, supply a JSON representation for the eBookInstallSummary object.

The following table shows the properties that are required when you create the eBookInstallSummary.

Property Type Description
id String Key of the entity.
installedDeviceCount Int32 Number of Devices that have successfully installed this book.
failedDeviceCount Int32 Number of Devices that have failed to install this book.
notInstalledDeviceCount Int32 Number of Devices that does not have this book installed.
installedUserCount Int32 Number of Users whose devices have all succeeded to install this book.
failedUserCount Int32 Number of Users that have 1 or more device that failed to install this book.
notInstalledUserCount Int32 Number of Users that did not install this book.

Response

If successful, this method returns a 200 OK response code and an updated eBookInstallSummary object in the response body.

Example

Request

Here is an example of the request.

PATCH https://graph.microsoft.com/beta/deviceAppManagement/managedEBooks/{managedEBookId}/installSummary
Content-type: application/json
Content-length: 178

{
  "installedDeviceCount": 4,
  "failedDeviceCount": 1,
  "notInstalledDeviceCount": 7,
  "installedUserCount": 2,
  "failedUserCount": 15,
  "notInstalledUserCount": 5
}

Response

Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 285

{
  "@odata.type": "#microsoft.graph.eBookInstallSummary",
  "id": "9708ad78-ad78-9708-78ad-089778ad0897",
  "installedDeviceCount": 4,
  "failedDeviceCount": 1,
  "notInstalledDeviceCount": 7,
  "installedUserCount": 2,
  "failedUserCount": 15,
  "notInstalledUserCount": 5
}