Composite operations (multi-resource) in Rest API

Introduction

Composite operations let you do many related tasks in one go. This saves time and keeps things simple.

When you want to create a user and their profile together.

When updating multiple related records at once, like order and payment.

When deleting a group of connected resources safely.

When you want to reduce the number of calls to the server.

When you want to keep data consistent across several resources.

Syntax

Rest API

POST /composite-operation
{
  "operations": [
    {"method": "POST", "path": "/users", "body": {"name": "Alice"}},
    {"method": "POST", "path": "/profiles", "body": {"userId": "${results[0].body.id}", "bio": "Hello!"}}
  ]
}

The request is usually a POST to a special endpoint like /composite-operation.

Each operation inside has a method, path, and optional body.

Examples

Create a task and then a reminder linked to that task.

Rest API

POST /composite-operation
{
  "operations": [
    {"method": "POST", "path": "/tasks", "body": {"title": "Buy milk"}},
    {"method": "POST", "path": "/reminders", "body": {"taskId": "${results[0].body.id}", "time": "9am"}}
  ]
}

Delete an order and its payment in one request.

Rest API

POST /composite-operation
{
  "operations": [
    {"method": "DELETE", "path": "/orders/123"},
    {"method": "DELETE", "path": "/payments/456"}
  ]
}

Sample Program

This example shows creating a user and their profile together. The profile uses the user ID from the first operation.

Rest API

POST /composite-operation
{
  "operations": [
    {"method": "POST", "path": "/users", "body": {"name": "Bob"}},
    {"method": "POST", "path": "/profiles", "body": {"userId": "${results[0].body.id}", "bio": "I love coding."}}
  ]
}

Response:
{
  "results": [
    {"status": 201, "body": {"id": "u123", "name": "Bob"}},
    {"status": 201, "body": {"id": "p456", "userId": "u123", "bio": "I love coding."}}
  ]
}

Important Notes

Composite operations help keep related changes together, so you don't have to worry about partial updates.

Make sure the API supports referencing results from earlier operations, like using ${results[0].body.id}.

Check the response carefully to handle errors in any part of the composite request.

Summary

Composite operations combine multiple API calls into one request.

This saves time and keeps data changes consistent.

Use them when working with related resources that depend on each other.

Practice

1. What is the main benefit of using composite operations in REST APIs?

easy

A. They combine multiple API calls into a single request to save time and keep data consistent.

B. They allow you to write SQL queries inside REST endpoints.

C. They automatically generate API documentation.

D. They encrypt all API responses for security.

Solution

1. Step 1: Understand what composite operations do

   Composite operations bundle several API calls into one request to reduce network overhead.

2. Step 2: Identify the main benefit

   This bundling saves time and ensures related data changes happen together, keeping consistency.

3. Final Answer:

   They combine multiple API calls into a single request to save time and keep data consistent. -> Option A

4. Quick Check:

   Composite operations = combine calls + consistency [OK]

Hint: Composite means combining multiple calls into one [OK]

Common Mistakes:

• Confusing composite operations with documentation tools
• Thinking composite operations encrypt data
• Assuming composite operations run SQL queries

2. Which of the following is the correct way to structure a composite operation request in JSON?

easy

A. [{"method": "DELETE", "path": "/items/1"}]

B. {"operation": "GET", "url": "/users"}

C. {"requests": {"method": "POST", "endpoint": "/orders"}}

D. {"operations": [{"method": "POST", "path": "/users"}, {"method": "PUT", "path": "/accounts/123"}]}

Solution

1. Step 1: Identify the correct JSON structure for composite operations

   Composite operations usually use an "operations" array with each operation having "method" and "path" keys.

2. Step 2: Compare options

   {"operations": [{"method": "POST", "path": "/users"}, {"method": "PUT", "path": "/accounts/123"}]} matches this structure exactly, while others use incorrect keys or formats.

3. Final Answer:

   {"operations": [{"method": "POST", "path": "/users"}, {"method": "PUT", "path": "/accounts/123"}]} -> Option D

4. Quick Check:

   Composite request = "operations" array with method and path [OK]

Hint: Look for "operations" array with method and path keys [OK]

Common Mistakes:

• Using singular "operation" instead of plural "operations"
• Using wrong keys like "url" or "endpoint"
• Not wrapping operations inside an array

3. Given this composite operation request:

{
  "operations": [
    {"method": "POST", "path": "/users", "body": {"name": "Alice"}},
    {"method": "POST", "path": "/orders", "body": {"userId": "${1.id}", "item": "Book"}}
  ]
}

What is the expected behavior?

medium

A. Create a user named Alice, then create an order linked to that user using the new user ID.

B. Create an order first, then create a user named Alice.

C. Create a user named Alice only; the order creation will fail due to syntax error.

D. The request will fail because referencing previous operation results is not allowed.

Solution

1. Step 1: Understand operation order and referencing

   The first operation creates a user named Alice. The second operation uses "${1.id}" to reference the ID from the first operation's result.

2. Step 2: Determine expected behavior

   This means the order is created linked to the new user. This chaining is a key feature of composite operations.

3. Final Answer:

   Create a user named Alice, then create an order linked to that user using the new user ID. -> Option A

