Observação: 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 um conjunto de objetos de anotação que foram adicionados, atualizados ou excluídos na pasta Anotações do usuário desde a última consulta delta. Uma chamada de função delta para anotações é semelhante a uma solicitação GET, exceto que, ao aplicar adequadamente tokens de estado em uma ou mais dessas chamadas, você pode consultar alterações incrementais nas anotações.

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) ShortNotes.Read ShortNotes.ReadWrite
Delegado (conta pessoal da Microsoft) ShortNotes.Read ShortNotes.ReadWrite
Aplicativo Sem suporte. Sem suporte.

Solicitação HTTP

GET /me/notes/delta
GET /users/{id | userPrincipalName}/notes/delta

Parâmetros de consulta

O acompanhamento de alterações em anotaçõ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.

Parâmetro de consulta Tipo Descrição
$deltatoken Cadeia de caracteres Um token de estado retornado na URL @odata.deltaLink da chamada de função delta anterior, indicando a conclusão dessa rodada de controle de alterações. Salve e aplique toda a URL @odata.deltaLink , incluindo esse token, na primeira solicitação da próxima rodada de controle de alterações para essa coleção.
$skiptoken Cadeia de caracteres Um token de estado retornado na URL @odata.nextLink da chamada de função delta anterior, indicando alterações adicionais a serem rastreadas.

Esse método também dá suporte aos $selectparâmetros de consulta , $filter, $orderbye $top OData para ajudar a personalizar a resposta.

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Se for bem-sucedido, esse método retornará um 200 OK código de resposta e uma coleção de objetos de anotação no corpo da resposta. A resposta também inclui uma URL @odata.nextLink ou uma URL @odata.deltaLink .

  • Se uma URL @odata.nextLink for retornada, mais páginas de dados ainda precisam ser recuperadas. O aplicativo continua fazendo solicitações usando a URL @odata.nextLink até que uma URL @odata.deltaLink seja incluída na resposta.
  • Se uma URL @odata.deltaLink for retornada, não restarão mais páginas de dados a serem retornadas. Salve a URL @odata.deltaLink para uso na próxima chamada delta .

Exemplos

Exemplo 1: solicitação de sincronização inicial

O exemplo a seguir mostra a solicitação de sincronização inicial para obter todas as anotações.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/me/notes/delta

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('user-id')/notes",
  "@odata.deltaLink": "https://graph.microsoft.com/beta/me/notes/delta?$deltatoken=abc123def456",
  "value": [
    {
      "id": "AAMkAGI2THVSAAA=",
      "changeKey": "CQAAABYAAABE",
      "createdDateTime": "2024-01-15T10:00:00Z",
      "lastModifiedDateTime": "2024-01-20T11:00:00Z",
      "categories": [],
      "subject": "Updated Note",
      "body": {
        "contentType": "html",
        "content": "<html><body>Updated content</body></html>"
      },
      "bodyPreview": "Updated content",
      "isDeleted": false,
      "hasAttachments": false
    }
  ]
}

Exemplo 2: solicitação delta subsequente

O exemplo a seguir mostra uma solicitação de sincronização subsequente usando o token delta da resposta anterior. Anotações novas, atualizadas e excluídas são retornadas.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/me/notes/delta?$deltatoken=abc123def456

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('user-id')/notes",
  "@odata.deltaLink": "https://graph.microsoft.com/beta/me/notes/delta?$deltatoken=xyz789new",
  "value": [
    {
      "id": "AAMkAGI2NEWITEM=",
      "changeKey": "CQAAABYAAABF",
      "subject": "New Note",
      "bodyPreview": "New content",
      "createdDateTime": "2024-01-21T08:00:00Z",
      "lastModifiedDateTime": "2024-01-21T08:00:00Z"
    },
    {
      "@removed": {
        "reason": "deleted"
      },
      "id": "AAMkAGI2DELETED="
    }
  ]
}
  • Last updated on