BulkOperationResponseDto
operationIdstringrequired
Unique identifier for the bulk operation
Example:
507f1f77bcf86cd799439011totalItemsnumberrequired
Total number of items in the operation
Example:
100successCountnumberrequired
Number of successfully processed items
Example:
95failureCountnumberrequired
Number of failed items
Example:
5statusBulkOperationStatusrequired
Current status of the operation
Possible values: [pending, processing, completed, failed]
Example:
pendingoperationErrors object[]
Array of errors for failed items
Array [
itemIdstringrequired
ID of the item that failed
Example:
507f1f77bcf86cd799439011messagestringrequired
Error message
Example:
Client not foundcodestring
Error code if available
Example:
404:MODEL_NOT_FOUND]
results object[]
Array of results for successful items
Array [
itemIdstringrequired
ID of the item
Example:
507f1f77bcf86cd799439011resultobject
Result data
]
createdAtstring<date-time>required
Timestamp when the operation was created
Example:
2024-01-01T00:00:00.000ZcompletedAtstring<date-time>
Timestamp when the operation was completed
Example:
2024-01-01T00:05:00.000ZBulkOperationResponseDto
{
"operationId": "507f1f77bcf86cd799439011",
"totalItems": 100,
"successCount": 95,
"failureCount": 5,
"status": "pending",
"operationErrors": [
{
"itemId": "507f1f77bcf86cd799439011",
"message": "Client not found",
"code": "404:MODEL_NOT_FOUND"
}
],
"results": [
{
"itemId": "507f1f77bcf86cd799439011",
"result": {}
}
],
"createdAt": "2024-01-01T00:00:00.000Z",
"completedAt": "2024-01-01T00:05:00.000Z"
}