Usar la API Búsqueda de Microsoft para buscar eventos de calendario

Use la API Búsqueda de Microsoft para buscar eventos en el calendario principal del usuario que ha iniciado sesión. La identidad del usuario para la búsqueda se basa en el token de autenticación.

Precaución

El esquema de la API de búsqueda ha cambiado en la versión beta con algunas propiedades de una solicitud de búsqueda y respuesta cuyo nombre o respuesta se han quitado. Obtenga más información sobre el desuso. En los ejemplos de este tema se muestra el esquema actualizado que se va a usar en v1.0 y beta.

Ejemplo

Solicitud

En este ejemplo se busca en el calendario del usuario la palabra clave "contoso" y se devolverán hasta 25 resultados.

POST https://graph.microsoft.com/v1.0/search/query
Content-Type: application/json

{
  "requests": [
    {
      "entityTypes": [
        "event"
      ],
      "query": {
        "queryString":"contoso"
      },
      "from": 0,
      "size": 25
    }
  ]
}

Respuesta

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

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#search",
  "value": [
  {
   "@odata.type": "#microsoft.graph.searchResponse",
   "searchTerms": [
    "contoso"
   ],
   "hitsContainers": [
    {
     "@odata.type": "#microsoft.graph.searchHitsContainer",
     "hits": [
      {
       "@odata.type": "#microsoft.graph.searchHit",
       "hitId": "AAMkADEwODY2NzllLTQ3MmEtNGRlMC05ZTUyLTE4ZDRhYmU1ZGM3NABGAAAAAAA3+iYQBnJnQabRVDelNhnzBwAejhWkAOAxQ6M4c1c9NwfrAAAAAAENAAAejhWkAOAxQ6M4c1c9NwfrAABbUZLJAAA=",
       "rank": 1,
       "summary": "Here is a summary of your events from last week",
       "resource": {
        "@odata.type": "#microsoft.graph.event",
        "end": {
         "dateTime": "2020-06-16T04:15:00Z",
         "timeZone": "UTC"
        },
        "hasAttachments": false,
        "iCalUId": "040000008200E00074C5B7101A82E008000000007093FDD79B3AD60100000000000000001000000036DAA2262EB4E04DA27DA77985FB8251",
        "isAllDay": false,
        "sensitivity": "Normal",
        "start": {
         "dateTime": "2020-06-16T03:30:00Z",
         "timeZone": "UTC"
        },
        "subject": "Weekly digest: Microsoft 365 changes",
        "type": "Single"
       }
      }
     ],
     "total": 1,
     "moreResultsAvailable": false
    }
   ]
  }
 ]
}

Limitaciones conocidas

  • Solo puede tener acceso al buzón del usuario que ha iniciado sesión. No se admite la búsqueda de buzones delegados.
  • Para los eventos, la propiedad total del tipo searchHitsContainer contiene el número de resultados de la página, no el número total de resultados que coinciden.
  • Los resultados de ordenación no se admiten para eventos. Una cláusula de ordenación de la solicitud devolverá un código de error De solicitud mala en la respuesta.

Pasos siguientes