plannerTask: delta
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.
Obtenha tarefas recém-criadas, atualizadas ou excluídas em um plano Planner ou atribuídas ao usuário conectado sem precisar executar uma leitura completa de toda a coleção de recursos. Para obter detalhes, consulte Usar a consulta delta para acompanhar as alterações nos dados do Microsoft Graph.
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.Read | Indisponível. |
Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
Aplicativo | Tasks.Read.All | Indisponível. |
Solicitação HTTP
GET /planner/tasks/delta
GET /me/planner/tasks/delta
Parâmetros de consulta
O acompanhamento de alterações incorre em uma rodada de uma ou mais chamadas de função delta . Se você usar qualquer parâmetro de consulta (diferente de $deltaToken
e $skipToken
), especifique-o na primeira solicitação delta. O Microsoft Graph codifica automaticamente todos os parâmetros especificados na parte do token da URL @odata.nextLink
ou @odata.deltaLink
fornecida na resposta. Você só precisa especificar uma vez antecipadamente os parâmetros de consulta desejados. Em solicitações subsequentes, copie e aplique a @odata.nextLink
URL ou @odata.deltaLink
da resposta anterior. Essa URL já inclui os parâmetros codificados.
Parâmetro de consulta | Tipo | Descrição |
---|---|---|
$deltaToken | string | Um token de estado retornado na @odata.deltaLink URL da chamada de função delta anterior para a mesma coleção de recursos, indicando a conclusão dessa rodada de rastreamento de alterações. Salve e aplique toda @odata.deltaLink a URL, incluindo esse token na primeira solicitação da próxima rodada de acompanhamento de alterações para essa coleção. |
$skipToken | string | Um token de estado retornado na @odata.nextLink URL da chamada de função delta anterior, indicando que há outras alterações a serem rastreadas na mesma coleção de recursos. |
Cabeçalhos de solicitação
Nome | Descrição |
---|---|
Autorização | {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
Content-Type | application/json |
Corpo da solicitação
Não forneça um corpo de solicitação para esse método.
Resposta
Se for bem-sucedida, essa função retornará um 200 OK
código de resposta e uma coleção plannerTask no corpo da resposta.
Exemplos
Exemplo 1: obter delta em tarefas em um plannerPlan
O exemplo a seguir mostra uma solicitação para o delta em objetos plannerTask em um plannerPlan.
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/beta/planner/tasks/delta
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
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#plannerTask",
"@odata.deltaLink": "https://graph.microsoft.com/beta/planner/plans('-W4K7hIak0WlAwgJCn1sEWQABgjH')/tasks?%24expand=details&%24deltatoken=0%257eaa6c4c81-656f-40e8-a2c5-60f4116fa9a4",
"value": [
{
"@odata.etag": "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBASCc=\"",
"createdBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
"createdByApp": "09abbdfd-ed23-44ee-a2d9-a627aa1c90f3",
"createdByAsIdentitySet": {
"user": {
"@odata.type": "#microsoft.taskServices.identity",
"displayName": null,
"id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
},
"application": {
"@odata.type": "#microsoft.taskServices.identity",
"displayName": null,
"id": "09abbdfd-ed23-44ee-a2d9-a627aa1c90f3"
}
},
"userContentLastModifiedBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
"userContentLastModifiedByApp": null,
"userContentLastModifiedByAsIdentitySet": {
"user": {
"@odata.type": "#microsoft.taskServices.identity",
"displayName": null,
"id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
}
},
"planId": "-W4K7hIak0WlAwgJCn1sEWQABgjH",
"bucketId": "iz1mmIxX7EK0Yj7DmRsMs2QAEDXH",
"title": "Testing",
"orderHint": "8585371316800245114P\\",
"assigneePriority": "8585371316123370883",
"focusDateTime": null,
"percentComplete": 0,
"startDateTime": null,
"createdDateTime": "2022-09-29T18:14:25.6091874Z",
"userContentLastModifiedDate": "2022-09-29T18:14:33.1404924Z",
"dueDateTime": null,
"recurrence": null,
"hasDescription": false,
"previewType": "automatic",
"completedDateTime": null,
"completedBy": null,
"completedByApp": null,
"completedByAsIdentitySet": null,
"referenceCount": 0,
"checklistItemCount": 0,
"activeChecklistItemCount": 0,
"appliedCategories": {},
"assignments": {
"b40c85a0-1a66-4fa3-932f-cc9249ce8c29": {
"@odata.type": "#microsoft.taskServices.assignment",
"assignedBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
"assignedByAppId": null,
"assignedByAsIdentitySet": {
"user": {
"@odata.type": "#microsoft.taskServices.identity",
"displayName": null,
"id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
}
},
"assignedDateTime": "2022-09-29T18:14:33.1404924Z",
"orderHint": "8585371316723527019PX",
"createdBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
"createdByAppId": null,
"createdByAsIdentitySet": {
"user": {
"@odata.type": "#microsoft.taskServices.identity",
"displayName": null,
"id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
}
}
}
},
"conversationThreadId": null,
"priority": 5,
"creationSource": {
"publication": null,
"externalSource": null
},
"creationSourceInfo": null,
"id": "aSOQ0mveu06bTSkfnJQay2QAIn_l",
"version": "1-Task @@@@@@@@@@@@@@@H",
"details@odata.context": "https://tasks.officeppe.com/taskApi/V3.0/$metadata#plans('-W4K7hIak0WlAwgJCn1sEWQABgjH')/tasks('aSOQ0mveu06bTSkfnJQay2QAIn_l')/details/$entity",
"details": {
"@odata.etag": "W/\"JzEtVGFza0RldGFpbHMgQEBAQEBAQEBAQEBAQEBARCc=\"",
"description": "",
"notes": null,
"previewType": "automatic",
"references": {},
"checklist": {},
"id": "aSOQ0mveu06bTSkfnJQay2QAIn_l",
"version": "1-TaskDetails @@@@@@@@@@@@@@@D"
}
}
]
}
Exemplo 2: obter delta em tarefas atribuídas a um usuário
O exemplo a seguir mostra uma solicitação para o delta em objetos plannerTask atribuídos a um usuário.
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/beta/me/planner/tasks/delta
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
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#plannerTask",
"@odata.deltaLink": "https://graph.microsoft.com/beta/me/planner/tasks/delta?%24expand=details&%24deltatoken=0%257eaa6c4c81-656f-40e8-a2c5-60f4116fa9a4",
"value": [
{
"@odata.etag": "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBASCc=\"",
"createdBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
"createdByApp": "09abbdfd-ed23-44ee-a2d9-a627aa1c90f3",
"createdByAsIdentitySet": {
"user": {
"@odata.type": "#microsoft.taskServices.identity",
"displayName": null,
"id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
},
"application": {
"@odata.type": "#microsoft.taskServices.identity",
"displayName": null,
"id": "09abbdfd-ed23-44ee-a2d9-a627aa1c90f3"
}
},
"userContentLastModifiedBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
"userContentLastModifiedByApp": null,
"userContentLastModifiedByAsIdentitySet": {
"user": {
"@odata.type": "#microsoft.taskServices.identity",
"displayName": null,
"id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
}
},
"planId": "-W4K7hIak0WlAwgJCn1sEWQABgjH",
"bucketId": "iz1mmIxX7EK0Yj7DmRsMs2QAEDXH",
"title": "Testing",
"orderHint": "8585371316800245114P\\",
"assigneePriority": "8585371316123370883",
"focusDateTime": null,
"percentComplete": 0,
"startDateTime": null,
"createdDateTime": "2022-09-29T18:14:25.6091874Z",
"userContentLastModifiedDate": "2022-09-29T18:14:33.1404924Z",
"dueDateTime": null,
"recurrence": null,
"hasDescription": false,
"previewType": "automatic",
"completedDateTime": null,
"completedBy": null,
"completedByApp": null,
"completedByAsIdentitySet": null,
"referenceCount": 0,
"checklistItemCount": 0,
"activeChecklistItemCount": 0,
"appliedCategories": {},
"assignments": {
"b40c85a0-1a66-4fa3-932f-cc9249ce8c29": {
"@odata.type": "#microsoft.taskServices.assignment",
"assignedBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
"assignedByAppId": null,
"assignedByAsIdentitySet": {
"user": {
"@odata.type": "#microsoft.taskServices.identity",
"displayName": null,
"id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
}
},
"assignedDateTime": "2022-09-29T18:14:33.1404924Z",
"orderHint": "8585371316723527019PX",
"createdBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
"createdByAppId": null,
"createdByAsIdentitySet": {
"user": {
"@odata.type": "#microsoft.taskServices.identity",
"displayName": null,
"id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
}
}
}
},
"conversationThreadId": null,
"priority": 5,
"creationSource": {
"publication": null,
"externalSource": null
},
"creationSourceInfo": null,
"id": "aSOQ0mveu06bTSkfnJQay2QAIn_l",
"version": "1-Task @@@@@@@@@@@@@@@H",
"details@odata.context": "https://tasks.officeppe.com/taskApi/V3.0/$metadata#plans('-W4K7hIak0WlAwgJCn1sEWQABgjH')/tasks('aSOQ0mveu06bTSkfnJQay2QAIn_l')/details/$entity",
"details": {
"@odata.etag": "W/\"JzEtVGFza0RldGFpbHMgQEBAQEBAQEBAQEBAQEBARCc=\"",
"description": "",
"notes": null,
"previewType": "automatic",
"references": {},
"checklist": {},
"id": "aSOQ0mveu06bTSkfnJQay2QAIn_l",
"version": "1-TaskDetails @@@@@@@@@@@@@@@D"
}
},
]
}