...
| Action | Intended User | URI | Method | Request Params | Request Body | Response Body | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | subscribe to an object | Synapse users who has READ permission on the object | /subscriptions | POST | Subscription | Subscription | |||||||||
| 2 | retrieve all subscriptions | Synapse users | /subscriptions | GET | limit, offset | SubscriptionPage | |||||||||
| 3 | retrieve a single subscription | Synapse users | /subscriptions/{objectId}/type/{objectType} | GET | Subscription | ||||||||||
| 4 | unsubscribe to an object | Synapse users who subscribed to the object | /subscriptions/unsubscribe/{objectId}/type/{objectType} | DELETE | |||||||||||
| 5 | change notification method | Synapse users who subscribed to the object | /subscriptions | PUT | Subscription | Subscription | |||||||||
| 6 | get all notifications | Synapse users | /notifications | GET | filter(NO_FILTER, UNREAD_ONLY), eventType, limit, offset | NotificationPage | |||||||||
| 7 | get all notifications for a single object | Synapse users | /notifications/{objectId}/type/{objectType} | GET | limit, offset | NotificationPage | 8 | mark a notification as read | Synapse users | /notifications/{notificationId}/read | PUT | Notification | |||
| 98 | get event | Synapse users | /events/{eventId}/type/{eventType} | GET | Event |
...