Batch update patterns in Rest API

Introduction

Batch update patterns let you change many items at once with one request. This saves time and makes your app faster.

You want to update multiple user profiles in one go.

You need to change the status of many orders at once.

You want to apply the same change to many records quickly.

You want to reduce the number of requests to the server.

You want to keep your app responsive when updating many items.

Syntax

Rest API

PATCH /items
Content-Type: application/json

{
  "updates": [
    {"id": 1, "field": "value1"},
    {"id": 2, "field": "value2"}
  ]
}

Use HTTP PATCH method for partial updates.

Send an array of update objects inside the request body.

Examples

Update emails of two users in one request.

Rest API

PATCH /users
Content-Type: application/json

{
  "updates": [
    {"id": 101, "email": "[e-mail]"},
    {"id": 102, "email": "[e-mail]"}
  ]
}

Change status of multiple orders to 'shipped'.

Rest API

PATCH /orders
Content-Type: application/json

{
  "updates": [
    {"id": 201, "status": "shipped"},
    {"id": 202, "status": "shipped"}
  ]
}

Sample Program

This Python code sends a batch update request to change names of two items. It prints if the update worked or failed.

Rest API

import requests

url = 'https://api.example.com/items'

batch_update = {
    "updates": [
        {"id": 1, "name": "Item One Updated"},
        {"id": 2, "name": "Item Two Updated"}
    ]
}

response = requests.patch(url, json=batch_update)

if response.status_code == 200:
    print('Batch update successful')
else:
    print('Batch update failed')

Important Notes

Make sure your API supports batch updates before using this pattern.

Validate each item in the batch to avoid partial failures.

Use proper HTTP status codes to indicate success or errors.

Summary

Batch update patterns let you update many items with one request.

This saves time and reduces server load.

Use PATCH method and send an array of updates in JSON format.

Practice

1. What is the main advantage of using batch update patterns in REST APIs?

easy

A. They only work with GET requests.

B. They allow updating multiple items with a single request, saving time.

C. They require sending separate requests for each item.

D. They increase the number of requests to the server.

Solution

1. Step 1: Understand batch update purpose

   Batch update patterns let you update many items at once instead of one by one.

2. Step 2: Identify the benefit

   This reduces the number of requests and saves time and server resources.

3. Final Answer:

   They allow updating multiple items with a single request, saving time. -> Option B

4. Quick Check:

   Batch update = single request for many items [OK]

Hint: Batch updates reduce requests by combining many updates [OK]

Common Mistakes:

• Thinking batch updates increase requests
• Confusing batch update with single item update
• Assuming batch updates use GET method

2. Which HTTP method is most appropriate for batch updates in REST APIs?

easy

A. GET

B. POST

C. PATCH

D. DELETE

Solution

1. Step 1: Recall HTTP methods for updates

   PATCH is used to partially update resources, suitable for batch updates.

2. Step 2: Eliminate other methods

   GET retrieves data, POST creates new data, DELETE removes data, so they are not best for batch updates.

3. Final Answer:

   PATCH -> Option C

4. Quick Check:

   Batch update uses PATCH method [OK]

Hint: Use PATCH for partial or batch updates [OK]

Common Mistakes:

• Using GET for updates
• Confusing POST with update method
• Using DELETE instead of PATCH

3. Given this JSON payload sent in a PATCH request for batch update:

[{"id":1,"status":"done"},{"id":2,"status":"pending"}]

What does this payload represent?

medium

A. Retrieve items with id 1 and 2.

B. Create two new items with given ids and statuses.

C. Delete items with id 1 and 2.

D. Update status of items with id 1 and 2 to 'done' and 'pending' respectively.

Solution

1. Step 1: Analyze JSON payload

   The payload is an array of objects each with 'id' and 'status' fields, indicating updates.

2. Step 2: Understand PATCH semantics

   PATCH updates existing items partially, so this changes status fields for items with id 1 and 2.

3. Final Answer:

   Update status of items with id 1 and 2 to 'done' and 'pending' respectively. -> Option D

4. Quick Check:

   PATCH with array updates multiple items [OK]

Hint: PATCH with array updates multiple items by id [OK]

Common Mistakes:

• Thinking PATCH creates new items
• Confusing update with delete
• Assuming it retrieves data

4. You send this PATCH request payload to update multiple items:

[{"id":1,"status":"done"}, {"status":"pending"}]

What is the likely problem?

medium

A. Missing 'id' in second object causes update failure or error.

B. The payload is valid and will update all items.

C. Using PATCH instead of POST causes syntax error.

D. The array should be empty for batch updates.

Solution

1. Step 1: Check each object in payload

   The second object lacks 'id', so the server cannot identify which item to update.

2. Step 2: Understand update requirements

   Each update must specify the item to update, usually by 'id'. Missing it causes failure or error.

3. Final Answer:

   Missing 'id' in second object causes update failure or error. -> Option A

4. Quick Check:

   Each update needs an identifier like 'id' [OK]

Hint: Every update object must include an identifier like 'id' [OK]

Common Mistakes:

• Assuming missing 'id' is allowed
• Confusing PATCH with POST errors
• Thinking empty arrays are required

5. You want to batch update user roles but only for users currently active. Which pattern best fits this requirement?

hard

A. Send a PATCH request with an array of user objects filtered to active users only.

B. Send separate PATCH requests for all users regardless of status.

C. Use GET request to update roles for active users.

D. Send a DELETE request with active users to update roles.

Solution

1. Step 1: Identify filtering need

   Only active users should be updated, so filter users before sending batch update.

2. Step 2: Choose correct method and payload

   PATCH with an array of filtered user objects updates roles efficiently in one request.

3. Final Answer:

   Send a PATCH request with an array of user objects filtered to active users only. -> Option A

4. Quick Check:

   Filter then batch update with PATCH [OK]

Hint: Filter data first, then batch update with PATCH [OK]

Common Mistakes:

• Sending updates for all users without filtering
• Using GET or DELETE for updates
• Sending multiple separate requests instead of batch