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 do 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 rastrear alterações nos dados do Microsoft Graph.

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet
✅ ✅ ✅ ❌

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos 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 com privilégios mais elevados
Delegado (conta corporativa ou de estudante) Tasks.Read Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application 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 controle de alterações. Salve e aplique a URL inteira @odata.deltaLink , incluindo esse token na primeira solicitação da próxima rodada de controle de alterações dessa 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.

Ao chamar essa API com permissões somente de aplicativo, você deve definir o escopo da solicitação para um único plano usando um $filter parâmetro de consulta do formato planId eq '{planId}'e incluir um $select parâmetro de consulta que especifique exatamente essas três propriedades não id: percentComplete, assignmentse creationSource. Por exemplo, $select=percentComplete,assignments,creationSource. Selecionar um número diferente de propriedades não id retorna uma 405 Method Not Allowed resposta e selecionar três propriedades não id diferentes dessas retorna uma 403 Forbidden resposta. A propriedade id sempre é retornada e pode ser incluída sem $select contar para esse limite.

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 código de 200 OK 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
      },
      "id": "aSOQ0mveu06bTSkfnJQay2QAIn_l",
      "version": "1-Task  @@@@@@@@@@@@@@@H",
      "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
      },
      "id": "aSOQ0mveu06bTSkfnJQay2QAIn_l",
      "version": "1-Task  @@@@@@@@@@@@@@@H",
      "details": {
        "@odata.etag": "W/\"JzEtVGFza0RldGFpbHMgQEBAQEBAQEBAQEBAQEBARCc=\"",
        "description": "",
        "notes": null,
        "previewType": "automatic",
        "references": {},
        "checklist": {},
        "id": "aSOQ0mveu06bTSkfnJQay2QAIn_l",
        "version": "1-TaskDetails @@@@@@@@@@@@@@@D"
      }
    }
  ]
}

Exemplo 3: Obter delta em tarefas em um plannerPlan usando permissões somente de aplicativo

O exemplo a seguir mostra uma solicitação que usa permissões somente de aplicativo. Conforme descrito na seção Parâmetros de consulta , a solicitação deve ter como escopo um único plano usando um $filter parâmetro de consulta e deve selecionar exatamente as percentCompletepropriedades , assignmentse creationSource usando um $select parâmetro de consulta.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/planner/tasks/delta?$filter=planId eq '-W4K7hIak0WlAwgJCn1sEWQABgjH'&$select=percentComplete,assignments,creationSource

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?%24select=percentComplete,assignments,creationSource&%24deltatoken=0%257eaa6c4c81-656f-40e8-a2c5-60f4116fa9a4",
  "value": [
    {
      "@odata.etag": "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBASCc=\"",
      "percentComplete": 0,
      "assignments": {
        "b40c85a0-1a66-4fa3-932f-cc9249ce8c29": {
          "@odata.type": "#microsoft.taskServices.assignment",
          "assignedBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
          "assignedDateTime": "2022-09-29T18:14:33.1404924Z",
          "orderHint": "8585371316723527019PX"
        }
      },
      "creationSource": {
        "publication": null,
        "externalSource": null
      },
      "id": "aSOQ0mveu06bTSkfnJQay2QAIn_l"
    }
  ]
}