Working with aggregates

Search…
Saving events
In this example we will start by saving events for an order. We don’t need to create the order aggregate or define the type explicitly. If an event is the first event for a specific aggregateId, it will automatically create a corresponding aggregate type for that id, in this example the aggregate type is order.
If we provide multiple events in the API call they will be saved atomically.
The following call will create an aggregate of type order with ID 723ecfce-14e9-4889-98d5-a3d0ad54912f using a HTTP POST command:
cURL
1
curl -i https://api.serialized.io/aggregates/order/723ecfce-14e9-4889-98d5-a3d0ad54912f/events \
2
  --header "Content-Type: application/json" \
3
  --header "Serialized-Access-Key: <YOUR_ACCESS_KEY>" \
4
  --header "Serialized-Secret-Access-Key: <YOUR_SECRET_ACCESS_KEY>" \
5
  --data '
6
  {  
7
     "events":[  
8
        {  
9
           "eventId":"127b80b5-4a05-4774-b870-1c9a2e2a27a3",
10
           "eventType":"OrderPlacedEvent",
11
           "data":{  
12
              "customerId":"some-test-id-1",
13
              "orderAmount":12345
14
           }
15
        }
16
     ]
17
  }
18
  '
Copied!
This call should result in the following response:
1
HTTP/1.1 200 OK
2
Content-Length: 0
Copied!
Load aggregate by ID
We can now load our order by its aggregateId.
cURL
1
curl -i \
2
  --header "Serialized-Access-Key: <YOUR_ACCESS_KEY>" \
3
  --header "Serialized-Secret-Access-Key: <YOUR_SECRET_ACCESS_KEY>" \
4
  https://api.serialized.io/aggregates/order/723ecfce-14e9-4889-98d5-a3d0ad54912f
Copied!
This call should result in the following response:
1
HTTP/1.1 200 OK
2
Content-Type: application/json
3
Vary: Accept-Encoding
4
Content-Length: 251
5
​
6
{  
7
  "aggregateId": "723ecfce-14e9-4889-98d5-a3d0ad54912f",
8
  "aggregateType": "order",
9
  "aggregateVersion": 1,
10
  "events": [  
11
    {  
12
       "eventId": "127b80b5-4a05-4774-b870-1c9a2e2a27a3",
13
       "eventType": "OrderPlacedEvent",
14
       "data": {  
15
         "customerId": "some-test-id-1",
16
         "orderAmount": 12345
17
       }
18
    }
19
  ]
20
}
Copied!
The events returned can be used to materialize the current state for the order aggregate. How to create an event sourced aggregate is a topic of another guide.
Appending another event
Let’s pretend this order has been fully paid, so it’s time to add an OrderPaidEvent!
We use a POST command to add events:
cURL
1
curl -i https://api.serialized.io/aggregates/order/723ecfce-14e9-4889-98d5-a3d0ad54912f/events \
2
  --header "Content-Type: application/json" \
3
  --header "Serialized-Access-Key: <YOUR_ACCESS_KEY>" \
4
  --header "Serialized-Secret-Access-Key: <YOUR_SECRET_ACCESS_KEY>" \
5
  --data '
6
  {  
7
     "events":[  
8
        {  
9
           "eventId":"c8b90e06-f3c0-46aa-93a6-c0b281ef3ac5",
10
           "eventType":"OrderPaidEvent"
11
        }
12
     ]
13
  }   
14
  '
Copied!
This expected response is:
1
HTTP/1.1 200 OK
2
Content-Length: 0
Copied!
Basics - Previous
Getting started
Projecting events
Last modified 2yr ago
Copy link
Contents
Saving events
Load aggregate by ID
Appending another event