SharePoint Batch Builder
A utility to simplify building batch requests in SharePoint.
This utility was adapted and extended from https://github.com/SteveCurran/sp-rest-batch-execution/blob/master/RestBatchExecutor.js.
For the Microsoft documentation on batch requests, please see https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/make-batch-requests-with-the-rest-apis.
Batch requests allow you to send multiple create/read/update/delete operations all with one request. While this SharePoint REST API greatly reduces network chatter, building a batch request is not so straight forward.
A batch request is sent in the body of a POST request even though you can send GET, POST, MERGE, and DELETE requests together.
From the batch body example below, it's easy to tell building a batch request is hard:
--batch_8890ae8a-f656-475b-a47b-d46e194fa574Content-Type: multipart/mixed; boundary=changeset_f9c96a07-641a-4897-90ed-d285d2dbfc2eContent-Length: 1762Content-Transfer-Encoding: binary --changeset_f9c96a07-641a-4897-90ed-d285d2dbfc2eContent-Type: application/httpContent-Transfer-Encoding: binaryContent-ID: 1processData: true POST https://<my-sp-site-url>/_api/web/lists(guid'<my-list-guid>')/items HTTP/1.1accept:application/json;odata=verboseContent-Type: application/json;odata=verbose {"Title":"My Title 1","__metadata":{"type":"SP.Data.<SomeType>ListItem"}} --changeset_f9c96a07-641a-4897-90ed-d285d2dbfc2eContent-Type: application/httpContent-Transfer-Encoding: binaryContent-ID: 2processData: true POST https://<my-sp-site-url>/_api/web/lists(guid'<my-list-guid>')/items HTTP/1.1accept:application/json;odata=verboseContent-Type: application/json;odata=verbose {"Title":"My Title 2","__metadata":{"type":"SP.Data.<SomeType>ListItem"}} --changeset_f9c96a07-641a-4897-90ed-d285d2dbfc2eContent-Type: application/httpContent-Transfer-Encoding: binaryContent-ID: 3processData: true DELETE https://<my-sp-site-url>/_api/web/lists(guid'<my-list-guid>')/items(25) HTTP/1.1If-Match: "1"accept:application/json;odata=verbose --changeset_f9c96a07-641a-4897-90ed-d285d2dbfc2eContent-Type: application/httpContent-Transfer-Encoding: binaryContent-ID: 4processData: true DELETE https://<my-sp-site-url>/_api/web/lists(guid'<my-list-guid>')/items(1) HTTP/1.1If-Match: "2"accept:application/json;odata=verbose --changeset_f9c96a07-641a-4897-90ed-d285d2dbfc2e-- --batch_8890ae8a-f656-475b-a47b-d46e194fa574--The Batch Builder utility greatly simplifies building a batch request. For example, sending 2 insert, 2 update, and 2 delete requests:
const siteUrl = 'https://my-sharepoint-site.com/sites/my-site';const listGuid = '<my-list-guid>';const listName = '<PascalCaseListName>';const listItemType = `SP.Data.${listName}ListItem`; // Instantiate batch builder.const batchExec = new SpBatchBuilder(siteUrl); // New list items to insert.const toInsert = [{Title: 'My Title 1'}, {Title: 'My Title 2'}]; // Existing list item values to update.const toUpdate = [{Id: 1, Title: 'My Title 3', etag: '*'}, {Id: 2, Title: 'My Title 4', etag: '*'}]; // Existing list items to delete.const toDelete = [{Id: 1, etag: '*'}, {Id: 2, etag: '*'}]; toInsert.forEach((item) => { batchExec.insert(siteUrl, listGuid, item, listItemType);}); toUpdate.forEach((item) => { batchExec.update(siteUrl, listGuid, item, listItemType, item.etag);}); toDelete.forEach((item) => { batchExec.delete(siteUrl, listGuid, item.Id, item.etag);}); batchExec.executeAsync().done((result) => { console.info(result);}); You may also chain operations. For example:
//...cont'd batchExec .insert(siteUrl, listGuid, {Title: "Don't Panic"}, listItemType) .delete(siteUrl, listGuid, 42, '*') .executeAsync().done((result) => { console.info(result); });