nota: 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 nota que foram adicionados, atualizados ou eliminados na pasta Notas do utilizador desde a última consulta delta. Uma chamada de função delta para notas é semelhante a um pedido GET, exceto que ao aplicar adequadamente tokens de estado numa ou mais destas chamadas, pode consultar alterações incrementais nas notas.

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) 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 registo de alterações nas notas implica uma ronda 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 do URL @odata.nextLink ou @odata.deltaLink fornecido na resposta.

Parâmetro de consulta Tipo Descrição
$deltatoken Cadeia de caracteres Um token de estado devolvido no URL @odata.deltaLink da chamada da função delta anterior, indicando a conclusão dessa ronda de controlo de alterações. Guarde e aplique todo o URL @odata.deltaLink , incluindo este token, no primeiro pedido da próxima ronda de controlo de alterações para essa coleção.
$skiptoken Cadeia de caracteres Um token de estado devolvido no URL @odata.nextLink da chamada da função delta anterior, que indica que serão registadas mais alterações.

Este método também suporta os $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, este método devolve um 200 OK código de resposta e uma coleção de objetos de nota no corpo da resposta. A resposta também inclui um URL @odata.nextLink ou um URL @odata.deltaLink .

  • Se for devolvido um URL @odata.nextLink , ainda falta obter mais páginas de dados. A aplicação continua a fazer pedidos com o URL @odata.nextLink até que um URL @odata.deltaLink seja incluído na resposta.
  • Se for devolvido um URL @odata.deltaLink , não serão devolvidas mais páginas de dados. Guarde o URL @odata.deltaLink para utilização na próxima chamada delta .

Exemplos

Exemplo 1: pedido de sincronização inicial

O exemplo seguinte mostra o pedido de sincronização inicial para obter todas as notas.

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: pedido delta subsequente

O exemplo seguinte mostra um pedido de sincronização subsequente com o token delta da resposta anterior. São devolvidas notas novas, atualizadas e eliminadas.

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