4. Quick Check:

   Reference previous result with ${1.id} = chained operations [OK]

Hint: Look for ${1.id} to see chaining between operations [OK]

Common Mistakes:

• Assuming operations run in parallel without order
• Thinking referencing previous results is invalid
• Confusing operation indexes starting at 0 instead of 1

4. You have this composite operation request:

{
  "operations": [
    {"method": "POST", "path": "/products", "body": {"name": "Pen"}},
    {"method": "PUT", "path": "/inventory/${1.id}", "body": {"stock": 100}}
  ]
}

But the API returns an error saying "Invalid reference ${1.id}". What is the likely cause?

medium

A. The syntax for referencing previous results should be ${0.id}, not ${1.id}.

B. The first operation did not return an ID, so ${1.id} is invalid.

C. PUT method cannot be used in composite operations.

D. The inventory path should not include dynamic IDs.

Solution

1. Step 1: Check the reference usage

   The error "Invalid reference ${1.id}" means the first operation's response does not contain an "id" field.

2. Step 2: Understand why this causes error

   If the first operation's response lacks "id", the reference ${1.id} is invalid and causes failure.

3. Final Answer:

   The first operation did not return an ID, so ${1.id} is invalid. -> Option B

4. Quick Check:

   Reference error = missing id in first operation response [OK]

Hint: Check if referenced operation returns the expected field [OK]

Common Mistakes:

• Assuming index starts at 0 instead of 1
• Thinking PUT is disallowed in composite operations
• Ignoring that referenced fields must exist in response

5. You want to create a composite operation that creates a customer, then creates two orders for that customer, and finally updates the customer's status to "active". Which JSON structure correctly represents this multi-resource composite operation?

hard

A. {
"operations": [
{"method": "POST", "path": "/customers", "body": {"name": "Bob"}},
{"method": "POST", "path": "/orders", "body": {"customerId": "1", "item": "Laptop"}},
{"method": "POST", "path": "/orders", "body": {"customerId": "1", "item": "Mouse"}},
{"method": "PUT", "path": "/customers/1", "body": {"status": "active"}}
]
}

B. {
"operations": [
{"method": "POST", "path": "/orders", "body": {"item": "Laptop"}},
{"method": "POST", "path": "/customers", "body": {"name": "Bob"}},
{"method": "PUT", "path": "/customers/1", "body": {"status": "active"}}
]
}

C. {
"operations": [
{"method": "POST", "path": "/customers", "body": {"name": "Bob"}},
{"method": "POST", "path": "/orders", "body": {"customerId": "${1.id}", "item": "Laptop"}},
{"method": "POST", "path": "/orders", "body": {"customerId": "${1.id}", "item": "Mouse"}},
{"method": "PUT", "path": "/customers/${1.id}", "body": {"status": "active"}}
]
}

D. {
"operations": [
{"method": "POST", "path": "/customers", "body": {"name": "Bob"}},
{"method": "POST", "path": "/orders", "body": {"customerId": "${2.id}", "item": "Laptop"}},
{"method": "POST", "path": "/orders", "body": {"customerId": "${2.id}", "item": "Mouse"}},
{"method": "PUT", "path": "/customers/${2.id}", "body": {"status": "active"}}
]
}

Solution

1. Step 1: Identify correct operation order and referencing

   The customer creation is first (operation 1), so its ID is referenced as ${1.id} in subsequent operations.

2. Step 2: Verify all references use ${1.id} and order is logical

   Orders and update use ${1.id} correctly. { "operations": [ {"method": "POST", "path": "/customers", "body": {"name": "Bob"}}, {"method": "POST", "path": "/orders", "body": {"customerId": "${1.id}", "item": "Laptop"}}, {"method": "POST", "path": "/orders", "body": {"customerId": "${1.id}", "item": "Mouse"}}, {"method": "PUT", "path": "/customers/${1.id}", "body": {"status": "active"}} ] } matches this perfectly. { "operations": [ {"method": "POST", "path": "/customers", "body": {"name": "Bob"}}, {"method": "POST", "path": "/orders", "body": {"customerId": "${2.id}", "item": "Laptop"}}, {"method": "POST", "path": "/orders", "body": {"customerId": "${2.id}", "item": "Mouse"}}, {"method": "PUT", "path": "/customers/${2.id}", "body": {"status": "active"}} ] } incorrectly uses ${2.id} which refers to the first order, not the customer.

3. Final Answer:

   { "operations": [ {"method": "POST", "path": "/customers", "body": {"name": "Bob"}}, {"method": "POST", "path": "/orders", "body": {"customerId": "${1.id}", "item": "Laptop"}}, {"method": "POST", "path": "/orders", "body": {"customerId": "${1.id}", "item": "Mouse"}}, {"method": "PUT", "path": "/customers/${1.id}", "body": {"status": "active"}} ] } -> Option C

4. Quick Check:

   Use ${1.id} to reference first operation's customer ID [OK]

Hint: Reference first created resource as ${1.id} in later operations [OK]

Common Mistakes:

• Referencing wrong operation index for customer ID
• Hardcoding IDs instead of referencing dynamically
• Incorrect operation order breaking dependencies