Bulk Operations - System Requirements
Bulk Operations - System Requirements
Overview
This document specifies the functional requirements for bulk operations in the Data Authority framework. These operations enable efficient batch processing of entities with atomic transactional guarantees.
Change Type
Impact Assessment
| Area |
Impact Level |
Description |
| API Contract |
Additive |
New /bulk endpoints on all Data Authority resources |
| Database Schema |
None |
Uses existing entity tables |
| Client Applications |
Optional |
Clients may adopt for batch efficiency |
Functional Requirements
REQ-BULK-001: Bulk Add Operation
The system shall provide a REST endpoint to add multiple entities in a single request.
| Attribute |
Value |
| Endpoint Path |
/{resource}/bulk |
| Method |
POST |
| Behavior |
Process all items in the request batch |
| Transactionality |
Atomic - all succeed or all rollback |
| Output |
List of created entity records |
REQ-BULK-002: Bulk Update Operation
The system shall provide a REST endpoint to update multiple entities in a single request.
| Attribute |
Value |
| Endpoint Path |
/{resource}/bulk |
| Method |
PUT |
| Behavior |
Process all updates in the request batch |
| Transactionality |
Atomic - all succeed or all rollback |
| Output |
List of updated entity records |
REQ-BULK-003: Data Transfer Objects
The bulk operations shall use dedicated DTOs:
| DTO |
Structure |
Description |
| Bulk Add Payload |
List<InputPayload> |
Collection of input payloads |
| Bulk Update Payload |
{ updates: List<UpdateEntry> } |
Collection with eId and payload per entry |
Validation Rules
| Rule ID |
Requirement |
Condition |
Error Type |
| VR-BULK-001 |
REQ-BULK-001 |
Empty item list in Add request |
AppError.ArgumentValidation |
| VR-BULK-002 |
REQ-BULK-002 |
Empty update list in Update request |
AppError.ArgumentValidation |
| VR-BULK-003 |
REQ-BULK-002 |
Missing eId in update entry |
AppError.ArgumentValidation |
| VR-BULK-004 |
REQ-BULK-002 |
Invalid eId in update entry |
AppError.ArgumentValidation |
Testing Requirements
API Tests
| Test ID |
Description |
Validates |
| AT-BULK-001 |
Bulk add multiple items |
REQ-BULK-001 |
| AT-BULK-002 |
Bulk update multiple items |
REQ-BULK-002 |
| AT-BULK-003 |
Empty add request returns error |
VR-BULK-001 |
| AT-BULK-004 |
Empty update request returns error |
VR-BULK-002 |
Bruno E2E Tests
Located in api-test/collections/item/bearer-auth/bulk-operations/:
| File |
Description |
01-BulkAdd.bru |
Bulk add operation |
02-QueryBulkItems.bru |
Query to get created item IDs |
03-BulkUpdate.bru |
Bulk update operation |
04-VerifyUpdates.bru |
Verify updates applied |
Copyright: © Arda Systems 2025-2026, All rights reserved