Espacio de nombres: microsoft.graph
Importante
Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.
Actualice las propiedades del objeto plannerTaskDetails .
Esta API está disponible en las siguientes implementaciones nacionales de nube.
| Servicio global |
Gobierno de EE. UU. L4 |
Us Government L5 (DOD) |
China operada por 21Vianet |
| ✅ |
✅ |
✅ |
❌ |
Permissions
Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.
| Tipo de permiso |
Permisos con privilegios mínimos |
Permisos con privilegios más altos |
| Delegado (cuenta profesional o educativa) |
Tasks.ReadWrite |
Group.ReadWrite.All |
| Delegado (cuenta personal de Microsoft) |
No admitida. |
No admitida. |
| Aplicación |
Tasks.ReadWrite.All |
No disponible. |
Solicitud HTTP
PATCH /planner/tasks/{id}/details
| Nombre |
Descripción |
| Authorization |
{token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización. |
| If-Match |
Último valor ETag conocido para plannerTaskDetails que se va a actualizar. Obligatorio. |
Cuerpo de la solicitud
En el cuerpo de la solicitud, proporcione solo los valores de las propiedades que se van a actualizar. Las propiedades existentes que no se incluyen en el cuerpo de la solicitud mantienen sus valores anteriores o se recalculan en función de los cambios realizados en otros valores de propiedad.
En la tabla siguiente se especifican las propiedades que se pueden actualizar.
| Propiedad |
Tipo |
Description |
| lista de verificación |
plannerChecklistItems |
Colección de elementos de lista de comprobación de la tarea. |
| description |
Cadena |
Descripción de la tarea. |
| notas |
itemBody |
Descripción de texto enriquecido de la tarea. Para que lo usen los clientes compatibles con HTML. Por compatibilidad con versiones anteriores, se sincronizará una versión de texto sin formato de la descripción HTML con el campo "description". Si este campo no se ha establecido anteriormente, pero sí "descripción", la descripción existente se sincronizará con "notas" con un marcado HTML mínimo que conserva espacios en blanco. Establecer "description" y "notes" es un error y dará lugar a una excepción. |
| previewType |
string |
Establece el tipo de vista previa que aparece en la tarea. Los valores posibles son: automatic, noPreview, checklist, description, reference. Cuando se establece en automatic la vista previa mostrada, la aplicación que ve la tarea elige. |
| Referencias |
plannerExternalReferences |
Colección de referencias de la tarea. |
Respuesta
Si se ejecuta correctamente, este método devuelve un código de 204 No Content respuesta y contenido vacío. Si la solicitud especifica el Prefer encabezado con return=representation preferencia, este método devuelve un 200 OK código de respuesta y un objeto plannerTaskDetails actualizado en el cuerpo de la respuesta.
Este método puede devolver cualquiera de los códigos de estado HTTP. Los errores más comunes que las aplicaciones deben controlar para este método son las respuestas 400, 403, 404, 409 y 412. Para obtener más información sobre estos errores, vea Common Planner error conditions (Condiciones de error habituales de Planner).
Ejemplo
Solicitud
En el ejemplo siguiente se muestra la solicitud.
PATCH https://graph.microsoft.com/beta/planner/tasks/gcrYAaAkgU2EQUvpkNNXLGQAGTtu/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/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
},
"description": "Updated task details properties:\nUpdated checklist:Sub items\nUpdated references:Related links"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.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/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
},
},
},
Description = "Updated task details properties:\nUpdated checklist:Sub items\nUpdated references:Related links",
};
// 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=\"");
});
// 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.TasksItemDetailsRequestBuilderPatchRequestConfiguration{
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/graph/graph-explorer" := graphmodels.NewPlannerExternalReference()
previewPriority := " !!"
"https%3A//developer%2Emicrosoft%2Ecom/graph/graph-explorer".SetPreviewPriority(&previewPriority)
references.Set"https%3A//developer%2Emicrosoft%2Ecom/graph/graph-explorer"("https%3A//developer%2Emicrosoft%2Ecom/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)
description := "Updated task details properties:\nUpdated checklist:Sub items\nUpdated references:Related links"
requestBody.SetDescription(&description)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
details, err := graphClient.Planner().Tasks().ByPlannerTaskId("plannerTask-id").Details().Patch(context.Background(), requestBody, configuration)
// 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 https3ADeveloper2Emicrosoft2EcomGraphGraphExplorer = new PlannerExternalReference();
https3ADeveloper2Emicrosoft2EcomGraphGraphExplorer.setOdataType("microsoft.graph.plannerExternalReference");
https3ADeveloper2Emicrosoft2EcomGraphGraphExplorer.setPreviewPriority(" !!");
additionalData.put("https%3A//developer%2Emicrosoft%2Ecom/graph/graph-explorer", https3ADeveloper2Emicrosoft2EcomGraphGraphExplorer);
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.setDescription("Updated task details properties:\nUpdated checklist:Sub items\nUpdated references:Related links");
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=\"");
});
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/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
},
description: 'Updated task details properties:\nUpdated checklist:Sub items\nUpdated references:Related links'
};
await client.api('/planner/tasks/gcrYAaAkgU2EQUvpkNNXLGQAGTtu/details')
.version('beta')
.update(plannerTaskDetails);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Planner\Tasks\Item\Details\DetailsRequestBuilderPatchRequestConfiguration;
use Microsoft\Graph\Beta\Generated\Models\PlannerTaskDetails;
use Microsoft\Graph\Beta\Generated\Models\PlannerPreviewType;
use Microsoft\Graph\Beta\Generated\Models\PlannerExternalReferences;
use Microsoft\Graph\Beta\Generated\Models\PlannerExternalReference;
use Microsoft\Graph\Beta\Generated\Models\PlannerChecklistItems;
use Microsoft\Graph\Beta\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/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);
$requestBody->setDescription('Updated task details properties:\nUpdated checklist:Sub items\nUpdated references:Related links');
$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();
Import-Module Microsoft.Graph.Beta.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/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
}
description = "Updated task details properties:
Updated checklist:Sub items
Updated references:Related links"
}
Update-MgBetaPlannerTaskDetail -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.details.details_request_builder import DetailsRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
from msgraph_beta.generated.models.planner_task_details import PlannerTaskDetails
from msgraph_beta.generated.models.planner_preview_type import PlannerPreviewType
from msgraph_beta.generated.models.planner_external_references import PlannerExternalReferences
from msgraph_beta.generated.models.planner_external_reference import PlannerExternalReference
from msgraph_beta.generated.models.planner_checklist_items import PlannerChecklistItems
from msgraph_beta.generated.models.planner_checklist_item import PlannerChecklistItem
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
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/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,
}
),
description = "Updated task details properties:\nUpdated checklist:Sub items\nUpdated references:Related links",
)
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').details.patch(request_body, request_configuration = request_configuration)
Respuesta
En el ejemplo siguiente se muestra la respuesta.
Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.
HTTP/1.1 200 OK
Content-type: application/json
{
"description": "Updated task details properties:\nUpdated checklist:Sub items\nUpdated references:Related links",
"notes": {
"content": "<div style=\"white-space:pre-wrap\">Updated task details properties:\nUpdated checklist:Sub items\nUpdated references:Related links</div>",
"contentType": "html"
},
"previewType": "automatic",
"references": {
"https%3A//developer%2Emicrosoft%2Ecom/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"
}