Obter anotação

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.

Leia as propriedades e relações de um objeto de anotação .

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/{note-id}
GET /users/{id | userPrincipalName}/notes/{note-id}

Parâmetros de consulta opcionais

Esse método dá suporte aos $select parâmetros de consulta OData e $expand para ajudar a personalizar a resposta. Para obter informações gerais, acesse Parâmetros de consulta OData.

Use $expand=attachments para incluir anexos de arquivo na 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 código de 200 OK resposta e um objeto de anotação no corpo da resposta.

Exemplos

Exemplo 1: Obter uma anotação

O exemplo a seguir mostra como obter um objeto de anotação .

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/me/notes/AAMkAGI2THVSAAA=

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/$entity",
  "id": "AAMkAGI2THVSAAA=",
  "changeKey": "CQAAABYAAABE",
  "createdDateTime": "2024-01-20T10:30:00Z",
  "lastModifiedDateTime": "2024-01-20T10:30:00Z",
  "categories": [],
  "subject": "Project Ideas",
  "body": {
    "contentType": "html",
    "content": "<html><body><p>Consider implementing automated testing framework</p></body></html>"
  },
  "bodyPreview": "Consider implementing automated testing framework",
  "isDeleted": false,
  "hasAttachments": false
}

Exemplo 2: Obter uma anotação com anexos

O exemplo a seguir mostra como obter um objeto de anotação usando $expand para incluir anexos.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/me/notes/AAMkAGI2THVSAAA=?$expand=attachments

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/$entity",
  "id": "AAMkAGI2THVSAAA=",
  "changeKey": "CQAAABYAAABE",
  "createdDateTime": "2024-01-15T14:00:00Z",
  "lastModifiedDateTime": "2024-01-15T14:30:00Z",
  "categories": [],
  "subject": "Meeting Whiteboard",
  "body": {
    "contentType": "html",
    "content": "<html><body><p>Key discussion points:</p><img src=\"cid:image001\" /></body></html>"
  },
  "bodyPreview": "Key discussion points:",
  "isDeleted": false,
  "hasAttachments": true,
  "attachments": [
    {
      "@odata.type": "#microsoft.graph.fileAttachment",
      "id": "AAMkAGI2attach1",
      "name": "whiteboard.png",
      "contentType": "image/png",
      "size": 45678,
      "isInline": true,
      "contentId": "image001",
      "lastModifiedDateTime": "2024-01-15T14:30:00Z"
    }
  ]
}
  • Last updated on