Subscription Event Object Field | Type | Description | Kafka Header | Event Payload Field | Notes |
---|
version | string | The event type version |
|
| ekiemcc : What is this version? This should be covered in the header now? | eventType | object | The event type |
|
| ekiemcc : This is now covered by the header? Is this needed any longer in the body? Enum: ["CREATE"] | event | object | The payload for an event |
|
| Defined by event object below |
Event ObjectField | Type | Description | Kafka Header | Event Payload Field | Notes |
---|
subscription | object | The subscription details |
|
| Defined by subscription object below | dataType | object | The datatype content |
|
| Defined by dataType object below | predicates | object | Additional values to be added into the subscription |
|
| Defined by predicates object below |
Subscription ObjectField | Type | Description | Kafka Header | Event Payload Field | Notes |
---|
clientID | string | The client ID |
|
|
| name | string | The name of the subscription |
|
|
| isTagged | boolean | optional parameter, default is false |
|
| default: false |
DataType ObjectField | Type | Description | Kafka Header | Event Payload Field | Notes |
---|
dataspace | string | The dataspace name |
|
|
| dataCategory | string | The category type of the data |
|
|
| dataProvider | string | The provider name of the data |
|
|
| schemaName | string | The name of the schema |
|
|
| schemaVersion | string | The version of the schema |
|
|
|
Predicates ObjectField | Type | Description | Kafka Header | Event Payload Field | Notes |
---|
targets | array | CM Handles to be targeted by the subscription |
|
|
| datastore | string | datastore which is to be used by the subscription |
|
|
| xpath-filter | string | filter to be applied to the CM Handles through this event |
|
|
|
|