Espace de noms: microsoft.graph
Importante
Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .
Mettez à jour les propriétés de l’objet plannertask.
Cette API est disponible dans les déploiements de cloud national suivants.
| Service global |
Gouvernement des États-Unis L4 |
Us Government L5 (DOD) |
Chine gérée par 21Vianet |
| ✅ |
✅ |
✅ |
❌ |
Autorisations
Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.
| Type d’autorisation |
Autorisations avec privilèges minimum |
Autorisations privilégiées plus élevées |
| Déléguée (compte professionnel ou scolaire) |
Tasks.ReadWrite |
Group.ReadWrite.All |
| Déléguée (compte Microsoft personnel) |
Non prise en charge. |
Non prise en charge. |
| Application |
Tasks.ReadWrite.All |
Non disponible. |
Requête HTTP
PATCH /planner/tasks/{id}
| Nom |
Description |
| Autorisation |
Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation. |
| If-Match |
Dernière valeur ETag connue pour le plannerTask à mettre à jour. Obligatoire. |
Corps de la demande
Dans le corps de la demande, fournissez uniquement les valeurs des propriétés à mettre à jour. Les propriétés existantes qui ne sont pas incluses dans le corps de la demande conservent leurs valeurs précédentes ou sont recalculées en fonction des modifications apportées à d’autres valeurs de propriété.
Le tableau suivant spécifie les propriétés qui peuvent être mises à jour.
| Propriété |
Type |
Description |
| appliedCategories |
plannerAppliedCategories |
Spécifie les catégories auxquelles la tâche Planificateur a été appliquée. Consultez Catégories appliquées pour connaître les valeurs possibles. |
| assigneePriority |
String |
Indicateur utilisé pour trier les éléments de ce type dans un affichage de liste. Le format est défini dans Utilisation des indicateurs d’ordre dans Planificateur. |
| Affectations |
plannerAssignments |
Ensemble d’utilisateurs auxquels la tâche est affectée. |
| bucketId |
Chaîne |
ID du compartiment auquel appartient la tâche. Le compartiment doit se trouver dans le plan où se trouve la tâche. Cette valeur de 28 caractères est longue et sensible à la casse.
Une validation du format est effectuée sur le service. |
| conversationThreadId |
String |
ID de thread de la conversation sur la tâche et est l’ID de l’objet de thread de conversation créé dans le groupe. |
| dueDateTime |
DateTimeOffset |
Date et heure auxquelles la tâche doit être effectuée. Le type d’horodatage représente les informations de date et d’heure au moyen du format ISO 8601. Il est toujours au format d’heure UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : 2014-01-01T00:00:00Z. |
| isOnMyDay |
Booléen |
Indique s’il faut afficher cette tâche dans la vue MyDay. Si truela valeur est , elle affiche la tâche. |
| orderHint |
String |
Indicateur utilisé pour trier les éléments de ce type dans un affichage de liste. Le format est défini comme indiqué ici. |
| percentComplete |
Int32 |
Pourcentage d’achèvement de la tâche. Lorsque la 100valeur est définie sur , la tâche est considérée comme terminée. |
| planId |
Chaîne |
ID du plan auquel appartient la tâche. |
| priorité |
Int32 |
Priorité de la tâche. La plage de valeurs valide est comprise entre 0 et 10 (inclusive), la valeur croissante étant de priorité inférieure (0 a la priorité la plus élevée et 10 la priorité la plus basse). Actuellement, Planificateur interprète les valeurs 0 et 1 comme « urgent », 2 et 3 comme 4 « important », 5, 6et 7 comme « moyen », et 8, 9et 10 comme « faible ». Actuellement, Planificateur définit la valeur 1 pour « urgent », 3 pour « important », 5 pour « moyen » et 9 pour « faible ». |
| recurrence |
plannerTaskRecurrence |
Périodicité de la tâche, si elle est définie. Facultatif. |
| startDateTime |
DateTimeOffset |
Date et heure de début de la tâche. Le type d’horodatage représente les informations de date et d’heure au moyen du format ISO 8601. Il est toujours au format d’heure UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : 2014-01-01T00:00:00Z. |
| title |
Chaîne |
Titre de la tâche. |
Remarque
Pour les tâches project répliquées dans Planificateur, seule la propriété percentComplete peut être mise à jour.
Réponse
Si elle réussit, cette méthode renvoie un 204 No Content code de réponse et un contenu vide. Si la requête spécifie l’en-tête Prefer avec une return=representation préférence, cette méthode renvoie un 200 OK code de réponse et un objet plannerTask mis à jour dans le corps de la réponse.
Cette méthode peut retourner n’importe quel code de status HTTP. Les erreurs les plus courantes que les applications doivent gérer pour cette méthode sont les réponses 400, 403, 404, 409 et 412. Pour plus d’informations sur ces erreurs, consultez Conditions d’erreur courantes Planificateur.
Exemple
Demande
L’exemple suivant illustre une demande.
PATCH https://graph.microsoft.com/beta/planner/tasks/01gzSlKkIUSUl6DF_EilrmQAKDhh
Content-type: application/json
Prefer: return=representation
If-Match: W/"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc="
{
"assignments": {
"fbab97d0-4932-4511-b675-204639209557": {
"@odata.type": "#microsoft.graph.plannerAssignment",
"orderHint": "N9917 U2883!"
}
},
"appliedCategories": {
"category3": true,
"category4": false
},
"recurrence": {
"schedule": {
"pattern": {
"type": "daily",
"interval": 3
},
"patternStartDateTime": "2022-02-22T02:10:33Z"
}
}
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new PlannerTask
{
Assignments = new PlannerAssignments
{
AdditionalData = new Dictionary<string, object>
{
{
"fbab97d0-4932-4511-b675-204639209557" , new PlannerAssignment
{
OdataType = "#microsoft.graph.plannerAssignment",
OrderHint = "N9917 U2883!",
}
},
},
},
AppliedCategories = new PlannerAppliedCategories
{
AdditionalData = new Dictionary<string, object>
{
{
"category3" , true
},
{
"category4" , false
},
},
},
Recurrence = new PlannerTaskRecurrence
{
Schedule = new PlannerRecurrenceSchedule
{
Pattern = new RecurrencePattern
{
Type = RecurrencePatternType.Daily,
Interval = 3,
},
PatternStartDateTime = DateTimeOffset.Parse("2022-02-22T02:10:33Z"),
},
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Planner.Tasks["{plannerTask-id}"].PatchAsync(requestBody, (requestConfiguration) =>
{
requestConfiguration.Headers.Add("Prefer", "return=representation");
requestConfiguration.Headers.Add("If-Match", "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc=\"");
});
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
abstractions "github.com/microsoft/kiota-abstractions-go"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
graphplanner "github.com/microsoftgraph/msgraph-beta-sdk-go/planner"
//other-imports
)
headers := abstractions.NewRequestHeaders()
headers.Add("Prefer", "return=representation")
headers.Add("If-Match", "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc=\"")
configuration := &graphplanner.TasksItemRequestBuilderPatchRequestConfiguration{
Headers: headers,
}
requestBody := graphmodels.NewPlannerTask()
assignments := graphmodels.NewPlannerAssignments()
additionalData := map[string]interface{}{
"fbab97d0-4932-4511-b675-204639209557" := graphmodels.NewPlannerAssignment()
orderHint := "N9917 U2883!"
"fbab97d0-4932-4511-b675-204639209557".SetOrderHint(&orderHint)
assignments.Set"fbab97d0-4932-4511-b675-204639209557"("fbab97d0-4932-4511-b675-204639209557")
}
assignments.SetAdditionalData(additionalData)
requestBody.SetAssignments(assignments)
appliedCategories := graphmodels.NewPlannerAppliedCategories()
additionalData := map[string]interface{}{
category3 := true
appliedCategories.SetCategory3(&category3)
category4 := false
appliedCategories.SetCategory4(&category4)
}
appliedCategories.SetAdditionalData(additionalData)
requestBody.SetAppliedCategories(appliedCategories)
recurrence := graphmodels.NewPlannerTaskRecurrence()
schedule := graphmodels.NewPlannerRecurrenceSchedule()
pattern := graphmodels.NewRecurrencePattern()
type := graphmodels.DAILY_RECURRENCEPATTERNTYPE
pattern.SetType(&type)
interval := int32(3)
pattern.SetInterval(&interval)
schedule.SetPattern(pattern)
patternStartDateTime , err := time.Parse(time.RFC3339, "2022-02-22T02:10:33Z")
schedule.SetPatternStartDateTime(&patternStartDateTime)
recurrence.SetSchedule(schedule)
requestBody.SetRecurrence(recurrence)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
tasks, err := graphClient.Planner().Tasks().ByPlannerTaskId("plannerTask-id").Patch(context.Background(), requestBody, configuration)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
PlannerTask plannerTask = new PlannerTask();
PlannerAssignments assignments = new PlannerAssignments();
HashMap<String, Object> additionalData = new HashMap<String, Object>();
PlannerAssignment fbab97d049324511B675204639209557 = new PlannerAssignment();
fbab97d049324511B675204639209557.setOdataType("#microsoft.graph.plannerAssignment");
fbab97d049324511B675204639209557.setOrderHint("N9917 U2883!");
additionalData.put("fbab97d0-4932-4511-b675-204639209557", fbab97d049324511B675204639209557);
assignments.setAdditionalData(additionalData);
plannerTask.setAssignments(assignments);
PlannerAppliedCategories appliedCategories = new PlannerAppliedCategories();
HashMap<String, Object> additionalData1 = new HashMap<String, Object>();
additionalData1.put("category3", true);
additionalData1.put("category4", false);
appliedCategories.setAdditionalData(additionalData1);
plannerTask.setAppliedCategories(appliedCategories);
PlannerTaskRecurrence recurrence = new PlannerTaskRecurrence();
PlannerRecurrenceSchedule schedule = new PlannerRecurrenceSchedule();
RecurrencePattern pattern = new RecurrencePattern();
pattern.setType(RecurrencePatternType.Daily);
pattern.setInterval(3);
schedule.setPattern(pattern);
OffsetDateTime patternStartDateTime = OffsetDateTime.parse("2022-02-22T02:10:33Z");
schedule.setPatternStartDateTime(patternStartDateTime);
recurrence.setSchedule(schedule);
plannerTask.setRecurrence(recurrence);
PlannerTask result = graphClient.planner().tasks().byPlannerTaskId("{plannerTask-id}").patch(plannerTask, requestConfiguration -> {
requestConfiguration.headers.add("Prefer", "return=representation");
requestConfiguration.headers.add("If-Match", "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc=\"");
});
const options = {
authProvider,
};
const client = Client.init(options);
const plannerTask = {
assignments: {
'fbab97d0-4932-4511-b675-204639209557': {
'@odata.type': '#microsoft.graph.plannerAssignment',
orderHint: 'N9917 U2883!'
}
},
appliedCategories: {
category3: true,
category4: false
},
recurrence: {
schedule: {
pattern: {
type: 'daily',
interval: 3
},
patternStartDateTime: '2022-02-22T02:10:33Z'
}
}
};
await client.api('/planner/tasks/01gzSlKkIUSUl6DF_EilrmQAKDhh')
.version('beta')
.update(plannerTask);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Planner\Tasks\Item\PlannerTaskItemRequestBuilderPatchRequestConfiguration;
use Microsoft\Graph\Beta\Generated\Models\PlannerTask;
use Microsoft\Graph\Beta\Generated\Models\PlannerAssignments;
use Microsoft\Graph\Beta\Generated\Models\PlannerAssignment;
use Microsoft\Graph\Beta\Generated\Models\PlannerAppliedCategories;
use Microsoft\Graph\Beta\Generated\Models\PlannerTaskRecurrence;
use Microsoft\Graph\Beta\Generated\Models\PlannerRecurrenceSchedule;
use Microsoft\Graph\Beta\Generated\Models\RecurrencePattern;
use Microsoft\Graph\Beta\Generated\Models\RecurrencePatternType;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new PlannerTask();
$assignments = new PlannerAssignments();
$additionalData = [
'fbab97d0-4932-4511-b675-204639209557' => [
'@odata.type' => '#microsoft.graph.plannerAssignment',
'orderHint' => 'N9917 U2883!',
],
];
$assignments->setAdditionalData($additionalData);
$requestBody->setAssignments($assignments);
$appliedCategories = new PlannerAppliedCategories();
$additionalData = [
'category3' => true,
'category4' => false,
];
$appliedCategories->setAdditionalData($additionalData);
$requestBody->setAppliedCategories($appliedCategories);
$recurrence = new PlannerTaskRecurrence();
$recurrenceSchedule = new PlannerRecurrenceSchedule();
$recurrenceSchedulePattern = new RecurrencePattern();
$recurrenceSchedulePattern->setType(new RecurrencePatternType('daily'));
$recurrenceSchedulePattern->setInterval(3);
$recurrenceSchedule->setPattern($recurrenceSchedulePattern);
$recurrenceSchedule->setPatternStartDateTime(new \DateTime('2022-02-22T02:10:33Z'));
$recurrence->setSchedule($recurrenceSchedule);
$requestBody->setRecurrence($recurrence);
$requestConfiguration = new PlannerTaskItemRequestBuilderPatchRequestConfiguration();
$headers = [
'Prefer' => 'return=representation',
'If-Match' => 'W/"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc="',
];
$requestConfiguration->headers = $headers;
$result = $graphServiceClient->planner()->tasks()->byPlannerTaskId('plannerTask-id')->patch($requestBody, $requestConfiguration)->wait();
Import-Module Microsoft.Graph.Beta.Planner
$params = @{
assignments = @{
"fbab97d0-4932-4511-b675-204639209557" = @{
"@odata.type" = "#microsoft.graph.plannerAssignment"
orderHint = "N9917 U2883!"
}
}
appliedCategories = @{
category3 = $true
category4 = $false
}
recurrence = @{
schedule = @{
pattern = @{
type = "daily"
interval = 3
}
patternStartDateTime = [System.DateTime]::Parse("2022-02-22T02:10:33Z")
}
}
}
Update-MgBetaPlannerTask -PlannerTaskId $plannerTaskId -BodyParameter $params -IfMatch W/'"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc="'
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.planner.tasks.item.planner_task_item_request_builder import PlannerTaskItemRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
from msgraph_beta.generated.models.planner_task import PlannerTask
from msgraph_beta.generated.models.planner_assignments import PlannerAssignments
from msgraph_beta.generated.models.planner_assignment import PlannerAssignment
from msgraph_beta.generated.models.planner_applied_categories import PlannerAppliedCategories
from msgraph_beta.generated.models.planner_task_recurrence import PlannerTaskRecurrence
from msgraph_beta.generated.models.planner_recurrence_schedule import PlannerRecurrenceSchedule
from msgraph_beta.generated.models.recurrence_pattern import RecurrencePattern
from msgraph_beta.generated.models.recurrence_pattern_type import RecurrencePatternType
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = PlannerTask(
assignments = PlannerAssignments(
additional_data = {
"fbab97d0-4932-4511-b675-204639209557" : {
"@odata_type" : "#microsoft.graph.plannerAssignment",
"order_hint" : "N9917 U2883!",
},
}
),
applied_categories = PlannerAppliedCategories(
additional_data = {
"category3" : True,
"category4" : False,
}
),
recurrence = PlannerTaskRecurrence(
schedule = PlannerRecurrenceSchedule(
pattern = RecurrencePattern(
type = RecurrencePatternType.Daily,
interval = 3,
),
pattern_start_date_time = "2022-02-22T02:10:33Z",
),
),
)
request_configuration = RequestConfiguration()
request_configuration.headers.add("Prefer", "return=representation")
request_configuration.headers.add("If-Match", "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc=\"")
result = await graph_client.planner.tasks.by_planner_task_id('plannerTask-id').patch(request_body, request_configuration = request_configuration)
Réponse
L’exemple suivant illustre la réponse.
Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.
HTTP/1.1 200 OK
Content-type: application/json
{
"createdBy": {
"user": {
"id": "6463a5ce-2119-4198-9f2a-628761df4a62"
}
},
"planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
"bucketId": "gcrYAaAkgU2EQUvpkNNXLGQAGTtu",
"title": "title-value",
"orderHint": "9223370609546166567W",
"assigneePriority": "90057581\"",
"createdDateTime": "2015-03-24T18:36:49.2407981Z",
"assignments": {
"6463a5ce-2119-4198-9f2a-628761df4a62": {
"@odata.type": "#microsoft.graph.plannerAssignment",
"assignedBy": {
"user": {
"id": "6463a5ce-2119-4198-9f2a-628761df4a62"
}
},
"assignedDateTime": "2015-03-25T18:38:21.956Z",
"orderHint": "N9917"
},
"fbab97d0-4932-4511-b675-204639209557": {
"@odata.type": "#microsoft.graph.plannerAssignment",
"assignedBy": {
"user": {
"id": "1e9955d2-6acd-45bf-86d3-b546fdc795eb"
}
},
"assignedDateTime": "2017-04-24T22:40:44.5665917",
"orderHint": "RWk1"
},
"aaa27244-1db4-476a-a5cb-004607466324": {
"@odata.type": "#microsoft.graph.plannerAssignment",
"assignedBy": {
"user": {
"id": "6463a5ce-2119-4198-9f2a-628761df4a62"
}
},
"assignedDateTime": "2015-03-25T18:38:21.956Z",
"orderHint": "U2883"
}
},
"appliedCategories": {
"category3": true,
"category5": true,
"category6": true
},
"id": "01gzSlKkIUSUl6DF_EilrmQAKDhh",
"recurrence": {
"@odata.type": "#microsoft.graph.plannerTaskRecurrence",
"seriesId": "qOqWwPLt4U-LIsWV5ByUuA",
"occurrenceId": 1,
"previousInSeriesTaskId": null,
"nextInSeriesTaskId": null,
"schedule": {
"@odata.type": "#microsoft.graph.plannerRecurrenceSchedule",
"pattern": {
"odata.type": "#microsoft.graph.recurrencePattern",
"type": "daily",
"interval": 3,
"firstDayOfWeek": "sunday",
"dayOfMonth": 0,
"daysOfWeek": [],
"index": "first",
"month": 0
},
"patternStartDateTime": "2022-02-22T02:10:33Z",
"nextOccurrenceDateTime": "2022-02-25T02:10:33Z"
},
"recurrenceStartDateTime": "2022-02-22T02:10:33Z"
}
}