Atualizar outlooktask (preterido)
Namespace: microsoft.graph
Importante
As APIs na versão /beta
no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
Cuidado
A API de tarefas do Outlook foi preterida e deixou de devolver dados a 20 de agosto de 2022. Em alternativa, utilize a API To Do .
Alterar as propriedades graváveis de uma tarefa do Outlook.
A propriedade completedDateTime pode ser definida pela ação completa ou explicitamente por uma operação PATCH. Se utilizar PATCH para definir completedDateTime, certifique-se de que também define o estado como completed
.
Por predefinição, esta operação (e as operações de tarefa POST, GET e complete ) devolvem propriedades relacionadas com a data em UTC. Você pode usar o cabeçalho Prefer: outlook.timezone
para que todas as propriedades relacionadas à data na resposta sejam representadas em um fuso horário diferente de UTC.
Esta API está disponível nas seguintes implementações de cloud nacionais.
Serviço global | US Government L4 | US Government L5 (DOD) | China operada pela 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ❌ |
Permissões
Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.
Tipo de permissão | Permissões com menos privilégios | Permissões com privilégios superiores |
---|---|---|
Delegado (conta corporativa ou de estudante) | Tasks.ReadWrite | Indisponível. |
Delegado (conta pessoal da Microsoft) | Tasks.ReadWrite | Indisponível. |
Aplicativo | Sem suporte. | Sem suporte. |
Solicitação HTTP
PATCH /me/outlook/tasks/{id}
PATCH /users/{id|userPrincipalName}/outlook/tasks/{id}
Cabeçalhos de solicitação
Nome | Descrição |
---|---|
Autorização | {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
Prefira: outlook.timezone | Especifica o fuso horário das propriedades de hora na resposta, que estaria em UTC se este cabeçalho não for especificado. Opcional. |
Corpo da solicitação
No corpo da solicitação, forneça os valores para os campos relevantes que devem ser atualizados. Propriedades existentes que não estão incluídas no corpo da solicitação terão seus valores anteriores mantidos ou serão recalculadas com base nas alterações a outros valores de propriedade. Para obter o melhor desempenho, não inclua valores existentes que não foram alterados.
Propriedade | Tipo | Descrição |
---|---|---|
body | itemBody | Corpo da tarefa que normalmente contém informações sobre a tarefa. Observe para qual tipo de HTML há suporte. |
Categorias | Coleção de cadeias de caracteres | As categorias associadas à postagem. |
changeKey | Cadeia de caracteres | A versão da tarefa. |
completedDateTime | dateTimeTimeZone | A data no fuso horário especificado que a tarefa foi concluída. |
createdDateTime | DateTimeOffset | A data e a hora da criação da tarefa. Por padrão, está definida em UTC. Você pode fornecer um fuso horário personalizado no cabeçalho da solicitação. O valor da propriedade usa o formato ISO 8601. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z . |
dueDateTime | dateTimeTimeZone | A data no fuso horário especificado que a tarefa será concluída. |
hasAttachments | Booliano | Defina como verdadeiro se a tarefa tiver anexos. |
importância | cadeia de caracteres | A importância do evento. Os valores possíveis são: low , normal , high . |
isReminderOn | Booliano | Definido como verdadeiro se um alerta é definido para lembrar o usuário da tarefa. |
lastModifiedDateTime | DateTimeOffset | A data e hora da última modificação da tarefa. Por padrão, está definida em UTC. Você pode fornecer um fuso horário personalizado no cabeçalho da solicitação. O valor da propriedade usa o formato ISO 8601 e está sempre no horário UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z . |
owner | Cadeia de caracteres | O nome da pessoa que criou a tarefa. |
parentFolderId | Cadeia de caracteres | O identificador exclusivo para a pasta pai da tarefa. |
recorrência | patternedRecurrence | O padrão de recorrência da tarefa. |
reminderDateTime | dateTimeTimeZone | A data e hora do alerta de lembrete da tarefa. |
sensibilidade | cadeia de caracteres | Indica o nível de privacidade da tarefa. Os valores possíveis são: normal , personal , private , confidential . |
startDateTime | dateTimeTimeZone | A data no fuso horário especificado que a tarefa será iniciada. |
status | cadeia de caracteres | Indica o estado ou o andamento da tarefa. Os valores possíveis são: notStarted , inProgress , completed , waitingOnOthers , deferred . |
assunto | Cadeia de caracteres | Uma breve descrição ou o título da tarefa. |
Resposta
Se for bem-sucedido, este método devolve um 200 OK
código de resposta e o objeto outlookTask atualizado no corpo da resposta.
Exemplo
Solicitação
O exemplo seguinte modifica a propriedade dueDateTime e utiliza o Prefer: outlook.timezone
cabeçalho para especificar a expressão das propriedades relacionadas com a data na resposta na Hora Padrão do Leste (EST).
PATCH https://graph.microsoft.com/beta/me/outlook/tasks/AAMkADA1MTHgwAAA=
Prefer: outlook.timezone="Eastern Standard Time"
Content-type: application/json
{
"dueDateTime": {
"dateTime": "2016-05-06T16:00:00",
"timeZone": "Eastern Standard Time"
}
}
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
{
"id": "AAMkADA1MTHgwAAA=",
"createdDateTime": "2016-04-22T18:19:18.9526004-04:00",
"lastModifiedDateTime": "2016-04-22T18:38:20.5541528-04:00",
"changeKey": "1/KC9Vmu40G3DwB6Lgs7MAAAIW9XXg==",
"categories": [
],
"assignedTo": null,
"body": {
"contentType": "text",
"content": ""
},
"completedDateTime": null,
"dueDateTime": {
"dateTime": "2016-05-06T00:00:00.0000000",
"timeZone": "Eastern Standard Time"
},
"hasAttachments":false,
"importance": "normal",
"isReminderOn": false,
"owner": "Administrator",
"parentFolderId": "AQMkADA1MTIBEgAAAA==",
"recurrence": null,
"reminderDateTime": null,
"sensitivity": "normal",
"startDateTime": {
"dateTime": "2016-05-03T00:00:00.0000000",
"timeZone": "Eastern Standard Time"
},
"status": "notStarted",
"subject": "Shop for children's weekend"
}