Update mobileAppSupersedence
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 mobileAppSupersedence 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, DeviceManagementApps.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. |
Application | DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All |
HTTP Request
PATCH /deviceAppManagement/mobileAppRelationships/{mobileAppRelationshipId}
PATCH /deviceAppManagement/mobileApps/{mobileAppId}/relationships/{mobileAppRelationshipId}
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 mobileAppSupersedence object.
The following table shows the properties that are required when you create the mobileAppSupersedence.
Property | Type | Description |
---|---|---|
id | String | The unique identifier for the mobile app relationship entity. This is assigned at MobileAppRelationship entity creation. For example: 2dbc75b9-e993-4e4d-a071-91ac5a218672_43aaaf35-ce51-4695-9447-5eac6df31161. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. Inherited from mobileAppRelationship |
targetId | String | The unique app identifier of the target of the mobile app relationship entity. For example: 2dbc75b9-e993-4e4d-a071-91ac5a218672. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. Inherited from mobileAppRelationship |
targetDisplayName | String | The display name of the app that is the target of the mobile app relationship entity. For example: Firefox Setup 52.0.2 32bit.intunewin. Maximum length is 500 characters. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from mobileAppRelationship |
targetDisplayVersion | String | The display version of the app that is the target of the mobile app relationship entity. For example 1.0 or 1.2203.156. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from mobileAppRelationship |
targetPublisher | String | The publisher of the app that is the target of the mobile app relationship entity. For example: Fabrikam. Maximum length is 500 characters. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from mobileAppRelationship |
targetPublisherDisplayName | String | The publisher display name of the app that is the target of the mobile app relationship entity. For example: Fabrikam. Maximum length is 500 characters. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from mobileAppRelationship |
sourceId | String | The unique app identifier of the source of the mobile app relationship entity. For example: 2dbc75b9-e993-4e4d-a071-91ac5a218672. If null during relationship creation, then it will be populated with parent Id. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from mobileAppRelationship |
sourceDisplayName | String | The display name of the app that is the source of the mobile app relationship entity. For example: Orca. Maximum length is 500 characters. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from mobileAppRelationship |
sourceDisplayVersion | String | The display version of the app that is the source of the mobile app relationship entity. For example 1.0.12 or 1.2203.156 or 3. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from mobileAppRelationship |
sourcePublisherDisplayName | String | The publisher display name of the app that is the source of the mobile app relationship entity. For example: Fabrikam. Maximum length is 500 characters. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from mobileAppRelationship |
targetType | mobileAppRelationshipType | The type of relationship indicating whether the target application of a relationship is a parent or child in the relationship. Possible values are: parent, child. Read-Only. Returned by default. Supports: $select, $filter. Does not support $search, $orderBy. This property is read-only. Inherited from mobileAppRelationship. Possible values are: child , parent , unknownFutureValue . |
supersedenceType | mobileAppSupersedenceType | The supersedence relationship type between the parent and child apps. Possible values are: update, replace. Read-Only. Possible values are: update , replace , unknownFutureValue . |
supersededAppCount | Int32 | The total number of apps directly or indirectly superseded by the child app. Read-Only. This property is read-only. |
supersedingAppCount | Int32 | The total number of apps directly or indirectly superseding the parent app. Read-Only. This property is read-only. |
Response
If successful, this method returns a 200 OK
response code and an updated mobileAppSupersedence object in the response body.
Example
Request
Here is an example of the request.
PATCH https://graph.microsoft.com/beta/deviceAppManagement/mobileAppRelationships/{mobileAppRelationshipId}
Content-type: application/json
Content-length: 665
{
"@odata.type": "#microsoft.graph.mobileAppSupersedence",
"targetId": "Target Id value",
"targetDisplayName": "Target Display Name value",
"targetDisplayVersion": "Target Display Version value",
"targetPublisher": "Target Publisher value",
"targetPublisherDisplayName": "Target Publisher Display Name value",
"sourceId": "Source Id value",
"sourceDisplayName": "Source Display Name value",
"sourceDisplayVersion": "Source Display Version value",
"sourcePublisherDisplayName": "Source Publisher Display Name value",
"targetType": "parent",
"supersedenceType": "replace",
"supersededAppCount": 2,
"supersedingAppCount": 3
}
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: 714
{
"@odata.type": "#microsoft.graph.mobileAppSupersedence",
"id": "c0254204-4204-c025-0442-25c0044225c0",
"targetId": "Target Id value",
"targetDisplayName": "Target Display Name value",
"targetDisplayVersion": "Target Display Version value",
"targetPublisher": "Target Publisher value",
"targetPublisherDisplayName": "Target Publisher Display Name value",
"sourceId": "Source Id value",
"sourceDisplayName": "Source Display Name value",
"sourceDisplayVersion": "Source Display Version value",
"sourcePublisherDisplayName": "Source Publisher Display Name value",
"targetType": "parent",
"supersedenceType": "replace",
"supersededAppCount": 2,
"supersedingAppCount": 3
}