blob: 51ec1254af55a5ca31f4804cb57aa1b0604f899d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright (C) 2023 Nordix Foundation
.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
.. _dataOperationEvents:
CPS-NCMP Data Operations Events
###############################
These events are based on the cloud events standard which is a specification for describing event data in common formats to provide interoperability across services, platforms and systems.
Please refer to the `cloud events <https://cloudevents.io/>`_ for more details.
Data operation response events
******************************
:download:`Data operation event schema <schemas/data-operation-event-schema-1.0.0.json>`
Event headers example
^^^^^^^^^^^^^^^^^^^^^
.. code-block:: json
{
"specversion": "1.0",
"id": "77b8f114-4562-4069-8234-6d059ff742ac",
"type": "org.onap.cps.ncmp.events.async1_0_0.DataOperationEvent",
"source": "DMI",
"dataschema": "urn:cps:org.onap.cps.ncmp.events.async1_0_0.DataOperationEvent:1.0.0",
"time": "2020-12-01T00:00:00.000+0000",
"content-type": "application/json",
"data": "{some-key:some-value}",
"correlationid": "6ea5cb30ecfd4a938de36fdc07a5008f",
"destination": "client-topic"
}
Data operation event headers
============================
+----------------+-----------------+------------------------------------------------------------------------+
| Field name | Mandatory | Description |
+================+=================+========================================================================+
| specversion | Yes | default : 1.0 |
+----------------+-----------------+------------------------------------------------------------------------+
| id | Yes | UUID |
+----------------+-----------------+------------------------------------------------------------------------+
| type | Yes | org.onap.cps.ncmp.events.async1_0_0.DataOperationEvent |
+----------------+-----------------+------------------------------------------------------------------------+
| source | Yes | NCMP / DMI |
+----------------+-----------------+------------------------------------------------------------------------+
| dataschema | No | `urn:cps:org.onap.cps.ncmp.events.async1_0_0.DataOperationEvent:1.0.0` |
+----------------+-----------------+------------------------------------------------------------------------+
| time | No | ISO_TIMESTAMP_PATTERN = "yyyy-MM-dd'T'HH:mm:ss.SSSZ" |
+----------------+-----------------+------------------------------------------------------------------------+
| content-type | No | default : application/json |
+----------------+-----------------+------------------------------------------------------------------------+
| data | Yes | actual event/payload now would be under "data" field. |
+----------------+-----------------+------------------------------------------------------------------------+
| correlationid | Yes | request id |
+----------------+-----------------+------------------------------------------------------------------------+
| destination | Yes | client topic |
+----------------+-----------------+------------------------------------------------------------------------+
|
