Bulk import and export in Rest API - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is bulk import in REST APIs?

Bulk import is a process where multiple data records are sent together in one request to the server, allowing faster and efficient data upload.

beginner

What is bulk export in REST APIs?

Bulk export is when the server sends multiple data records in one response, letting clients download large amounts of data at once.

beginner

Why use bulk import and export instead of single record requests?

Using bulk operations reduces the number of requests, saves time, lowers network overhead, and improves performance.

beginner

Name a common data format used for bulk import and export in REST APIs.

JSON (JavaScript Object Notation) is commonly used because it is easy to read and write for both humans and machines.

beginner

What HTTP method is usually used for bulk import?

POST is typically used for bulk import because it sends data to the server to create or update multiple records.

Which HTTP method is most commonly used for bulk export in REST APIs?

A GET

B POST

C PUT

D DELETE

GET requests retrieve data from the server, making them suitable for bulk export.

What is a key benefit of bulk import?

A Reduces the number of network requests

B Increases server load unnecessarily

C Requires multiple API calls

D Slows down data processing

Bulk import reduces network requests by sending many records in one call.

Which data format is NOT commonly used for bulk import/export?

A JSON

B XML

C CSV

D HTML

HTML is for web pages, not data exchange in bulk import/export.

When performing bulk export, what should the server include in the response?

A Error message always

B Only one record at a time

C Multiple data records in a structured format

D Empty response

Bulk export returns many records together in a structured format like JSON.

Which of these is a common challenge with bulk import?

A Sending only one record

B Handling partial failures in the batch

C No network usage

D No data validation

Partial failures happen when some records fail but others succeed, requiring careful handling.

Explain how bulk import works in REST APIs and why it is useful.

Think about uploading many items at once instead of one by one.

Describe the typical data formats and HTTP methods used for bulk export.

How do you ask the server to send you many records at once?

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