Why Bulk import and export in Rest API? - Purpose & Use Cases

The Big Idea

What if you could save hours by sending hundreds of records in just one request?

The Scenario

Imagine you have hundreds or thousands of records to add or retrieve from a system one by one through an API.

You send a request for each item separately, waiting for each to finish before starting the next.

The Problem

This slow process wastes time and bandwidth.

It increases the chance of mistakes, like missing some records or sending duplicates.

It also overloads the server with many small requests, making the system inefficient.

The Solution

Bulk import and export lets you send or receive many records in a single request.

This saves time, reduces errors, and makes the system faster and more reliable.

Before vs After

✗ Before

POST /api/item {"id":1, "name":"A"}
POST /api/item {"id":2, "name":"B"}
POST /api/item {"id":3, "name":"C"}

✓ After

POST /api/items/bulk {"items":[{"id":1,"name":"A"},{"id":2,"name":"B"},{"id":3,"name":"C"}]}

What It Enables

It enables fast, efficient handling of large data sets with fewer requests and less chance of errors.

Real Life Example

A company uploads thousands of customer records at once to update their database instead of typing each one manually or sending many requests.

Key Takeaways

Manual single-item requests are slow and error-prone.

Bulk import/export groups many items in one request.

This improves speed, reliability, and efficiency.

Practice

1. What HTTP method is commonly used to perform a bulk import of records in a REST API?

easy

A. PUT

B. POST

C. DELETE

D. GET

Solution

1. Step 1: Understand bulk import action

   Bulk import means sending many new records to the server at once.

2. Step 2: Identify HTTP method for creating resources

   POST is used to send data to create new records in REST APIs.

3. Final Answer:

   POST -> Option B

4. Quick Check:

   Bulk import uses POST [OK]

Hint: Bulk import sends data with POST method [OK]

Common Mistakes:

• Choosing GET which is for fetching data
• Using DELETE which removes data
• Confusing PUT with bulk import

2. Which of the following is the correct JSON format to bulk import two user records in a REST API POST request?

easy

A. [{"name": "Alice"}, {"name": "Bob"}]

B. {"name": "Alice", "name": "Bob"}

C. {"users": "Alice, Bob"}

D. ["Alice", "Bob"]

Solution

1. Step 1: Recognize bulk import JSON structure

   Bulk import expects a list (array) of objects, each representing a record.

2. Step 2: Check each option format

   [{"name": "Alice"}, {"name": "Bob"}] is a JSON array with two objects, each with a "name" key. Others are invalid or wrong format.

3. Final Answer:

   [{"name": "Alice"}, {"name": "Bob"}] -> Option A

4. Quick Check:

   Bulk import uses JSON array of objects [OK]

Hint: Bulk import JSON is a list of objects [OK]

Common Mistakes:

• Using a single object with duplicate keys
• Sending a string instead of objects
• Using a simple list of strings without keys

3. Given this REST API response after a bulk export request:

{"users": [{"id":1,"name":"Alice"},{"id":2,"name":"Bob"}]}

What is the value of the second user's name?

medium

A. users

B. Alice

C. 2

D. Bob

Solution

1. Step 1: Locate the users array in the JSON

   The key "users" holds a list of user objects.

2. Step 2: Identify the second user object and its name

   The second object is {"id":2,"name":"Bob"}, so the name is "Bob".

3. Final Answer:

   Bob -> Option D

4. Quick Check:

   Second user's name = Bob [OK]

Hint: Look inside 'users' array, second object's 'name' key [OK]

Common Mistakes:

• Confusing index and picking first user
• Selecting the id instead of name
• Choosing the key name instead of value

4. You try to bulk import records with this JSON:

[{"name": "Alice"}, {"name": "Bob"}

But the server returns a 400 Bad Request error. What is the likely problem?

medium

A. Missing closing bracket in JSON array

B. Using POST instead of GET

C. Names should be numbers, not strings

D. Bulk import requires XML format

Solution

1. Step 1: Check JSON syntax

   The JSON is missing the closing bracket "]" for the array.

2. Step 2: Understand server error meaning

   400 Bad Request often means invalid JSON syntax was sent.

3. Final Answer:

   Missing closing bracket in JSON array -> Option A

4. Quick Check:

   Invalid JSON syntax causes 400 error [OK]

Hint: Check JSON brackets carefully for syntax errors [OK]

Common Mistakes:

• Assuming wrong HTTP method caused error
• Thinking data types must be numbers
• Believing XML is required instead of JSON

5. You want to export all products with price above 100 in bulk from a REST API. Which approach correctly combines bulk export with filtering?

hard

A. Send a DELETE request to /products with filter price>100

B. Send a POST request with JSON [{"price": ">100"}] to /products/export

C. Send a GET request to /products?min_price=100 and parse the returned list

D. Send a PUT request to /products/export with price filter in body

Solution

1. Step 1: Identify correct HTTP method for export

   Bulk export uses GET to retrieve data from the server.

2. Step 2: Use query parameters for filtering

   Filtering by price is done via query string like ?min_price=100.

3. Final Answer:

   Send a GET request to /products?min_price=100 and parse the returned list -> Option C

4. Quick Check:

   Bulk export uses GET with filters in query [OK]

Hint: Use GET with query filters for bulk export [OK]

Common Mistakes:

• Using POST for export instead of GET
• Sending filters in request body for GET
• Using DELETE or PUT incorrectly