Compartir a través de

Tipo de recurso searchRequest

  • Artículo

Espacio de nombres: microsoft.graph

Solicitud de búsqueda con formato en un blob JSON.

El blob JSON contiene los tipos de recursos esperados en la respuesta, los orígenes subyacentes, los parámetros de paginación, las opciones de ordenación, las agregaciones y campos solicitados y la consulta de búsqueda real. Consulte ejemplos de solicitudes de búsqueda en varios recursos.

Nota:

Tenga en cuenta las limitaciones conocidas para buscar combinaciones específicas de tipos de entidad y ordenar o agregar resultados de búsqueda.

Propiedades

Propiedad Tipo Descripción
aggregationFilters Colección string Contiene uno o varios filtros para obtener resultados de búsqueda agregados y filtrados a un valor específico de un campo. Opcional.
Compile este filtro en función de una búsqueda anterior que se agrega por el mismo campo. A partir de la respuesta de la búsqueda anterior, identifique el searchBucket que filtra los resultados con el valor específico del campo, use la cadena en su propiedad aggregationFilterToken y compile una cadena de filtro de agregación con el formato "{field}:\"{aggregationFilterToken}\".
Si es necesario proporcionar varios valores para el mismo campo, use las cadenas de su propiedad aggregationFilterToken y compile una cadena de filtro de agregación con el formato "{field}:or(\"{aggregationFilterToken1}\",\"{aggregationFilterToken2}\")".
Por ejemplo, la búsqueda y agregación de elementos de unidad por tipo de archivo devuelve un searchBucket para el tipo docx de archivo en la respuesta. Puede usar convenientemente la agregaciónFilterToken devuelta para este searchBucket en una consulta de búsqueda y un filtro posterior que coincida con los elementos del tipo de docx archivo. El ejemplo 1 y el ejemplo 2 muestran las solicitudes y respuestas reales.
agregaciones colección aggregationOption Especifica las agregaciones (también conocidas como refinadores) que se devolverán junto con los resultados de la búsqueda. Opcional.
collapseProperties collapseProperty (colección) Contiene la colección ordenada de campos y el límite para contraer los resultados. Opcional.
contentSources Colección string Contiene la conexión de destino.
enableTopResults Booleano Esto desencadena la ordenación híbrida de los mensajes: los tres primeros mensajes son los más relevantes. Esta propiedad solo es aplicable a entityType=message. Opcional.
entityTypes colección entityType Se esperan uno o varios tipos de recursos en la respuesta. Los valores posibles son: event, message, driveItem, externalItem, site, list, listItem, drive, chatMessage, person, acronym y bookmark. Tenga en cuenta que debe usar el Prefer: include-unknown-enum-members encabezado de solicitud para obtener los siguientes valores en esta enumeración evolvable: chatMessage, person, acronym, bookmark. Consulte las limitaciones conocidas de las combinaciones de dos o más tipos de entidad que se admiten en la misma solicitud de búsqueda. Obligatorio.
fields Colección de cadenas Contiene los campos que se devolverán para cada objeto de recurso especificado en entityTypes, lo que permite la personalización de los campos devueltos de forma predeterminada; de lo contrario, incluidos campos adicionales, como propiedades administradas personalizadas de SharePoint y OneDrive, o campos personalizados en externalItem del contenido que los conectores de Microsoft Graph traen. La propiedad fields puede usar las etiquetas semánticas aplicadas a las propiedades. Por ejemplo, si una propiedad está etiquetada como title, puede recuperarla mediante la sintaxis siguiente: label_title. Opcional.
from Int32 Especifica el desplazamiento de los resultados de la búsqueda. Offset 0 devuelve el primer resultado. Opcional.
consulta searchQuery Contiene los términos de consulta. Obligatorio.
queryAlterationOptions searchAlterationOptions Opciones de modificación de consultas con formato en un blob JSON que contiene dos marcas opcionales relacionadas con la corrección ortográfica. Opcional.
región Cadena Ubicación geográfica de la búsqueda. Necesario para las búsquedas que usan permisos de aplicación. Para obtener más información, consulte Obtención del valor de región.
resultTemplateOptions resultTemplateOption (colección) Proporciona las opciones de plantilla de resultados de búsqueda para representar los resultados de la búsqueda desde conectores.
sharePointOneDriveOptions sharePointOneDriveOptions Indica el tipo de contenido que se va a buscar cuando se realiza una búsqueda mediante permisos de aplicación. Opcional.
size Int32 Tamaño de la página que se va a recuperar. El valor máximo es 500. Opcional.
sortProperties sortProperty (colección) Contiene la colección ordenada de campos y la dirección para ordenar los resultados. Puede haber como máximo 5 propiedades de ordenación en la colección. Opcional.

Representación JSON

La siguiente representación JSON muestra el tipo de recurso.

{
  "aggregationFilters": ["String"],
  "aggregations": [{"@odata.type": "microsoft.graph.aggregationOption"}],
  "collapseProperties": [{"@odata.type": "microsoft.graph.collapseProperty"}],
  "enableTopResults": "Boolean",
  "entityTypes": ["String"],
  "contentSources": ["String"],
  "fields": ["String"],
  "from": "Int32",
  "query": {"@odata.type": "microsoft.graph.searchQuery"},
  "queryAlterationOptions": {"@odata.type": "microsoft.graph.searchAlterationOptions"},
  "region": "String",
  "resultTemplateOptions": [{"@odata.type": "microsoft.graph.resultTemplateOption"}],
  "sharePointOneDriveOptions": {"@odata.type": "microsoft.graph.sharePointOneDriveOptions"},
  "size": "Int32"
}

Contenido relacionado