Realizar solicitudes de lote con las API de REST

  • Artículo

En este artículo, se describe cómo puede procesar en lote consultas y operaciones en la API de REST/OData de Microsoft SharePoint Online (y SharePoint 2016 local y versiones posteriores) y el Subconjunto de archivos y carpetas de las API de REST de Office 365. Con esta técnica, puede mejorar el rendimiento del complemento al combinar muchas operaciones en una sola solicitud al servidor y una sola respuesta.

Resumen ejecutivo de la opción $batch

SharePoint Online (y SharePoint 2016 local y versiones posteriores) y las API de Office 365 implementan la opción de consulta OData$batch, por lo que puede confiar en la documentación oficial para obtener más información sobre cómo usarla. (Otra opción es ver las publicaciones del blog de Andrew Connell sobre el tema comenzando desde la Parte 1 sobre el procesamiento por lotes de la API de REST de SharePoint).

A continuación, se presenta un recordatorio de los puntos más importantes:

  • La dirección URL de solicitud consta de la dirección URL de servicio de raíz y la opción $batch. Por ejemplo: https://fabrikam.sharepoint.com/_api/$batch o https://fabrikam.office365.com/api/v1.0/me/$batch.
  • El cuerpo de la solicitud HTTP es de tipo MIME de varias partes/mixta.
  • El cuerpo de la solicitud está dividido en partes separadas unas de otras por una cadena de límite que se especifica en el encabezado de la solicitud.
  • Cada parte del cuerpo tiene su propio verbo HTTP y su propia dirección URL REST (cuando corresponde, también tiene su propio cuerpo interno).
  • Una parte puede ser una operación de lectura (o invocación a función), o un ChangeSet de una o más operaciones de escritura (o invocaciones a funciones). Un ChangeSet es en sí mismo un tipo MIME de varias partes/mixta con subpartes que contienen operaciones para insertar, actualizar o eliminar.

Importante

Las API de Office 365 y SharePoint no son transaccionales y no admiten la característica "todo o nada" para ChangeSets que tengan más de una operación dentro. Si se produce un error en alguna de las operaciones secundarias, las otras aún se completan y no se revierten.

Ejemplos de código

Ejemplos de código que usan la opción de consulta $batch en las API de REST/OData de SharePoint:

Solicitudes de ejemplo y respuestas

A continuación, se presenta un ejemplo de una solicitud HTTP sin procesar que procesa en lote dos operaciones GET que recuperan los títulos de todos los elementos de dos listas diferentes.

POST https://fabrikam.sharepoint.com/_api/$batch HTTP/1.1
Authorization: Bearer <access token omitted>
Content-Type: multipart/mixed; boundary=batch_e3b6819b-13c3-43bb-85b2-24b14122fed1
Host: fabrikam.sharepoint.com
Content-Length: 527
Expect: 100-continue

--batch_e3b6819b-13c3-43bb-85b2-24b14122fed1
Content-Type: application/http
Content-Transfer-Encoding: binary

GET https://fabrikam.sharepoint.com/_api/Web/lists/getbytitle('Composed%20Looks')/items?$select=Title HTTP/1.1

--batch_e3b6819b-13c3-43bb-85b2-24b14122fed1
Content-Type: application/http
Content-Transfer-Encoding: binary

GET https://fabrikam.sharepoint.com/_api/Web/lists/getbytitle('User%20Information%20List')/items?$select=Title HTTP/1.1

--batch_e3b6819b-13c3-43bb-85b2-24b14122fed1--

A continuación, se presenta un ejemplo del cuerpo de una solicitud HTTP sin procesar que procesa en lote una DELETE de una lista y una GET de la lista de listas de SharePoint.

POST https://fabrikam.sharepoint.com/_api/$batch HTTP/1.1
Authorization: Bearer <access token omitted>
Content-Type: multipart/mixed; boundary=batch_7ba8d60b-efce-4a2f-b719-60c27cc0e70e
Host: fabrikam.sharepoint.com
Content-Length: 647
Expect: 100-continue

--batch_7ba8d60b-efce-4a2f-b719-60c27cc0e70e
Content-Type: multipart/mixed; boundary=changeset_efb6b37c-a5cd-45cb-8f5f-4d648006e65d

--changeset_efb6b37c-a5cd-45cb-8f5f-4d648006e65d
Content-Type: application/http
Content-Transfer-Encoding: binary

DELETE https://fabrikam.sharepoint.com/_api/Web/lists/getbytitle('OldList') HTTP/1.1
If-Match: "1"

--changeset_efb6b37c-a5cd-45cb-8f5f-4d648006e65d--
--batch_7ba8d60b-efce-4a2f-b719-60c27cc0e70e
Content-Type: application/http
Content-Transfer-Encoding: binary

GET https://fabrikam.sharepoint.com/_api/Web/lists HTTP/1.1

--batch_7ba8d60b-efce-4a2f-b719-60c27cc0e70e--

Precaución

Las solicitudes por lotes pueden reducir el número de solicitudes de ida y vuelta a la API rest de SharePoint. Sin embargo, no se admite la carga de varios archivos en un solo lote.

Bibliotecas de OData

Las bibliotecas de OData admiten el procesamiento por lotes de OData para muchos lenguajes. A continuación puede ver dos ejemplos. Para ver una lista más completa, vea Bibliotecas de OData.

Consulte también