Update businessScenarioTask

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 businessScenarioTask object.

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)	BusinessScenarioData.ReadWrite.OwnedBy
Delegated (personal Microsoft account)	Not supported.
Application	BusinessScenarioData.ReadWrite.OwnedBy

HTTP request

PATCH /solutions/businessScenarios/{businessScenarioId}/planner/tasks/{businessScenarioTaskId}

Request headers

Name	Description
Authorization	Bearer {token}. Required.
Content-Type	application/json. Required.

Request body

In the request body, supply only the values for properties that should be updated. Existing properties that are not included in the request body will maintain 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
appliedCategories	plannerAppliedCategories	The categories to which the task has been applied. For possible values, see plannerAppliedCategories. Inherited from plannerTask.
assigneePriority	String	Hint used to order items of this type in a list view. For details about the supported format, see Using order hints in Planner. Inherited from plannerTask.
assignments	plannerAssignments	The set of assignees the task is assigned to. Inherited from plannerTask.
bucketId	String	Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It is 28 characters long and case-sensitive. The format validation is done on the service. Inherited from plannerTask.
businessScenarioProperties	businessScenarioProperties	Scenario-specific properties of the task. Optional.
conversationThreadId	String	Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group. Inherited from plannerTask.
dueDateTime	DateTimeOffset	Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Inherited from plannerTask.
orderHint	String	Hint used to order items of this type in a list view. For details about the supported format, see Using order hints in Planner. Inherited from plannerTask.
percentComplete	Int32	Percentage of task completion. When set to 100, the task is considered completed. Inherited from plannerTask.
planId	String	Identifier of the plan to which the task belongs. Inherited from plannerTask.
priority	Int32	Priority of the task. Valid range of values is between 0 and 10 (inclusive), with increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as "urgent", 2, 3, and 4 as "important", 5, 6, and 7 as "medium", and 8, 9, and 10 as "low". Currently, Planner sets the value 1 for "urgent", 3 for "important", 5 for "medium", and 9 for "low". Inherited from plannerTask.
startDateTime	DateTimeOffset	Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Inherited from plannerTask.
target	businessScenarioTaskTargetBase	Target of the task that specifies where the task should be placed. Optional.
title	String	Title of the task. Inherited from plannerTask.

Response

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

Examples

Request

The following is an example of a request.

HTTP

PATCH https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/tasks/pmc1rS1Io0C3rXQhyXIsNmUAOeIi
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.businessScenarioTask",
  "title": "Customer order #12010",
  "percentComplete": 20,
  "priority": 1,
  "businessScenarioProperties": {
    "externalObjectVersion": "000003"
  }
}

C#

var graphClient = new GraphServiceClient(requestAdapter);

var requestBody = new BusinessScenarioTask
{
	OdataType = "#microsoft.graph.businessScenarioTask",
	Title = "Customer order #12010",
	PercentComplete = 20,
	Priority = 1,
	BusinessScenarioProperties = new BusinessScenarioProperties
	{
		ExternalObjectVersion = "000003",
	},
};
var result = await graphClient.Solutions.BusinessScenarios["{businessScenario-id}"].Planner.Tasks["{businessScenarioTask-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.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const businessScenarioTask = {
  '@odata.type': '#microsoft.graph.businessScenarioTask',
  title: 'Customer order #12010',
  percentComplete: 20,
  priority: 1,
  businessScenarioProperties: {
    externalObjectVersion: '000003'
  }
};

await client.api('/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/tasks/pmc1rS1Io0C3rXQhyXIsNmUAOeIi')
	.version('beta')
	.update(businessScenarioTask);

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

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

BusinessScenarioTask businessScenarioTask = new BusinessScenarioTask();
businessScenarioTask.title = "Customer order #12010";
businessScenarioTask.percentComplete = 20;
businessScenarioTask.priority = 1;
BusinessScenarioProperties businessScenarioProperties = new BusinessScenarioProperties();
businessScenarioProperties.externalObjectVersion = "000003";
businessScenarioTask.businessScenarioProperties = businessScenarioProperties;

graphClient.solutions().businessScenarios("c5d514e6c6864911ac46c720affb6e4d").planner().tasks("pmc1rS1Io0C3rXQhyXIsNmUAOeIi")
	.buildRequest()
	.patch(businessScenarioTask);

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.

Go

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewBusinessScenarioTask()
title := "Customer order #12010"
requestBody.SetTitle(&title) 
percentComplete := int32(20)
requestBody.SetPercentComplete(&percentComplete) 
priority := int32(1)
requestBody.SetPriority(&priority) 
businessScenarioProperties := graphmodels.NewBusinessScenarioProperties()
externalObjectVersion := "000003"
businessScenarioProperties.SetExternalObjectVersion(&externalObjectVersion) 
requestBody.SetBusinessScenarioProperties(businessScenarioProperties)

result, err := graphClient.Solutions().BusinessScenariosById("businessScenario-id").Planner().TasksById("businessScenarioTask-id").Patch(context.Background(), requestBody, nil)

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.

PowerShell

Import-Module Microsoft.Graph.Bookings

$params = @{
	"@odata.type" = "#microsoft.graph.businessScenarioTask"
	Title = "Customer order #12010"
	PercentComplete = 20
	Priority = 1
	BusinessScenarioProperties = @{
		ExternalObjectVersion = "000003"
	}
}

Update-MgBusinessScenarioPlannerTask -BusinessScenarioId $businessScenarioId -BusinessScenarioTaskId $businessScenarioTaskId -BodyParameter $params

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

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestBody = new BusinessScenarioTask();
$requestBody->set@odatatype('#microsoft.graph.businessScenarioTask');

$requestBody->setTitle('Customer order #12010');

$requestBody->setPercentComplete(20);

$requestBody->setPriority(1);

$businessScenarioProperties = new BusinessScenarioProperties();
$businessScenarioProperties->setExternalObjectVersion('000003');


$requestBody->setBusinessScenarioProperties($businessScenarioProperties);


$requestResult = $graphServiceClient->solutions()->businessScenariosById('businessScenario-id')->planner()->tasksById('businessScenarioTask-id')->patch($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.

Response

The following is an example of the response.

Note: The response object shown here might be shortened for readability.

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

{
  "@odata.type": "#microsoft.graph.businessScenarioTask",
  "title": "Customer order #12010",
  "percentComplete": 20,
  "priority": 1,
  "id": "pmc1rS1Io0C3rXQhyXIsNmUAOeIi",
  "target": {
    "@odata.type": "microsoft.graph.businessScenarioGroupTarget",
    "taskTargetKind": "group",
    "groupId": "7a339254-4b2b-4410-b295-c890a16776ee"
  },
  "businessScenarioProperties": {
    "externalObjectId": "Order#12010",
    "externalContextId": "Warehouse-CA-36",
    "externalObjectVersion": "000003",
    "webUrl": "https://ordertracking.contoso.com/view?id=12010",
    "externalBucketId": "deliveryBucket"
  }
}

See also

• Update the task details associated with a scenario task.