...
PUT, PATCH and Change Versions
All mutable resources contain a changeVersion that is used as a semaphore to control concurrent access. For example, if an API consumer wants to PUT or PATCH a resource they must use the following sequence:
- GET the resource to be PUT or PATCHed
- Assemble the request body for the PUT or PATCH including the
changeVersionreturned in the GET response body above - Make the PUT or PATCH request
If the changeVersion has been changed by another consumer since the GET request (#1 above), a 409 will be returned and the consumer will need to repeat the sequence again.
Notifications
Webhooks
Notification Event Types
The following is list of event types that a subscriber can be notified of on a per zone (topic) basis. Each time an event is triggered it publishes a new notification of a given event type .
| Event | Event Type | Default Scope | Additional Payload |
|---|---|---|---|
| A zone is created | ZONE_POST | ALL | none |
| A zone is updated (including moved) | ZONE_PUT | ALL | none |
| A zone is deleted | ZONE_DELETE | ALL | none |
| A zone's thumbnail image is updated (TBD) | ZONE_THUMBNAIL_PUT | ALL | TBD |
A data domain is created or a new version of of the data domain has been created | DOMAIN_POST | ALL | TBD |
A data domain has been created | DOMAIN_PUT | ALL | TBD |
| A data domain has been deleted | DOMAIN_DELETE | ALL | TBD |
| An MDR has been created for a given data domain (TBD) | DOMAIN_NAME_DATA_POST | ALL | TBD |
| An MDR has been updated in a given data domain (TBD) | DOMAIN_NAME_DATA_PUT | ALL | TBD |
| An MDR has been deleted in a give data domain (TBD) | DOMAIN_NAME_DATA_DELETE | ALL | TBD |
Notification Event Response Body
The notification's JMS header includes the following:
| key | value |
|---|---|
| description | A full description of the event - i.e. a full concatenation of the information described below for easy displaying. |
| changeVersion | The resources change version. |
| createdDate | The date the resource was created. |
| Name | The resource name |
| message-id | The JMS message ID. |
| dateCreated | Unix timestamp of when the event notification was sent |
uuid | Zone uuid of target resource |
| eventType | One of the above described "Notification Event Types" |
| originatorName | The name of the zone that generated the event. |
| originatorUuid | The UUID of the zone that generated the event. |
| timestamp | The time the notification was created. |
| actions | Some PUT & PATCH commands provide multiple actions and this list contains a description of what actions were performed. |
| optional | Other key/values that are appropriate for the notification type |
Requesting Notification Log
A client can make a request to get the log history for all notifications sent to their zone. The user provides their zone and a from and to date.
