Atualizar plannertaskdetails
Artigo
02/14/2024
14 colaboradores
Comentários
Neste artigo
Namespace: microsoft.graph
Atualize as propriedades do objeto plannerTaskDetails .
Essa API está disponível nas seguintes implantações nacionais de nuvem .
Serviço global
Governo dos EUA L4
GOVERNO DOS EUA L5 (DOD)
China operada pela 21Vianet
✅
✅
✅
❌
Permissões
Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão . Para saber mais sobre essas permissões, consulte a referência de permissões .
Tipo de permissão
Permissões menos privilegiadas
Permissões privilegiadas mais altas
Delegado (conta corporativa ou de estudante)
Tasks.ReadWrite
Group.ReadWrite.All
Delegado (conta pessoal da Microsoft)
Sem suporte.
Sem suporte.
Application
Tasks.ReadWrite.All
Indisponível.
Solicitação HTTP
PATCH /planner/tasks/{id}/details
Nome
Descrição
Autorização
{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização .
If-Match
Último valor ETag conhecido para o plannerTaskDetails a ser atualizado. Obrigatório.
Corpo da solicitação
No corpo da solicitação, forneça apenas os valores das propriedades que devem ser atualizadas. As propriedades existentes que não estão incluídas no corpo da solicitação mantêm seus valores anteriores ou são recalculadas com base em alterações em outros valores de propriedade.
A tabela a seguir especifica as propriedades que podem ser atualizadas.
Propriedade
Tipo
Descrição
Lista
plannerChecklistItems
A coleção de itens de lista de verificação na tarefa.
description
Cadeia de caracteres
A descrição da tarefa.
previewType
string
Isso define o tipo de visualização que aparece na tarefa. Os valores possíveis são: automatic
, noPreview
, checklist
, description
, reference
. Quando definido como a automatic
visualização exibida é escolhido pelo aplicativo que exibe a tarefa.
Referências
plannerExternalReferences
A coleção de referências na tarefa.
Resposta
Se for bem-sucedido, esse método retornará um 204 No Content
código de resposta e um conteúdo vazio. Se a solicitação especificar o Prefer
cabeçalho com return=representation
preferência, esse método retornará um código de 200 OK
resposta e um objeto plannerTaskDetails atualizado no corpo da resposta.
Este método pode retornar qualquer um dos códigos de status de HTTP . Os erros mais comuns que os aplicativos devem manipular para esse método são as respostas 400, 403, 404, 409 e 412. Saiba mais sobre esses erros em Condições de erro comuns do Planner .
Exemplo
Solicitação
O exemplo a seguir mostra uma solicitação.
PATCH https://graph.microsoft.com/v1.0/planner/tasks/{task-id}/details
Content-type: application/json
Prefer: return=representation
If-Match: W/"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc="
{
"previewType": "noPreview",
"references": {
"http%3A//developer%2Emicrosoft%2Ecom":{
"@odata.type": "microsoft.graph.plannerExternalReference",
"alias": "Documentation",
"previewPriority": " !",
"type": "Other"
},
"https%3A//developer%2Emicrosoft%2Ecom/en-us/graph/graph-explorer":{
"@odata.type": "microsoft.graph.plannerExternalReference",
"previewPriority": " !!",
},
"http%3A//www%2Ebing%2Ecom": null
},
"checklist": {
"95e27074-6c4a-447a-aa24-9d718a0b86fa":{
"@odata.type": "microsoft.graph.plannerChecklistItem",
"title": "Update task details",
"isChecked": true
},
"d280ed1a-9f6b-4f9c-a962-fb4d00dc50ff":{
"@odata.type": "microsoft.graph.plannerChecklistItem",
"isChecked": true,
},
"a93c93c5-10a6-4167-9551-8bafa09967a7": null
}
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new PlannerTaskDetails
{
PreviewType = PlannerPreviewType.NoPreview,
References = new PlannerExternalReferences
{
AdditionalData = new Dictionary<string, object>
{
{
"http%3A//developer%2Emicrosoft%2Ecom" , new PlannerExternalReference
{
OdataType = "microsoft.graph.plannerExternalReference",
Alias = "Documentation",
PreviewPriority = " !",
Type = "Other",
}
},
{
"https%3A//developer%2Emicrosoft%2Ecom/en-us/graph/graph-explorer" , new PlannerExternalReference
{
OdataType = "microsoft.graph.plannerExternalReference",
PreviewPriority = " !!",
}
},
{
"http%3A//www%2Ebing%2Ecom" , null
},
},
},
Checklist = new PlannerChecklistItems
{
AdditionalData = new Dictionary<string, object>
{
{
"95e27074-6c4a-447a-aa24-9d718a0b86fa" , new PlannerChecklistItem
{
OdataType = "microsoft.graph.plannerChecklistItem",
Title = "Update task details",
IsChecked = true,
}
},
{
"d280ed1a-9f6b-4f9c-a962-fb4d00dc50ff" , new PlannerChecklistItem
{
OdataType = "microsoft.graph.plannerChecklistItem",
IsChecked = true,
}
},
{
"a93c93c5-10a6-4167-9551-8bafa09967a7" , null
},
},
},
};
// 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}"].Details.PatchAsync(requestBody, (requestConfiguration) =>
{
requestConfiguration.Headers.Add("Prefer", "return=representation");
requestConfiguration.Headers.Add("If-Match", "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc=\"");
});
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK .
// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc planner tasks details patch --planner-task-id {plannerTask-id} --if-match "W/"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc="" --body '{\
"previewType": "noPreview",\
"references": {\
"http%3A//developer%2Emicrosoft%2Ecom":{\
"@odata.type": "microsoft.graph.plannerExternalReference",\
"alias": "Documentation",\
"previewPriority": " !",\
"type": "Other"\
},\
"https%3A//developer%2Emicrosoft%2Ecom/en-us/graph/graph-explorer":{\
"@odata.type": "microsoft.graph.plannerExternalReference",\
"previewPriority": " !!",\
},\
"http%3A//www%2Ebing%2Ecom": null\
},\
"checklist": {\
"95e27074-6c4a-447a-aa24-9d718a0b86fa":{\
"@odata.type": "microsoft.graph.plannerChecklistItem",\
"title": "Update task details",\
"isChecked": true\
},\
"d280ed1a-9f6b-4f9c-a962-fb4d00dc50ff":{\
"@odata.type": "microsoft.graph.plannerChecklistItem",\
"isChecked": true,\
},\
"a93c93c5-10a6-4167-9551-8bafa09967a7": null\
}\
}\
'
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK .
import (
"context"
abstractions "github.com/microsoft/kiota-abstractions-go"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
graphplanner "github.com/microsoftgraph/msgraph-sdk-go/planner"
//other-imports
)
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)
headers := abstractions.NewRequestHeaders()
headers.Add("Prefer", "return=representation")
headers.Add("If-Match", "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc=\"")
configuration := &graphplanner.PlannerTaskItemDetailsRequestBuilderPatchRequestConfiguration{
Headers: headers,
}
requestBody := graphmodels.NewPlannerTaskDetails()
previewType := graphmodels.NOPREVIEW_PLANNERPREVIEWTYPE
requestBody.SetPreviewType(&previewType)
references := graphmodels.NewPlannerExternalReferences()
additionalData := map[string]interface{}{
http%3A//developer%2Emicrosoft%2Ecom := graphmodels.NewPlannerExternalReference()
alias := "Documentation"
http%3A//developer%2Emicrosoft%2Ecom.SetAlias(&alias)
previewPriority := " !"
http%3A//developer%2Emicrosoft%2Ecom.SetPreviewPriority(&previewPriority)
type := "Other"
http%3A//developer%2Emicrosoft%2Ecom.SetType(&type)
references.SetHttp%3A//developer%2Emicrosoft%2Ecom(http%3A//developer%2Emicrosoft%2Ecom)
"https%3A//developer%2Emicrosoft%2Ecom/en-us/graph/graph-explorer" := graphmodels.NewPlannerExternalReference()
previewPriority := " !!"
"https%3A//developer%2Emicrosoft%2Ecom/en-us/graph/graph-explorer".SetPreviewPriority(&previewPriority)
references.Set"https%3A//developer%2Emicrosoft%2Ecom/en-us/graph/graph-explorer"("https%3A//developer%2Emicrosoft%2Ecom/en-us/graph/graph-explorer")
http%3A//www%2Ebing%2Ecom := null
references.SetHttp%3A//www%2Ebing%2Ecom(&http%3A//www%2Ebing%2Ecom)
}
references.SetAdditionalData(additionalData)
requestBody.SetReferences(references)
checklist := graphmodels.NewPlannerChecklistItems()
additionalData := map[string]interface{}{
"95e27074-6c4a-447a-aa24-9d718a0b86fa" := graphmodels.NewPlannerChecklistItem()
title := "Update task details"
"95e27074-6c4a-447a-aa24-9d718a0b86fa".SetTitle(&title)
isChecked := true
"95e27074-6c4a-447a-aa24-9d718a0b86fa".SetIsChecked(&isChecked)
checklist.Set"95e27074-6c4a-447a-aa24-9d718a0b86fa"("95e27074-6c4a-447a-aa24-9d718a0b86fa")
"d280ed1a-9f6b-4f9c-a962-fb4d00dc50ff" := graphmodels.NewPlannerChecklistItem()
isChecked := true
"d280ed1a-9f6b-4f9c-a962-fb4d00dc50ff".SetIsChecked(&isChecked)
checklist.Set"d280ed1a-9f6b-4f9c-a962-fb4d00dc50ff"("d280ed1a-9f6b-4f9c-a962-fb4d00dc50ff")
"a93c93c5-10a6-4167-9551-8bafa09967a7" := null
checklist.Set"a93c93c5-10a6-4167-9551-8bafa09967a7"(&"a93c93c5-10a6-4167-9551-8bafa09967a7")
}
checklist.SetAdditionalData(additionalData)
requestBody.SetChecklist(checklist)
details, err := graphClient.Planner().Tasks().ByPlannerTaskId("plannerTask-id").Details().Patch(context.Background(), requestBody, configuration)
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK .
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
PlannerTaskDetails plannerTaskDetails = new PlannerTaskDetails();
plannerTaskDetails.setPreviewType(PlannerPreviewType.NoPreview);
PlannerExternalReferences references = new PlannerExternalReferences();
HashMap<String, Object> additionalData = new HashMap<String, Object>();
PlannerExternalReference http3ADeveloper2Emicrosoft2Ecom = new PlannerExternalReference();
http3ADeveloper2Emicrosoft2Ecom.setOdataType("microsoft.graph.plannerExternalReference");
http3ADeveloper2Emicrosoft2Ecom.setAlias("Documentation");
http3ADeveloper2Emicrosoft2Ecom.setPreviewPriority(" !");
http3ADeveloper2Emicrosoft2Ecom.setType("Other");
additionalData.put("http%3A//developer%2Emicrosoft%2Ecom", http3ADeveloper2Emicrosoft2Ecom);
PlannerExternalReference https3ADeveloper2Emicrosoft2EcomEnUsGraphGraphExplorer = new PlannerExternalReference();
https3ADeveloper2Emicrosoft2EcomEnUsGraphGraphExplorer.setOdataType("microsoft.graph.plannerExternalReference");
https3ADeveloper2Emicrosoft2EcomEnUsGraphGraphExplorer.setPreviewPriority(" !!");
additionalData.put("https%3A//developer%2Emicrosoft%2Ecom/en-us/graph/graph-explorer", https3ADeveloper2Emicrosoft2EcomEnUsGraphGraphExplorer);
additionalData.put("http%3A//www%2Ebing%2Ecom", null);
references.setAdditionalData(additionalData);
plannerTaskDetails.setReferences(references);
PlannerChecklistItems checklist = new PlannerChecklistItems();
HashMap<String, Object> additionalData1 = new HashMap<String, Object>();
PlannerChecklistItem 95e270746c4a447aAa249d718a0b86fa = new PlannerChecklistItem();
95e270746c4a447aAa249d718a0b86fa.setOdataType("microsoft.graph.plannerChecklistItem");
95e270746c4a447aAa249d718a0b86fa.setTitle("Update task details");
95e270746c4a447aAa249d718a0b86fa.setIsChecked(true);
additionalData1.put("95e27074-6c4a-447a-aa24-9d718a0b86fa", 95e270746c4a447aAa249d718a0b86fa);
PlannerChecklistItem d280ed1a9f6b4f9cA962Fb4d00dc50ff = new PlannerChecklistItem();
d280ed1a9f6b4f9cA962Fb4d00dc50ff.setOdataType("microsoft.graph.plannerChecklistItem");
d280ed1a9f6b4f9cA962Fb4d00dc50ff.setIsChecked(true);
additionalData1.put("d280ed1a-9f6b-4f9c-a962-fb4d00dc50ff", d280ed1a9f6b4f9cA962Fb4d00dc50ff);
additionalData1.put("a93c93c5-10a6-4167-9551-8bafa09967a7", null);
checklist.setAdditionalData(additionalData1);
plannerTaskDetails.setChecklist(checklist);
PlannerTaskDetails result = graphClient.planner().tasks().byPlannerTaskId("{plannerTask-id}").details().patch(plannerTaskDetails, requestConfiguration -> {
requestConfiguration.headers.add("Prefer", "return=representation");
requestConfiguration.headers.add("If-Match", "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc=\"");
});
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK .
const options = {
authProvider,
};
const client = Client.init(options);
const plannerTaskDetails = {
previewType: 'noPreview',
references: {
'http%3A//developer%2Emicrosoft%2Ecom':{
'@odata.type': 'microsoft.graph.plannerExternalReference',
alias: 'Documentation',
previewPriority: ' !',
type: 'Other'
},
'https%3A//developer%2Emicrosoft%2Ecom/en-us/graph/graph-explorer':{
'@odata.type': 'microsoft.graph.plannerExternalReference',
previewPriority: ' !!',
},
'http%3A//www%2Ebing%2Ecom': null
},
checklist: {
'95e27074-6c4a-447a-aa24-9d718a0b86fa':{
'@odata.type': 'microsoft.graph.plannerChecklistItem',
title: 'Update task details',
isChecked: true
},
'd280ed1a-9f6b-4f9c-a962-fb4d00dc50ff':{
'@odata.type': 'microsoft.graph.plannerChecklistItem',
isChecked: true,
},
'a93c93c5-10a6-4167-9551-8bafa09967a7': null
}
};
await client.api('/planner/tasks/{task-id}/details')
.update(plannerTaskDetails);
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK .
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Planner\Tasks\Item\Details\DetailsRequestBuilderPatchRequestConfiguration;
use Microsoft\Graph\Generated\Models\PlannerTaskDetails;
use Microsoft\Graph\Generated\Models\PlannerExternalReferences;
use Microsoft\Graph\Generated\Models\PlannerExternalReference;
use Microsoft\Graph\Generated\Models\PlannerChecklistItems;
use Microsoft\Graph\Generated\Models\PlannerChecklistItem;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new PlannerTaskDetails();
$requestBody->setPreviewType(new PlannerPreviewType('noPreview'));
$references = new PlannerExternalReferences();
$additionalData = [
'http%3A//developer%2Emicrosoft%2Ecom' => [
'@odata.type' => 'microsoft.graph.plannerExternalReference',
'alias' => 'Documentation',
'previewPriority' => ' !',
'type' => 'Other',
],
'https%3A//developer%2Emicrosoft%2Ecom/en-us/graph/graph-explorer' => [
'@odata.type' => 'microsoft.graph.plannerExternalReference',
'previewPriority' => ' !!',
],
'http%3A//www%2Ebing%2Ecom' => null,
];
$references->setAdditionalData($additionalData);
$requestBody->setReferences($references);
$checklist = new PlannerChecklistItems();
$additionalData = [
'95e27074-6c4a-447a-aa24-9d718a0b86fa' => [
'@odata.type' => 'microsoft.graph.plannerChecklistItem',
'title' => 'Update task details',
'isChecked' => true,
],
'd280ed1a-9f6b-4f9c-a962-fb4d00dc50ff' => [
'@odata.type' => 'microsoft.graph.plannerChecklistItem',
'isChecked' => true,
],
'a93c93c5-10a6-4167-9551-8bafa09967a7' => null,
];
$checklist->setAdditionalData($additionalData);
$requestBody->setChecklist($checklist);
$requestConfiguration = new DetailsRequestBuilderPatchRequestConfiguration();
$headers = [
'Prefer' => 'return=representation',
'If-Match' => 'W/"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc="',
];
$requestConfiguration->headers = $headers;
$result = $graphServiceClient->planner()->tasks()->byPlannerTaskId('plannerTask-id')->details()->patch($requestBody, $requestConfiguration)->wait();
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK .
Import-Module Microsoft.Graph.Planner
$params = @{
previewType = "noPreview"
references = @{
"http%3A//developer%2Emicrosoft%2Ecom" = @{
"@odata.type" = "microsoft.graph.plannerExternalReference"
alias = "Documentation"
previewPriority = " !"
type = "Other"
}
"https%3A//developer%2Emicrosoft%2Ecom/en-us/graph/graph-explorer" = @{
"@odata.type" = "microsoft.graph.plannerExternalReference"
previewPriority = " !!"
}
"http%3A//www%2Ebing%2Ecom" = $null
}
checklist = @{
"95e27074-6c4a-447a-aa24-9d718a0b86fa" = @{
"@odata.type" = "microsoft.graph.plannerChecklistItem"
title = "Update task details"
isChecked = $true
}
"d280ed1a-9f6b-4f9c-a962-fb4d00dc50ff" = @{
"@odata.type" = "microsoft.graph.plannerChecklistItem"
isChecked = $true
}
"a93c93c5-10a6-4167-9551-8bafa09967a7" = $null
}
}
Update-MgPlannerTaskDetail -PlannerTaskId $plannerTaskId -BodyParameter $params -IfMatch W/'"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc="'
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK .
from msgraph import GraphServiceClient
from msgraph.generated.planner.tasks.item.details.details_request_builder import DetailsRequestBuilder
from msgraph.generated.models.planner_task_details import PlannerTaskDetails
from msgraph.generated.models.planner_external_references import PlannerExternalReferences
from msgraph.generated.models.planner_external_reference import PlannerExternalReference
from msgraph.generated.models.planner_checklist_items import PlannerChecklistItems
from msgraph.generated.models.planner_checklist_item import PlannerChecklistItem
graph_client = GraphServiceClient(credentials, scopes)
request_body = PlannerTaskDetails(
preview_type = PlannerPreviewType.NoPreview,
references = PlannerExternalReferences(
additional_data = {
"http%3_a//developer%2_emicrosoft%2_ecom" : {
"@odata_type" : "microsoft.graph.plannerExternalReference",
"alias" : "Documentation",
"preview_priority" : " !",
"type" : "Other",
},
"https%3_a//developer%2_emicrosoft%2_ecom/en-us/graph/graph-explorer" : {
"@odata_type" : "microsoft.graph.plannerExternalReference",
"preview_priority" : " !!",
},
"http%3_a//www%2_ebing%2_ecom" : None,
}
),
checklist = PlannerChecklistItems(
additional_data = {
"95e27074-6c4a-447a-aa24-9d718a0b86fa" : {
"@odata_type" : "microsoft.graph.plannerChecklistItem",
"title" : "Update task details",
"is_checked" : True,
},
"d280ed1a-9f6b-4f9c-a962-fb4d00dc50ff" : {
"@odata_type" : "microsoft.graph.plannerChecklistItem",
"is_checked" : True,
},
"a93c93c5-10a6-4167-9551-8bafa09967a7" : None,
}
),
)
request_configuration = DetailsRequestBuilder.DetailsRequestBuilderPatchRequestConfiguration()
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').details.patch(request_body, request_configuration = request_configuration)
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK .
Resposta
O exemplo a seguir mostra a resposta.
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
HTTP/1.1 200 OK
Content-type: application/json
{
"description": "Task details properties:\nchecklist:Sub items\nreferences:Related links",
"previewType": "automatic",
"references": {
"https%3A//developer%2Emicrosoft%2Ecom/en-us/graph/graph-explorer": {
"@odata.type": "#microsoft.graph.plannerExternalReference",
"alias": "Graph Explorer",
"type": "Other",
"previewPriority": "8599273",
"lastModifiedBy": {
"user": {
"id": "fbab97d0-4932-4511-b675-204639209557"
}
},
"lastModifiedDateTime": "2017-04-24T22:52:29.814Z"
},
"http%3A//developer%2Emicrosoft%2Ecom": {
"@odata.type": "#microsoft.graph.plannerExternalReference",
"alias": "Documentation",
"type": "Other",
"previewPriority": "90727736",
"lastModifiedBy": {
"user": {
"id": "fbab97d0-4932-4511-b675-204639209557"
}
},
"lastModifiedDateTime": "2017-04-24T22:52:29.814Z"
}
},
"checklist": {
"d280ed1a-9f6b-4f9c-a962-fb4d00dc50ff": {
"@odata.type": "#microsoft.graph.plannerChecklistItem",
"isChecked": true,
"title": "Try reading task details",
"orderHint": "a93c93c5^",
"lastModifiedBy": {
"user": {
"id": "fbab97d0-4932-4511-b675-204639209557"
}
},
"lastModifiedDateTime": "2017-04-24T22:52:29.814Z"
},
"95e27074-6c4a-447a-aa24-9d718a0b86f": {
"@odata.type": "#microsoft.graph.plannerChecklistItem",
"isChecked": true,
"title": "Update task details",
"orderHint": "8587094707721254251P]",
"lastModifiedBy": {
"user": {
"id": "fbab97d0-4932-4511-b675-204639209557"
}
},
"lastModifiedDateTime": "2017-04-24T22:52:29.814Z"
}
},
"id": "gcrYAaAkgU2EQUvpkNNXLGQAGTtu"
}