...
# | Description | Source | Status | Notes | |
---|---|---|---|---|---|
1 | LCM Event | NCMP | In Use | LCM (Life Cycle Management) | |
2 | AVC Event | NCMP | In Use | ||
3 | AVC Subscription Event | NCMP | Implemented | ||
4 | DMI Async Request Response Event | NCMP | Implemented | ||
5 | NCMP Async Request Response Event | NCMP | Implemented | ||
6 | Bulk Response Event | NCMP | In Progress | ||
7 | Bulk Response Client Topic Event | NCMP | In Progress |
...
Field | Type | Description | Kafka Header | JSON Field | Notes |
---|---|---|---|---|---|
subscription | object | The subscription details | X | Defined by subscription object below | |
dataType | object | The datatype content | X | Defined by dataType object below | |
predicates | object | Additional values to be added into the subscription | X | Defined by predicates object below |
Subscription Object
Field | Type | Description | Kafka Header | JSON Field | Notes |
---|---|---|---|---|---|
clientID | string | The client ID | X | ||
name | string | The name of the subscription | X | ||
isTagged | boolean | optional parameter, default is false | X | default: false |
DataType Object
Field | Type | Description | Kafka Header | JSON Field | Notes |
---|---|---|---|---|---|
dataspace | string | The dataspace name | X | ||
dataCategory | string | The category type of the data | X | ||
dataProvider | string | The provider name of the data | X | ||
schemaName | string | The name of the schema | X | ||
schemaVersion | string | The version of the schema | X |
Predicates Object
Field | Type | Description | Kafka Header | JSON Field | Notes |
---|---|---|---|---|---|
targets | array | CM Handles to be targeted by the subscription | X | ||
datastore | string | datastore which is to be used by the subscription | X | ||
xpath-filter | string | filter to be applied to the CM Handles through this event | X |
DMI Async Request Response Event
...
Field | Type | Description | Kafka Header | JSON Field | Notes |
---|---|---|---|---|---|
$schema | JSON schema definition | X | |||
$id | schema id | X | |||
$ref | schema | X | |||
definitions | outline schema | ||||
DmiAsyncRequestResponse Event | object | The payload for DmiAsyncRequestResponse event | X | Defined by DmiAsyncRequestResponse event object below |
DmiAsyncRequestResponse Event Object
Field | Type | Description | Kafka Header | JSON Field | Notes |
---|---|---|---|---|---|
eventID | string | The unique id identifying the event generated by DMI | X | ||
eventCorrelationId | string | The request id passed by NCMP | X | ||
eventTime | string | The timestamp when original event occurred | X | ||
eventTarget | string | The target of the event | X | ||
eventType | string | The type of the event | X | ||
eventSchema | string | The event schema for async request response events | X | ||
eventSchemaVersion | string | The event schema version for async request response events | X | ||
eventSource | string | The source of the event | |||
eventContent | object | The payload of an event | X | Defined by eventContent object below |
EventContent Object
Field | Type | Description | Kafka Header | JSON Field | Notes |
---|---|---|---|---|---|
repsonse-data-schema | string | The schema of response data | X | ||
response-status | string | The status of the response | X | ||
response-code | string | The code of the response | X | ||
response-data | object | The data payload | X | contains payload of type object |
NCMP Async Request Response Event
...