Update sharePointRestoreSession

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.

Update the properties of a sharePointRestoreSession 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

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	BackupRestore-Restore.ReadWrite.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	BackupRestore-Restore.ReadWrite.All	Not available.

HTTP request

PATCH /solutions/backupRestore/sharePointRestoreSessions/{sharePointRestoreSessionId}

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

Request body

In the request body, supply only the values for properties that should be updated. Existing properties that aren't included in the request body maintains their previous values or be recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

Property	Type	Description
siteRestoreArtifacts	siteRestoreArtifact collection	A collection of siteRestoreArtifact objects. Required.

Response

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

Examples

Request

The following example shows a request.

To remove a siteRestoreArtifact from a site restore session, specify the @removed annotation in the request body for the respective restore point artifact together with the ID of the siteRestoreArtifact.

HTTP

PATCH https://graph.microsoft.com/beta/solutions/backupRestore/sharepointRestoreSessions/845457dc-4bb2-4815-bef3-8628ebd1952eessions
Content-Type: application/json

{
  "siteRestoreArtifacts@delta": [
    {
      "restorePoint": { "@odata.id": "1b014d8c-71fe-4d00-a01a-31850bc5b32c" }, //Create a new site restore artifact and add it under the Restore Session.
      "destinationType": "new"
    },
    {
      "restorePoint": { "@odata.id": "2b014d8c-71fe-4d00-a01a-31850bc5b32" },
      "destinationType": "new"
    },
    {
      "restorePoint": { "@odata.id": "3b014d8c-71fe-4d00-a01a-31850bc5b32c" },
      "destinationType": "new"
    },
    {
      "restorePoint": { "@odata.id": "4b014d8c-71fe-4d00-a01a-31850bc5b32c" },
      "destinationType": "new"
    },
    {
      "@removed": {
        "reason": "changed"
      },
      "id": "959ba739-70b5-43c4-8c90-b2c22014f18a"
    },
    {
      "@removed": {
        "reason": "changed"
      },
      "id": "959ba739-70b5-43c4-8c90-b2c22014f18b"
    },
    {
      "@removed": {
        "reason": "changed"
      },
      "id": "959ba739-70b5-43c4-8c90-b2c22014f18c"
    }
  ]
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new SharePointRestoreSession
{
	AdditionalData = new Dictionary<string, object>
	{
		{
			"siteRestoreArtifacts@delta" , new List<object>
			{
				new 
				{
					RestorePoint = new 
					{
						OdataId = "1b014d8c-71fe-4d00-a01a-31850bc5b32c",
					},
					DestinationType = "new",
				},
				new 
				{
					RestorePoint = new 
					{
						OdataId = "2b014d8c-71fe-4d00-a01a-31850bc5b32",
					},
					DestinationType = "new",
				},
				new 
				{
					RestorePoint = new 
					{
						OdataId = "3b014d8c-71fe-4d00-a01a-31850bc5b32c",
					},
					DestinationType = "new",
				},
				new 
				{
					RestorePoint = new 
					{
						OdataId = "4b014d8c-71fe-4d00-a01a-31850bc5b32c",
					},
					DestinationType = "new",
				},
				new 
				{
					Removed = new 
					{
						Reason = "changed",
					},
					Id = "959ba739-70b5-43c4-8c90-b2c22014f18a",
				},
				new 
				{
					Removed = new 
					{
						Reason = "changed",
					},
					Id = "959ba739-70b5-43c4-8c90-b2c22014f18b",
				},
				new 
				{
					Removed = new 
					{
						Reason = "changed",
					},
					Id = "959ba739-70b5-43c4-8c90-b2c22014f18c",
				},
			}
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Solutions.BackupRestore.SharePointRestoreSessions["{sharePointRestoreSession-id}"].PatchAsync(requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

CLI

mgc-beta solutions backup-restore share-point-restore-sessions patch --share-point-restore-session-id {sharePointRestoreSession-id} --body '{\
  "siteRestoreArtifacts@delta": [\
    {\
      "restorePoint": { "@odata.id": "1b014d8c-71fe-4d00-a01a-31850bc5b32c" }, //Create a new site restore artifact and add it under the Restore Session.\
      "destinationType": "new"\
    },\
    {\
      "restorePoint": { "@odata.id": "2b014d8c-71fe-4d00-a01a-31850bc5b32" },\
      "destinationType": "new"\
    },\
    {\
      "restorePoint": { "@odata.id": "3b014d8c-71fe-4d00-a01a-31850bc5b32c" },\
      "destinationType": "new"\
    },\
    {\
      "restorePoint": { "@odata.id": "4b014d8c-71fe-4d00-a01a-31850bc5b32c" },\
      "destinationType": "new"\
    },\
    {\
      "@removed": {\
        "reason": "changed"\
      },\
      "id": "959ba739-70b5-43c4-8c90-b2c22014f18a"\
    },\
    {\
      "@removed": {\
        "reason": "changed"\
      },\
      "id": "959ba739-70b5-43c4-8c90-b2c22014f18b"\
    },\
    {\
      "@removed": {\
        "reason": "changed"\
      },\
      "id": "959ba739-70b5-43c4-8c90-b2c22014f18c"\
    }\
  ]\
}\
'

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

SharePointRestoreSession sharePointRestoreSession = new SharePointRestoreSession();
HashMap<String, Object> additionalData = new HashMap<String, Object>();
LinkedList<Object> siteRestoreArtifactsDelta = new LinkedList<Object>();
 property = new ();
 restorePoint = new ();
restorePoint.setOdataId("1b014d8c-71fe-4d00-a01a-31850bc5b32c");
property.setRestorePoint(restorePoint);
property.setDestinationType("new");
siteRestoreArtifactsDelta.add(property);
 property1 = new ();
 restorePoint1 = new ();
restorePoint1.setOdataId("2b014d8c-71fe-4d00-a01a-31850bc5b32");
property1.setRestorePoint(restorePoint1);
property1.setDestinationType("new");
siteRestoreArtifactsDelta.add(property1);
 property2 = new ();
 restorePoint2 = new ();
restorePoint2.setOdataId("3b014d8c-71fe-4d00-a01a-31850bc5b32c");
property2.setRestorePoint(restorePoint2);
property2.setDestinationType("new");
siteRestoreArtifactsDelta.add(property2);
 property3 = new ();
 restorePoint3 = new ();
restorePoint3.setOdataId("4b014d8c-71fe-4d00-a01a-31850bc5b32c");
property3.setRestorePoint(restorePoint3);
property3.setDestinationType("new");
siteRestoreArtifactsDelta.add(property3);
 property4 = new ();
 removed = new ();
removed.setReason("changed");
property4.setRemoved(removed);
property4.setId("959ba739-70b5-43c4-8c90-b2c22014f18a");
siteRestoreArtifactsDelta.add(property4);
 property5 = new ();
 removed1 = new ();
removed1.setReason("changed");
property5.setRemoved(removed1);
property5.setId("959ba739-70b5-43c4-8c90-b2c22014f18b");
siteRestoreArtifactsDelta.add(property5);
 property6 = new ();
 removed2 = new ();
removed2.setReason("changed");
property6.setRemoved(removed2);
property6.setId("959ba739-70b5-43c4-8c90-b2c22014f18c");
siteRestoreArtifactsDelta.add(property6);
additionalData.put("siteRestoreArtifacts@delta", siteRestoreArtifactsDelta);
sharePointRestoreSession.setAdditionalData(additionalData);
SharePointRestoreSession result = graphClient.solutions().backupRestore().sharePointRestoreSessions().bySharePointRestoreSessionId("{sharePointRestoreSession-id}").patch(sharePointRestoreSession);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const sharePointRestoreSession = {
  'siteRestoreArtifacts@delta': [
    {
      restorePoint: { '@odata.id': '1b014d8c-71fe-4d00-a01a-31850bc5b32c' }, //Create a new site restore artifact and add it under the Restore Session.
      destinationType: 'new'
    },
    {
      restorePoint: { '@odata.id': '2b014d8c-71fe-4d00-a01a-31850bc5b32' },
      destinationType: 'new'
    },
    {
      restorePoint: { '@odata.id': '3b014d8c-71fe-4d00-a01a-31850bc5b32c' },
      destinationType: 'new'
    },
    {
      restorePoint: { '@odata.id': '4b014d8c-71fe-4d00-a01a-31850bc5b32c' },
      destinationType: 'new'
    },
    {
      '@removed': {
        reason: 'changed'
      },
      id: '959ba739-70b5-43c4-8c90-b2c22014f18a'
    },
    {
      '@removed': {
        reason: 'changed'
      },
      id: '959ba739-70b5-43c4-8c90-b2c22014f18b'
    },
    {
      '@removed': {
        reason: 'changed'
      },
      id: '959ba739-70b5-43c4-8c90-b2c22014f18c'
    }
  ]
};

await client.api('/solutions/backupRestore/sharepointRestoreSessions/845457dc-4bb2-4815-bef3-8628ebd1952eessions')
	.version('beta')
	.update(sharePointRestoreSession);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\SharePointRestoreSession;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new SharePointRestoreSession();
$additionalData = [
	'siteRestoreArtifacts@delta' => [
			[
				'restorePoint' => [
					'@odata.id' => '1b014d8c-71fe-4d00-a01a-31850bc5b32c',
				],
				'destinationType' => 'new',
			],
			[
				'restorePoint' => [
					'@odata.id' => '2b014d8c-71fe-4d00-a01a-31850bc5b32',
				],
				'destinationType' => 'new',
			],
			[
				'restorePoint' => [
					'@odata.id' => '3b014d8c-71fe-4d00-a01a-31850bc5b32c',
				],
				'destinationType' => 'new',
			],
			[
				'restorePoint' => [
					'@odata.id' => '4b014d8c-71fe-4d00-a01a-31850bc5b32c',
				],
				'destinationType' => 'new',
			],
			[
				'@removed' => [
					'reason' => 'changed',
				],
				'id' => '959ba739-70b5-43c4-8c90-b2c22014f18a',
			],
			[
				'@removed' => [
					'reason' => 'changed',
				],
				'id' => '959ba739-70b5-43c4-8c90-b2c22014f18b',
			],
			[
				'@removed' => [
					'reason' => 'changed',
				],
				'id' => '959ba739-70b5-43c4-8c90-b2c22014f18c',
			],
		],
];
$requestBody->setAdditionalData($additionalData);

$result = $graphServiceClient->solutions()->backupRestore()->sharePointRestoreSessions()->bySharePointRestoreSessionId('sharePointRestoreSession-id')->patch($requestBody)->wait();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.share_point_restore_session import SharePointRestoreSession

graph_client = GraphServiceClient(credentials, scopes)

request_body = SharePointRestoreSession(
	additional_data = {
			"site_restore_artifacts@delta" : [
				{
						"restore_point" : {
								"@odata_id" : "1b014d8c-71fe-4d00-a01a-31850bc5b32c",
						},
						"destination_type" : "new",
				},
				{
						"restore_point" : {
								"@odata_id" : "2b014d8c-71fe-4d00-a01a-31850bc5b32",
						},
						"destination_type" : "new",
				},
				{
						"restore_point" : {
								"@odata_id" : "3b014d8c-71fe-4d00-a01a-31850bc5b32c",
						},
						"destination_type" : "new",
				},
				{
						"restore_point" : {
								"@odata_id" : "4b014d8c-71fe-4d00-a01a-31850bc5b32c",
						},
						"destination_type" : "new",
				},
				{
						"@removed" : {
								"reason" : "changed",
						},
						"id" : "959ba739-70b5-43c4-8c90-b2c22014f18a",
				},
				{
						"@removed" : {
								"reason" : "changed",
						},
						"id" : "959ba739-70b5-43c4-8c90-b2c22014f18b",
				},
				{
						"@removed" : {
								"reason" : "changed",
						},
						"id" : "959ba739-70b5-43c4-8c90-b2c22014f18c",
				},
			],
	}
)

result = await graph_client.solutions.backup_restore.share_point_restore_sessions.by_share_point_restore_session_id('sharePointRestoreSession-id').patch(request_body)

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

HTTP/1.1 200 OK

{
  "siteRestoreArtifacts@delta": [
    {
      "id": "89014d8c-71fe-4d00-a01a-31850bc5b32c",
      "restorePoint": { "@odata.id": "1b014d8c-71fe-4d00-a01a-31850bc5b32c" },
      "destinationType": "new",
      "status": "added",
      "createdDateTime": "2015-06-19T12-01-03.45Z"
    },
    {
      "id": "67014d8c-71fe-4d00-a01a-31850bc5b32c",
      "restorePoint": { "@odata.id": "2b014d8c-71fe-4d00-a01a-31850bc5b32c" },
      "destinationType": "new",
      "status": "added",
      "createdDateTime": "2015-06-19T12-01-03.45Z"
    },
    {
      "id": "56014d8c-71fe-4d00-a01a-31850bc5b32c",
      "restorePoint": { "@odata.id": "3b014d8c-71fe-4d00-a01a-31850bc5b32c" },
      "destinationType": "new",
      "status": "added",
      "createdDateTime": "2015-06-19T12-01-03.45Z"
    },
    {
      "id": "32014d8c-71fe-4d00-a01a-31850bc5b32c",
      "restorePoint": { "@odata.id": "4b014d8c-71fe-4d00-a01a-31850bc5b32c" },
      "destinationType": "new",
      "status": "added",
      "createdDateTime": "2015-06-19T12-01-03.45Z"
    },
    {
      "id": "99954f18-c8ec-4b62-85bf-cdf3b70b140e",
      "restorePoint": { "@odata.id": "7b014d8c-71fe-4d00-a01a-31850bc5b32c" },
      "destinationType": "new",
      "status": "added",
      "createdDateTime": "2015-06-19T12-01-03.45Z"
    },
    {
      //Error scenario
      "@contentId": "3467e382-71a9-4c07-bef7-bda97e09c0d2", // To add context and more traceability.
      "@Core.DataModificationException": {
        "info": {
          "code": "Invalid",
          "message": "The identifier to be removed from the Restore Session does not exist"
        },
        "failedOperation": "remove",
        "responseCode": 409
      },
      "id": "4267e382-71a9-4c07-bef7-bda97e09c0d2"
    }
  ]
}