Field | Type | Description | Mandatory? | Notes |
|---|
data
| Event | The payload of an event | Mandatory | Cloud event standard (data) |
data.responses[0, 1, 2, ...]
| Array | contains an array or batch response that includes both success and failure. | Mandatory |
|
data.responses[0].operationId
| String | specified to distinguish multiple operations using same cmhandleId | Mandatory |
|
data.responses[0].ids
| String | cmhandle-ids | Mandatory | Example : ["0df4d39af6514d99b816758148389cfd"]
Note: Ids array should contain only a single element in the array in case of success messages and In case of error it can have any number of elements.
|
data.responses[0].statusCode
| String |
| Mandatory | Common NCMP defined error codes: - status-code 0-99 is reserved for any success response
- status-code from 100 to 199 is reserved for any failed response.
|
data.responses[0].statusMessage
| String |
| Mandatory | Examples for code & message : | statusCode | statusMessage |
|---|
| 1 | "Successfully applied changes" changes. | 100 | cm handle id(s) is(are) not found. | | 101" | cmHandlecm handle id(s) do not exist" is(are) in non ready state. |
|
data.responses[0].data | Object |
| Optional | - In case of success :
- Optional, for write operations then no need to return configurations
application/yang-patch+json | application/yang-data+json
- In case of failure :
- Optional, any supplementary error data matching the error status-code
|
