Edit

Share via

Update mobileAppPolicySetItem

  • Article

Namespace: microsoft.graph

Important: Microsoft Graph APIs under the /beta version are subject to change; production use is not supported.

Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.

Update the properties of a mobileAppPolicySetItem object.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet
✅ ✅ ✅ ✅

Permissions

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 least to most privileged)
Delegated (work or school account) DeviceManagementConfiguration.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application DeviceManagementConfiguration.ReadWrite.All

HTTP Request

PATCH /deviceAppManagement/policySets/{policySetId}/items/{policySetItemId}

Request headers

Header Value
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Accept application/json

Request body

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

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

Property Type Description
id String Key of the PolicySetItem. Inherited from policySetItem
createdDateTime DateTimeOffset Creation time of the PolicySetItem. Inherited from policySetItem
lastModifiedDateTime DateTimeOffset Last modified time of the PolicySetItem. Inherited from policySetItem
payloadId String PayloadId of the PolicySetItem. Inherited from policySetItem
itemType String policySetType of the PolicySetItem. Inherited from policySetItem
displayName String DisplayName of the PolicySetItem. Inherited from policySetItem
status policySetStatus Status of the PolicySetItem. Inherited from policySetItem. Possible values are: unknown, validating, partialSuccess, success, error, notAssigned.
errorCode errorCode Error code if any occured. Inherited from policySetItem. Possible values are: noError, unauthorized, notFound, deleted.
guidedDeploymentTags String collection Tags of the guided deployment Inherited from policySetItem
intent installIntent Install intent of the MobileAppPolicySetItem. Possible values are: available, required, uninstall, availableWithoutEnrollment.
settings mobileAppAssignmentSettings Settings of the MobileAppPolicySetItem.

Response

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

Example

Request

Here is an example of the request.

PATCH https://graph.microsoft.com/beta/deviceAppManagement/policySets/{policySetId}/items/{policySetItemId}
Content-type: application/json
Content-length: 896

{
  "@odata.type": "#microsoft.graph.mobileAppPolicySetItem",
  "payloadId": "Payload Id value",
  "itemType": "Item Type value",
  "displayName": "Display Name value",
  "status": "validating",
  "errorCode": "unauthorized",
  "guidedDeploymentTags": [
    "Guided Deployment Tags value"
  ],
  "intent": "required",
  "settings": {
    "@odata.type": "microsoft.graph.winGetAppAssignmentSettings",
    "notifications": "showReboot",
    "restartSettings": {
      "@odata.type": "microsoft.graph.winGetAppRestartSettings",
      "gracePeriodInMinutes": 4,
      "countdownDisplayBeforeRestartInMinutes": 6,
      "restartNotificationSnoozeDurationInMinutes": 10
    },
    "installTimeSettings": {
      "@odata.type": "microsoft.graph.winGetAppInstallTimeSettings",
      "useLocalTime": true,
      "deadlineDateTime": "2017-01-01T00:00:21.0378955-08:00"
    }
  }
}

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: 1068

{
  "@odata.type": "#microsoft.graph.mobileAppPolicySetItem",
  "id": "b6ffe6cf-e6cf-b6ff-cfe6-ffb6cfe6ffb6",
  "createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
  "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
  "payloadId": "Payload Id value",
  "itemType": "Item Type value",
  "displayName": "Display Name value",
  "status": "validating",
  "errorCode": "unauthorized",
  "guidedDeploymentTags": [
    "Guided Deployment Tags value"
  ],
  "intent": "required",
  "settings": {
    "@odata.type": "microsoft.graph.winGetAppAssignmentSettings",
    "notifications": "showReboot",
    "restartSettings": {
      "@odata.type": "microsoft.graph.winGetAppRestartSettings",
      "gracePeriodInMinutes": 4,
      "countdownDisplayBeforeRestartInMinutes": 6,
      "restartNotificationSnoozeDurationInMinutes": 10
    },
    "installTimeSettings": {
      "@odata.type": "microsoft.graph.winGetAppInstallTimeSettings",
      "useLocalTime": true,
      "deadlineDateTime": "2017-01-01T00:00:21.0378955-08:00"
    }
  }
}