Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

#DescriptionSourceStatusNotes
1LCM EventNCMPIn UseLCM (Life Cycle Management)
2AVC EventNCMPIn Use
3AVC Subscription EventNCMPImplemented
4DMI Async Request Response EventNCMPImplemented
5NCMP Async Request Response EventNCMPImplemented
6Bulk Response EventNCMPIn Progress
7Bulk Response Client Topic EventNCMPIn Progress

...

FieldTypeDescriptionKafka HeaderJSON FieldNotes
subscriptionobjectThe subscription details
XDefined by subscription object below
dataTypeobject

The datatype content


XDefined by dataType object below
predicatesobject

Additional values to be added into the subscription

X
Defined by predicates object below

Subscription Object

FieldTypeDescriptionKafka HeaderJSON FieldNotes
clientIDstring

The client ID


X
namestring

The name of the subscription


X
isTaggedboolean

optional parameter, default is false


Xdefault: false

DataType Object

FieldTypeDescriptionKafka HeaderJSON FieldNotes
dataspacestring

The dataspace name


X
dataCategorystring

The category type of the data


X
dataProviderstring

The provider name of the data


X
schemaNamestring

The name of the schema


X
schemaVersionstring

The version of the schema


X

Predicates Object

FieldTypeDescriptionKafka HeaderJSON FieldNotes
targetsarray

CM Handles to be targeted by the subscription


X
datastorestring

datastore which is to be used by the subscription


X
xpath-filterstring

filter to be applied to the CM Handles through this event


X

DMI Async Request Response Event

...

FieldTypeDescriptionKafka HeaderJSON FieldNotes
$schema
JSON schema definition X

$id
schema idX

$ref
schema X

definitions
outline schema


DmiAsyncRequestResponse Event

object

The payload for 

DmiAsyncRequestResponse

event


XDefined by DmiAsyncRequestResponse event object below

DmiAsyncRequestResponse Event Object

FieldTypeDescriptionKafka HeaderJSON FieldNotes
eventIDstringThe unique id identifying the event generated by DMIX

eventCorrelationIdstring

The request id passed by NCMP


X
eventTimestringThe timestamp when original event occurredX

eventTargetstringThe target of the event
X
eventTypestringThe type of the event
X
eventSchemastring

The event schema for async request response events


X
eventSchemaVersionstring

The event schema version for async request response events


X
eventSourcestringThe source of the event


eventContentobjectThe payload of an event
XDefined by eventContent object below

EventContent Object

FieldTypeDescriptionKafka HeaderJSON FieldNotes
repsonse-data-schemastring

The schema of response data


X
response-statusstring

The status of the response


X
response-codestring

The code of the response


X
response-dataobjectThe data payload
Xcontains payload of type object

NCMP Async Request Response Event

...