searchEntity: consulta
Espacio de nombres: microsoft.graph
Importante
Las API de la versión /beta
de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.
Ejecute una consulta de búsqueda especificada. Búsqueda resultados se proporcionan en la respuesta.
Precaución
Se han cambiado o eliminado, o están en desuso, los nombres de algunas de las propiedades del recurso que se usa para la solicitud y respuesta de la API de Búsqueda de Microsoft. Obtenga más información sobre el desuso. Actualice las consultas de las API de búsqueda en las aplicaciones anteriores correspondientes.
Esta API está disponible en las siguientes implementaciones nacionales de nube.
Servicio global | Gobierno de EE. UU. L4 | Us Government L5 (DOD) | China operada por 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissions
Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.
Tipo de permiso | Permisos con privilegios mínimos | Permisos con privilegios más altos |
---|---|---|
Delegado (cuenta profesional o educativa) | Mail.Read | Acronym.Read.All, Bookmark.Read.All, Calendars.Read, Chat.Read, ExternalItem.Read.All, Files.Read.All, QnA.Read.All, Sites.Read.All |
Delegado (cuenta personal de Microsoft) | No admitida. | No admitida. |
Aplicación | Files.Read.All | Sites.Read.All |
Solicitud HTTP
POST /search/query
Encabezados de solicitud
Nombre | Descripción |
---|---|
Authorization | {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización. |
Tipo de contenido | application/json. Obligatorio. |
Cuerpo de la solicitud
En el cuerpo de la solicitud, proporcione un objeto JSON con los siguientes parámetros.
Parámetro | Tipo | Descripción |
---|---|---|
Solicitudes | colección searchRequest | Una colección de una o varias solicitudes de búsqueda tiene formato en un blob JSON. Cada blob JSON contiene los tipos de recursos esperados en la respuesta, los orígenes subyacentes, los parámetros de paginación, los campos solicitados y la consulta de búsqueda real. Tenga en cuenta las limitaciones conocidas para buscar combinaciones específicas de tipos de entidad y ordenar o agregar resultados de búsqueda. |
Respuesta
Si se ejecuta correctamente, este método devuelve un HTTP 200 OK
código de respuesta y una colección de objetos searchResponse en el cuerpo de la respuesta.
Ejemplos
Ejemplo 1: Llamada básica para realizar una solicitud de búsqueda
En el ejemplo siguiente se muestra cómo realizar una búsqueda para obtener los elementos de conector esperados.
Solicitud
POST https://graph.microsoft.com/beta/search/query
Content-type: application/json
{
"requests": [
{
"entityTypes": [
"externalItem"
],
"contentSources": [
"/external/connections/connectionfriendlyname"
],
"region": "US",
"query": {
"queryString": "contoso product"
},
"from": 0,
"size": 25,
"fields": [
"title",
"description"
]
}
]
}
Respuesta
En el ejemplo siguiente se muestra la respuesta.
Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"searchTerms": [
"searchTerms-value"
],
"hitsContainers": [
{
"hits": [
{
"hitId": "1",
"rank": 1,
"summary": "_summary-value",
"resource": "The source field will contain the underlying graph entity part of the response"
}
],
"total": 47,
"moreResultsAvailable": true
}
]
}
]
}
Ejemplo 2: Llamada básica para usar queryTemplate
En el ejemplo siguiente se muestra cómo usar la propiedad consultable createdBy para recuperar todos los archivos creados por un usuario.
Solicitud
POST https://graph.microsoft.com/beta/search/query
Content-type: application/json
{
"requests": [
{
"entityTypes": [
"listItem"
],
"region": "US",
"query": {
"queryString": "contoso",
"queryTemplate":"{searchTerms} CreatedBy:Bob"
},
"from": 0,
"size": 25
}
]
}
Respuesta
En el ejemplo siguiente se muestra la respuesta.
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"searchTerms": [
"contoso"
],
"hitsContainers": [
{
"hits": [
{
"hitId": "1",
"rank": 1,
"summary": "_summary-value",
"resource": {
"@odata.type": "#microsoft.graph.listItem",
"id": "c23c7035-73d6-4bad-8901-9e2930d4be8e",
"createdBy": {
"user": {
"displayName": "Bob",
"email": "Bob@contoso.com"
}
},
"createdDateTime": "2021-11-19T17:04:18Z",
"lastModifiedDateTime": "2023-03-09T18:52:26Z"
}
}
],
"total": 1,
"moreResultsAvailable": false
}
]
}
]
}
Contenido relacionado
- Búsqueda mensajes de correo
- eventos de calendario de Búsqueda
- Búsqueda persona
- Búsqueda contenido en SharePoint y OneDrive (archivos, listas y sitios)
- Búsqueda datos de tipos personalizados (conectores de Graph)
- Búsqueda con queryTemplate
- Ordenar los resultados de la búsqueda
- Uso de agregaciones para refinar los resultados de la búsqueda
- Habilitación de correcciones ortográficas en los resultados de la búsqueda